From f8009879eb09340231dcfed628f8faf984dfce52 Mon Sep 17 00:00:00 2001
From: Ben Burwell <ben@benburwell.com>
Date: Wed, 28 Nov 2018 00:41:55 -0500
Subject: Add license and readme

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9d39961
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# GitHub SSH AuthorizedKeysCommand Utility
+
+Use the SSH public keys you've added to GitHub to log in to your machines!
+
+## 0. Compile for your target OS
+
+Currently, ghsshauth has been tested on Debian and FreeBSD, but should basically
+support all UNIX-like systems. Feel free to send patches.
+
+```
+$ git clone git@github.com:benburwell/ghsshauth.git
+$ cd ghsshauth
+$ GOOS=linux GOARCH=amd64 go build
+```
+
+## 1. Configure host
+
+Put the binary in `/usr/local/sbin` and make sure it's owned by root and is
+chmodded to 755. Open `/etc/ssh/sshd_config`, find the `AuthorizedKeysCommand`
+line, and change it to:
+
+```
+AuthorizedKeysCommand /usr/local/sbin/ghsshauth %h
+AuthorizedKeysCommandUser nobody
+```
+
+(the `%h` represents the home directory of the user being authenticated).
+
+In your home directory, create the file `.ssh/authorized_github_users` and add
+your GitHub username (and any other username you want to have access) to the
+file, one per line. You can begin lines with the `#` character to have them be
+ignored.
+
+**IMPORTANT:** You'll need to make sure that the `AuthorizedKeysCommandUser` has
+read access to the entire path up to your `authorized_github_users` file, i.e.
+your home directory needs to be `chmod 755` as does your `.ssh` directory. Be
+sure that any secret keys in your `.ssh` directory such as `id_rsa` are `chmod 600`!
-- 
cgit v1.2.3