Skip to content
This repository was archived by the owner on Jan 22, 2025. It is now read-only.

Commit c50f3ff

Browse files
committed
Add more troubleshooting docs
1 parent a4e45c7 commit c50f3ff

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

docs/troubleshooting.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,19 @@ user than you are using for kssh.
4040

4141
## SSH rejects the connection
4242

43-
This likely means that you have not configured the SSH server correctly. Review the directions in README.md and ensure
44-
that you have followed the steps correctly ([sshca.md](./sshca.md) also has some additional information on how SSH CAs work that may
43+
This likely means that you have not configured the SSH server correctly. Confirm that on the SSH server you are trying to access:
44+
45+
* `/etc/ssh/ca.pub` has an SSH public key in it
46+
* `/etc/ssh/auth_principals/username-of-ssh-user` has the name of your Keybase team in it (or multiple comma separated keybase teams)
47+
* `/etc/ssh/sshd_config` has the below two lines somewhere in it:
48+
49+
```
50+
TrustedUserCAKeys /etc/ssh/ca.pub
51+
AuthorizedPrincipalsFile /etc/ssh/auth_principals/%u
52+
```
53+
54+
If that all looks good, review the getting started directions and ensure that you have followed the steps correctly
55+
([sshca.md](./sshca.md) also has some additional information on how SSH CAs work that may
4556
be helpful). If you would like to follow an example, see the code in the `tests/` directory which contains integration
4657
tests (focus on Dockerfile-sshd for an example SSH server setup). If none of that works, the best strategy is to run
4758
SSH on the server on an alternate port and review the debug information. On the server run `/usr/sbin/sshd -dd -D -p 2222`
@@ -110,3 +121,8 @@ It may be useful to define aliases in your bashrc to simplify this:
110121
alias kscp='kssh --provision && scp -F ~/.ssh/kssh-config'
111122
alias krsync='kssh --provision && rsync -e "ssh -F $HOME/.ssh/kssh-config"'
112123
```
124+
125+
## Other
126+
127+
For any other issues, please open a Github issue or ping @dworken on Keybase! We want to make this project as reliable
128+
as possible so please let us know if there are any ways we can improve the project.

0 commit comments

Comments
 (0)