aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNiall Sheridan <nsheridan@gmail.com>2016-04-21 21:53:34 +0100
committerNiall Sheridan <nsheridan@gmail.com>2016-04-21 22:19:06 +0100
commit8920c2af029a930bf904685c606285da17de9e9d (patch)
treea76c33543c230b29d23736a6a4f90e877e599f1a /README.md
parenteb7357b2622942ced3cedf48e796af4dda157576 (diff)
Some small fixes.
Rename 'GoogleOpts' to 'ProviderOpts'. Rename Principals to AdditionalPrincipals to match the config option.
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 71cc20c..2ba0b72 100644
--- a/README.md
+++ b/README.md
@@ -60,8 +60,8 @@ Configuration is divided into three sections: `server`, `auth`, and `ssh`.
- `oauth_client_id` : string. Oauth Client ID.
- `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.
-- `google_opts` : object. Additional options for the `google` provider.
-- `google_opts: { domain }` : string. Only allow users from this Google Apps domain. This is optional but leaving it unset will allow anyone with a Google account to obtain ssh certificates so don't do that.
+- `provider_opts` : object. Additional options for the provider.
+- `provider_opts: { domain }` : string. Applies to "google" provider. Only allow users from this Google Apps domain. This is optional but leaving it unset will allow anyone with a Google account to obtain ssh certificates so don't do that.
### ssh
- `signing_key`: string. Path to the signing ssh private key you created earlier.