Skip to content

Commit f16dd5a

Browse files
authored
docs: explain SSH key behavior (#3990)
1 parent d57c181 commit f16dd5a

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

docs/images/ssh-keys.png

284 KB
Loading

docs/secrets.md

+13
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,19 @@ Often, this workflow is simply:
2424
We show parameters in cleartext around the product. Assume anyone with view
2525
access to a workspace can also see its parameters.
2626

27+
## SSH Keys
28+
29+
Coder generates SSH key pairs for each user. This can be used as an authentication mechanism for
30+
git providers or other tools. Within workspaces, git will attempt to use this key within workspaces
31+
via the `$GIT_SSH_COMMAND` environment variable.
32+
33+
Users can view their public key in their account settings:
34+
35+
![SSH keys in account settings](./images/ssh-keys.png)
36+
37+
> There is a [known issue](https://github.com/coder/coder/issues/3126) that prevents users from
38+
> using their own SSH keys within Coder workspaces.
39+
2740
## Dynamic Secrets
2841

2942
Dynamic secrets are attached to the workspace lifecycle and automatically

0 commit comments

Comments
 (0)