Skip to content

Commit

Permalink
Update baremetal.md. Related to ssh connection (#9040)
Browse files Browse the repository at this point in the history
Add more description over putting public key on deploy server
  • Loading branch information
MNR85 committed Aug 29, 2023
1 parent 44b4a90 commit 0d29754
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/docs/deploy/baremetal.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ This lists a single server, in the `production` environment, providing the hostn
* `branch` - [optional] The branch to deploy (defaults to `main`)
* `keepReleases` - [optional] The number of previous releases to keep on the server, including the one currently being served (defaults to 5)

The easiest connection method is generally to include your own public key in the server's `~/.ssh/authorized_keys` file, [enable agent forwarding](https://docs.github.com/en/developers/overview/using-ssh-agent-forwarding), and then set `agentForward = true` in `deploy.toml`. This will allow you to use your own credentials when pulling code from GitHub (required for private repos). Otherwise you can create a [deploy key](https://docs.github.com/en/developers/overview/managing-deploy-keys) and keep it on the server.
The easiest connection method is generally to include your own public key in the server's `~/.ssh/authorized_keys` mannually or by running `ssh-copy-id user@server.com` from your local machine, [enable agent forwarding](https://docs.github.com/en/developers/overview/using-ssh-agent-forwarding), and then set `agentForward = true` in `deploy.toml`. This will allow you to use your own credentials when pulling code from GitHub (required for private repos). Otherwise you can create a [deploy key](https://docs.github.com/en/developers/overview/managing-deploy-keys) and keep it on the server.

#### Using Environment Variables in `deploy.toml`

Expand Down

0 comments on commit 0d29754

Please sign in to comment.