From 5237c7ed501a297f2a6541332dcb9bfb97af5f58 Mon Sep 17 00:00:00 2001 From: decentral1se Date: Thu, 3 Feb 2022 13:42:49 +0100 Subject: [PATCH] docs: focus more on straight ssh docs for server add --- cli/server/add.go | 40 +++++++++++++++------------------------- 1 file changed, 15 insertions(+), 25 deletions(-) diff --git a/cli/server/add.go b/cli/server/add.go index 402e52ad..6dea74ce 100644 --- a/cli/server/add.go +++ b/cli/server/add.go @@ -372,39 +372,27 @@ var serverAddCommand = cli.Command{ Usage: "Add a server to your configuration", Description: ` This command adds a new server to your configuration so that it can be managed -by Abra. This can be useful when you already have a server provisioned and want -to start running Abra commands against it. +by Abra. This command can also provision your server ("--provision/-p") with a +Docker installation so that it is capable of hosting Co-op Cloud apps. -This command can also provision your server ("--provision/-p") so that it is -capable of hosting Co-op Cloud apps. Abra will default to expecting that you -have a running ssh-agent and are using SSH keys to connect to your new server. -Abra will also read your SSH config (matching "Host" as ). SSH -connection details precedence follows as such: command-line > SSH config > -guessed defaults. +Abra will default to expecting that you have a running ssh-agent and are using +SSH keys to connect to your new server. Abra will also read your SSH config +(matching "Host" as ). SSH connection details precedence follows as +such: command-line > SSH config > guessed defaults. If you have no SSH key configured for this host and are instead using password authentication, you may pass "--ssh-auth password" to have Abra ask you for the password. "--ask-sudo-pass" may be passed if you run your provisioning commands via sudo privilege escalation. -If "--local" is passed, then Abra assumes that the current local server is -intended as the target server. This is useful when you want to have your entire -Co-op Cloud config located on the server itself, and not on your local -developer machine. +The argument must be a publicy accessible domain name which points to +your server. You should working SSH access to this server already, Abra will +assume port 22 and will use your current system username to make an initial +connection. You can use the and arguments to adjust this. Example: - abra server add --local - -Otherwise, you may specify a remote server. The argument must be a -publicy accessible domain name which points to your server. You should have SSH -access to this server, Abra will assume port 22 and will use your current -system username to make an initial connection. You can use the and - arguments to adjust this. - -Example: - - abra server add --provision varia.zone glodemodem 12345 + abra server add varia.zone glodemodem 12345 -p Abra will construct the following SSH connection and Docker context: @@ -412,9 +400,11 @@ Abra will construct the following SSH connection and Docker context: All communication between Abra and the server will use this SSH connection. -In this example, Abra will install Docker and initialise swarm mode. +If "--local" is passed, then Abra assumes that the current local server is +intended as the target server. This is useful when you want to have your entire +Co-op Cloud config located on the server itself, and not on your local +developer machine. -You may omit flags to avoid performing this provisioning logic. `, Flags: []cli.Flag{ internal.DebugFlag,