aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMarco Bonetti <marco@intercom.io>2016-06-10 14:11:54 +0100
committerMarco Bonetti <marco@intercom.io>2016-06-14 09:26:29 +0100
commita03243a826bb4eb5eebad19133f6b15e2f5dfdc2 (patch)
treebedda3934ce501a32f2f13b00b1929e458170cc7 /README.md
parentc074b8694f28ab6b3cc1ccb31474cfa507f73e81 (diff)
Add support for a users whitelist
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2d0be20..d332267 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,8 @@ For the server you need the following:
## Installation using Go tools
1. Use the Go tools to install cashier. The binaries `cashierd` and `cashier` will be installed in your $GOPATH.
```
-go get github.com/nsheridan/cashier/cmd/...
+go get -u github.com/nsheridan/cashier/cmd/cashier
+go get -u github.com/nsheridan/cashier/cmd/cashierd
```
2. Create a signing key with `ssh-keygen` and a [cashierd.conf](example-server.conf)
3. Run the cashier server with `cashierd` and the cli with `cashier`.
@@ -85,6 +86,7 @@ Configuration is divided into different sections: `server`, `auth`, `ssh`, and `
- `oauth_client_secret` : string. Oauth secret.
- `oauth_callback_url` : string. URL that the Oauth provider will redirect to after user authorisation. The path is hardcoded to `"/auth/callback"` in the source.
- `provider_opts` : object. Additional options for the provider.
+- `users_whitelist` : array of strings. Optional list of whitelisted usernames. If missing, all users of your current domain/organization are allowed to authenticate against cashierd.
#### Provider-specific options