Skip to content

Commit bc65593

Browse files
Hidenori MATSUKIHidenori MATSUKI
authored andcommitted
update readme
1 parent 724e5d7 commit bc65593

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
11
# OpenSSH AuthorizedKeysCommand GitHub
22

33
![GitHub Actions status for "test-all"](https://github.com/mazgi/openssh-authorizedkeyscommand-github/workflows/test-all/badge.svg)
4+
5+
Get your SSH Public Key from GitHub.
6+
7+
```console
8+
> openssh-authorizedkeyscommand-github --help
9+
OpenSSH AuthorizedKeysCommand GitHub
10+
11+
Usage:
12+
openssh-authorizedkeyscommand-github --user=<user>
13+
openssh-authorizedkeyscommand-github (--help | --version)
14+
15+
Options:
16+
--user=<user> GitHub user.
17+
-V, --version Show version.
18+
-h, --help Show this screen.
19+
```
20+
21+
## How to use
22+
23+
1. Place the binary in your `$PATH`.
24+
25+
2. Update `/etc/ssh/sshd_config`.
26+
27+
```ssh_config
28+
AuthorizedKeysCommand /usr/local/bin/openssh-authorizedkeyscommand-github --user %u
29+
```
30+
31+
3. Restart SSH server.

0 commit comments

Comments
 (0)