From eabba895131aaaad623fdec22370dcb98a166e93 Mon Sep 17 00:00:00 2001 From: noramullen1 <42354779+noramullen1@users.noreply.github.com> Date: Fri, 20 Nov 2020 11:36:19 -0800 Subject: [PATCH] Add examples for multiple parameters --- .../v1.8/administration/config-options.md | 131 ++++++++++++++++++ .../v1.8/administration/managing-security.md | 2 +- 2 files changed, 132 insertions(+), 1 deletion(-) diff --git a/content/chronograf/v1.8/administration/config-options.md b/content/chronograf/v1.8/administration/config-options.md index c18bbc2e5..9acc90ded 100644 --- a/content/chronograf/v1.8/administration/config-options.md +++ b/content/chronograf/v1.8/administration/config-options.md @@ -205,8 +205,31 @@ Environment variable: `$TLS_PRIVATE_KEY` List of etcd endpoints. +##### CLI example + +```sh +## Single parameter +--etcd-endpoints=localhost:2379 + +## Mutiple parameters +--etcd-endpoints=localhost:2379 \ +--etcd-endpoints=192.168.1.61:2379 \ +--etcd-endpoints=192.192.168.1.100:2379 +``` + Environment variable: `$ETCD_ENDPOINTS` +##### Environment variable example + +```sh +## Single parameter +ETCD_ENDPOINTS=localhost:2379 + +## Mutiple parameters +ETCD_ENDPOINTS=localhost:2379,192.168.1.61:2379,192.192.168.1.100:2379 +``` + + #### `--etcd-username=` Username to log into etcd. @@ -332,8 +355,30 @@ Environment variable: `$GH_CLIENT_SECRET` [Optional] Specify a GitHub organization membership required for a user. +##### CLI example + +```sh +## Single parameter +--github-organization=org1 + +## Mutiple parameters +--github-organization=org1 \ +--github-organization=org2 \ +--github-organization=org3 +``` + Environment variable: `$GH_ORGS` +##### Environment variable example + +```sh +## Single parameter +GH_ORGS=org1 + +## Mutiple parameters +GH_ORGS=org1,org2,org3 +``` + ### Google-specific OAuth 2.0 authentication options See [Configuring Google authentication](/chronograf/v1.8/administration/managing-security/#configure-google-authentication) for more information. @@ -354,8 +399,29 @@ Environment variable: `$GOOGLE_CLIENT_SECRET` [Optional] Restricts authorization to users from specified Google email domains. +##### CLI example + +```sh +## Single parameter +--google-domains=biffspleasurepalace.com + +## Mutiple parameters +--google-domains=biffspleasurepalace.com \ +--google-domains=savetheclocktower.com +``` + Environment variable: `$GOOGLE_DOMAINS` +##### Environment variable example + +```sh +## Single parameter +GOOGLE_DOMAINS=biffspleasurepalace.com + +## Mutiple parameters +GOOGLE_DOMAINS=biffspleasurepalace.com,savetheclocktower.com +``` + ### Auth0-specific OAuth 2.0 authentication options See [Configuring Auth0 authentication](/chronograf/v1.8/administration/managing-security/#configure-auth0-authentication) for more information. @@ -386,8 +452,30 @@ Environment variable: `$AUTH0_CLIENT_SECRET` Organizations are set using an "organization" key in the user's `app_metadata`. Lists are comma-separated and are only available when using environment variables. +##### CLI example + +```sh +## Single parameter +--auth0-organizations=org1 + +## Mutiple parameters +--auth0-organizations=org1 \ +--auth0-organizations=org2 \ +--auth0-organizations=org3 +``` + Environment variable: `$AUTH0_ORGS` +##### Environment variable example + +```sh +## Single parameter +AUTH0_ORGS=org1 + +## Mutiple parameters +AUTH0_ORGS=org1,org2,org3 +``` + ### Heroku-specific OAuth 2.0 authentication options See [Configuring Heroku authentication](/chronograf/v1.8/administration/managing-security/#configure-heroku-authentication) for more information. @@ -437,16 +525,59 @@ The scopes requested by provider of web client. Default value: `user:email` +##### CLI example + +```sh +## Single parameter +--generic-scopes=api + +## Mutiple parameters +--generic-scopes=api \ +--generic-scopes=openid \ +--generic-scopes=read_user +``` + Environment variable: `$GENERIC_SCOPES` +##### Environment variable example + +```sh +## Single parameter +GENERIC_SCOPES=api + +## Mutiple parameters +GENERIC_SCOPES=api,openid,read_user +``` + #### `--generic-domains=` The email domain required for user email addresses. Example: `--generic-domains=example.com` +##### CLI example + +```sh +## Single parameter +--generic-domains=biffspleasurepalace.com + +## Mutiple parameters +--generic-domains=biffspleasurepalace.com \ +--generic-domains=savetheclocktower.com +``` + Environment variable: `$GENERIC_DOMAINS` +##### Environment variable example + +```sh +## Single parameter +GENERIC_DOMAINS=biffspleasurepalace.com + +## Mutiple parameters +GENERIC_DOMAINS=biffspleasurepalace.com,savetheclocktower.com +``` + #### `--generic-auth-url=` The authorization endpoint URL for the OAuth 2.0 provider. diff --git a/content/chronograf/v1.8/administration/managing-security.md b/content/chronograf/v1.8/administration/managing-security.md index bce9e1957..20e1fe43e 100644 --- a/content/chronograf/v1.8/administration/managing-security.md +++ b/content/chronograf/v1.8/administration/managing-security.md @@ -187,7 +187,7 @@ Separate multiple domains using commas. For example, to permit access only from `biffspleasurepalace.com` and `savetheclocktower.com`, set the environment variable as follows: ```sh -export GOOGLE_DOMAINS=biffspleasurepalance.com,savetheclocktower.com +export GOOGLE_DOMAINS=biffspleasurepalace.com,savetheclocktower.com ``` #### Configure Auth0 authentication