docs: explain SSH key behavior (#3990)

This commit is contained in:
Ben Potter
2022-09-13 12:36:39 -04:00
committed by GitHub
parent d57c181aad
commit f16dd5acb4
2 changed files with 13 additions and 0 deletions

BIN
docs/images/ssh-keys.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 284 KiB

View File

@ -24,6 +24,19 @@ Often, this workflow is simply:
We show parameters in cleartext around the product. Assume anyone with view
access to a workspace can also see its parameters.
## SSH Keys
Coder generates SSH key pairs for each user. This can be used as an authentication mechanism for
git providers or other tools. Within workspaces, git will attempt to use this key within workspaces
via the `$GIT_SSH_COMMAND` environment variable.
Users can view their public key in their account settings:
![SSH keys in account settings](./images/ssh-keys.png)
> There is a [known issue](https://github.com/coder/coder/issues/3126) that prevents users from
> using their own SSH keys within Coder workspaces.
## Dynamic Secrets
Dynamic secrets are attached to the workspace lifecycle and automatically