diff options
| author | Niall Sheridan <nsheridan@gmail.com> | 2016-05-22 22:24:14 +0100 |
|---|---|---|
| committer | Niall Sheridan <nsheridan@gmail.com> | 2016-05-22 22:24:14 +0100 |
| commit | 7f6b342de26e16e197f69c7576bb687aac03e527 (patch) | |
| tree | 51837e6b73902d9af9a2b0307706ae99033e13c5 /README.md | |
| parent | b6b37a0aac0532b6e5998c03c5491442dd1046a5 (diff) | |
Update README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 10 insertions, 2 deletions
@@ -60,6 +60,15 @@ go get github.com/cashier/cmd/... docker run -it --rm -p 10000:10000 --name cashier -v $(pwd):/cashier nsheridan/cashier ``` +# Requirements +## Server +Go 1.5+. May work with earlier versions. + +## Client +OpenSSH 5.6 or newer. +A working SSH agent. +I have only tested this on Linux & OSX. + # Configuration Configuration is divided into three sections: `server`, `auth`, and `ssh`. @@ -69,6 +78,7 @@ Configuration is divided into three sections: `server`, `auth`, and `ssh`. - `tls_cert` : string. Path to the TLS cert. - `port` : int. Port to listen on. - `cookie_secret`: string. Authentication key for the session cookie. +- `template_dir`: string. Path to html template directory. At present only 'token.html' is required. ### auth - `provider` : string. Name of the oauth provider. At present the only valid value is "google". @@ -117,5 +127,3 @@ where `/etc/ssh/ca.pub` contains the public part of your signing key. ## Future Work - Host certificates - only user certificates are supported at present. -- Record issued certs. -- Cert revocation - depends on recording issued certs. |