Usage:
chronograf [OPTIONS]
Options for Chronograf
Application Options:
--host= The IP to listen on (default:
0.0.0.0) [$HOST]
--port= The port to listen on for
insecure connections, defaults to
a random value (default: 8888)
[$PORT]
--disable-gzip Disables gzip compression, even
if client requests it. Useful if
running on a low-cpu device
[$DISABLE_GZIP]
--pprof-enabled Enable the /debug/pprof/* HTTP
routes [$PPROF_ENABLED]
--cert= Path to PEM encoded public key
certificate. [$TLS_CERTIFICATE]
--key= Path to private key associated
with given certificate.
[$TLS_PRIVATE_KEY]
--influxdb-type= InfluxDB server type instance.
Valid values: influx,
influx-enterprise, influx-relay,
influx-v2, influx-v3-core,
influx-v3-enterprise,
influx-v3-clustered,
influx-v3-cloud-dedicated,
influx-v3-serverless
[$INFLUXDB_TYPE]
--influxdb-url= Location of your InfluxDB
instance [$INFLUXDB_URL]
--influxdb-username= Username for your InfluxDB
instance [$INFLUXDB_USERNAME]
--influxdb-password= Password for your InfluxDB
instance [$INFLUXDB_PASSWORD]
--influxdb-org= Organization for your InfluxDB v2
instance [$INFLUXDB_ORG]
--influxdb-token= Token for your InfluxDB v2, v3
Core/Enterprise, Cloud Dedicated
or Serverless instance
[$INFLUXDB_TOKEN]
--influxdb-mgmt-token= Management token for your
InfluxDB Cloud Dedicated instance
[$INFLUXDB_MGMT_TOKEN]
--influxdb-cluster-id= Cluster ID for your InfluxDB
Cloud Dedicated instance
[$INFLUXDB_CLUSTER_ID]
--influxdb-account-id= Account ID for your InfluxDB
Cloud Dedicated instance
[$INFLUXDB_ACCOUNT_ID]
--tags-csv-path= Path to a directory containing
CSV files (per db) with tags for
InfluxDB v3 sources. Used to
populate the tags field in Query
Editor for your InfluxDB Cloud
Dedicated instance.
[$TAGS_CSV_PATH]
--influxdb-default-db= Default database for your
InfluxDB instance
[$INFLUXDB_DEFAULT_DB]
--influxdb-cloud-dedicated-mgmt-url= Management URL for your InfluxDB
Cloud Dedicated instance
(default:
https://console.influxdata.com)
[$INFLUXDB_CLOUD_DEDICATED_MGMT_U-
RL]
--influxdb-clustered-cluster-id= Cluster ID for your InfluxDB v3
Clustered instance (default:
11111111-1111-1111-1111-111111111-
111)
[$INFLUXDB_CLUSTERED_CLUSTER_ID]
--influxdb-clustered-account-id= Account ID for your InfluxDB v3
Clustered instance (default:
11111111-1111-1111-1111-111111111-
111)
[$INFLUXDB_CLUSTERED_ACCOUNT_ID]
--influxdb-v3-support-enabled Enable InfluxDB v3 support
[$INFLUXDB_V3_SUPPORT_ENABLED]
--influxdb-v3-time-condition= Time condition for SHOW TAG
VALUES queries in InfluxDB v3
(e.g., 'time > now() - 1d')
(default: time > now() - 1d)
[$INFLUXDB_V3_TIME_CONDITION]
--kapacitor-url= Location of your Kapacitor
instance [$KAPACITOR_URL]
--kapacitor-username= Username of your Kapacitor
instance [$KAPACITOR_USERNAME]
--kapacitor-password= Password of your Kapacitor
instance [$KAPACITOR_PASSWORD]
-d, --develop Run server in develop mode.
-b, --bolt-path= Full path to boltDB file (e.g.
'./chronograf-v1.db') (default:
chronograf-v1.db) [$BOLT_PATH]
-c, --canned-path= Path to directory of pre-canned
application layouts
(/usr/share/chronograf/canned)
(default: canned) [$CANNED_PATH]
--protoboards-path= Path to directory of protoboards
(/usr/share/chronograf/protoboard-
s) (default: protoboards)
[$PROTOBOARDS_PATH]
--resources-path= Path to directory of pre-canned
dashboards, sources, kapacitors,
and organizations
(/usr/share/chronograf/resources)
(default: canned)
[$RESOURCES_PATH]
-t, --token-secret= Secret to sign tokens
[$TOKEN_SECRET]
--jwks-url= URL that returns OpenID Key
Discovery JWKS document.
[$JWKS_URL]
--use-id-token Enable id_token processing.
[$USE_ID_TOKEN]
--login-hint= OpenID login_hint parameter to
passed to authorization server
during authentication
[$LOGIN_HINT]
--auth-duration= Total duration of cookie life for
authentication (in hours). 0
means authentication expires on
browser close. (default: 720h)
[$AUTH_DURATION]
--inactivity-duration= Duration for which a token is
valid without any new activity.
(default: 5m)
[$INACTIVITY_DURATION]
-i, --github-client-id= Github Client ID for OAuth 2
support [$GH_CLIENT_ID]
-s, --github-client-secret= Github Client Secret for OAuth 2
support [$GH_CLIENT_SECRET]
-o, --github-organization= Github organization user is
required to have active
membership [$GH_ORGS]
--github-url= Github base URL must be specified
for Github Enterprise. (default:
https://github.com) [$GH_URL]
-e, --etcd-endpoints= List of etcd endpoints
[$ETCD_ENDPOINTS]
--etcd-username= Username to log into etcd.
[$ETCD_USERNAME]
--etcd-password= Password to log into etcd.
[$ETCD_PASSWORD]
--etcd-dial-timeout= Total time to wait before timing
out while connecting to etcd
endpoints. 0 means no timeout.
(default: -1s)
[$ETCD_DIAL_TIMEOUT]
--etcd-request-timeout= Total time to wait before timing
out the etcd view or update. 0
means no timeout. (default: -1s)
[$ETCD_REQUEST_TIMEOUT]
--etcd-cert= Path to PEM encoded TLS public
key certificate.
[$ETCD_CERTIFICATE]
--etcd-key= Path to private key associated
with given certificate.
[$ETCD_PRIVATE_KEY]
--etcd-root-ca= File location of root CA cert for
TLS verification. [$ETCD_ROOT_CA]
--google-client-id= Google Client ID for OAuth 2
support [$GOOGLE_CLIENT_ID]
--google-client-secret= Google Client Secret for OAuth 2
support [$GOOGLE_CLIENT_SECRET]
--google-domains= Google email domain user is
required to have active
membership [$GOOGLE_DOMAINS]
--public-url= Full public URL used to access
Chronograf from a web browser.
Used for OAuth2 authentication.
(http://localhost:8888)
[$PUBLIC_URL]
--heroku-client-id= Heroku Client ID for OAuth 2
support [$HEROKU_CLIENT_ID]
--heroku-secret= Heroku Secret for OAuth 2 support
[$HEROKU_SECRET]
--heroku-organization= Heroku Organization Memberships a
user is required to have for
access to Chronograf (comma
separated) [$HEROKU_ORGS]
--generic-name= Generic OAuth2 name presented on
the login page [$GENERIC_NAME]
--generic-client-id= Generic OAuth2 Client ID. Can be
used own OAuth2 service.
[$GENERIC_CLIENT_ID]
--generic-client-secret= Generic OAuth2 Client Secret
[$GENERIC_CLIENT_SECRET]
--generic-scopes= Scopes requested by provider of
web client. (default: user:email)
[$GENERIC_SCOPES]
--generic-domains= Email domain users' email address
to have (example.com)
[$GENERIC_DOMAINS]
--generic-auth-url= OAuth 2.0 provider's
authorization endpoint URL
[$GENERIC_AUTH_URL]
--generic-token-url= OAuth 2.0 provider's token
endpoint URL [$GENERIC_TOKEN_URL]
--generic-api-url= URL that returns OpenID UserInfo
compatible information.
[$GENERIC_API_URL]
--generic-api-key= JSON lookup key into OpenID
UserInfo. (Azure should be
userPrincipalName) (default:
email) [$GENERIC_API_KEY]
--generic-insecure Whether or not to verify
auth-url's tls certificates.
[$GENERIC_INSECURE]
--generic-root-ca= File location of root ca cert for
generic oauth tls verification.
[$GENERIC_ROOT_CA]
--oauth-no-pkce Disables OAuth PKCE.
[$OAUTH_NO_PKCE]
--oauth-logout-endpoint= OAuth endpoint to call for logout
from OAuth Identity provider.
[$OAUTH_LOGOUT_ENDPOINT]
--auth0-domain= Subdomain of auth0.com used for
Auth0 OAuth2 authentication
[$AUTH0_DOMAIN]
--auth0-client-id= Auth0 Client ID for OAuth2
support [$AUTH0_CLIENT_ID]
--auth0-client-secret= Auth0 Client Secret for OAuth2
support [$AUTH0_CLIENT_SECRET]
--auth0-organizations= Auth0 organizations permitted to
access Chronograf (comma
separated) [$AUTH0_ORGS]
--auth0-superadmin-org= Auth0 organization from which
users are automatically granted
SuperAdmin status
[$AUTH0_SUPERADMIN_ORG]
--redir-auth-login= Automatically redirect login to
specified OAuth provider.
[$REDIR_AUTH_LOGIN]
--pub-key= Public key or superadmin token
authentication [$PUB_KEY]
--pub-key-file= File location of public key for
superadmin token authentication.
[$PUB_KEY_FILE]
--nonce-expiration= Duration in which a signed nonce
is valid. Used for superadmin
token authentication. (default:
10m) [$NONCE_EXPIRATION]
--status-feed-url= URL of a JSON Feed to display as
a News Feed on the client Status
page. (default:
https://influxdata.com/feed/json)
[$STATUS_FEED_URL]
--custom-link= Custom link to be added to the
client User menu. Multiple links
can be added by using multiple of
the same flag with different
'name:url' values, or as an
environment variable with
comma-separated 'name:url'
values. E.g. via flags:
'--custom-link=InfluxData:https:/-
/www.influxdata.com
--custom-link=Chronograf:https://-
github.com/influxdata/chronograf'-
. E.g. via environment variable:
'export
CUSTOM_LINKS=InfluxData:https://w-
ww.influxdata.com,Chronograf:http-
s://github.com/influxdata/chronog-
raf' [$CUSTOM_LINKS]
--telegraf-system-interval= Duration used in the GROUP BY
time interval for the hosts list
(default: 1m)
[$TELEGRAF_SYSTEM_INTERVAL]
-H, --host-page-disabled Disable the host list page
[$HOST_PAGE_DISABLED]
-r, --reporting-disabled Disable reporting of usage stats
(os,arch,version,cluster_id,uptim-
e) once every 24hr
[$REPORTING_DISABLED]
--custom-auto-refresh= Adds custom auto refresh options
using semicolon separated list of
label=milliseconds pairs
[$CUSTOM_AUTO_REFRESH]
-l, --log-level=choice[debug|info|error] Set the logging level (default:
info) [$LOG_LEVEL]
-p, --basepath= A URL path prefix under which all
chronograf routes will be
mounted. (Note: PREFIX_ROUTES has
been deprecated. Now, if basepath
is set, all routes will be
prefixed with it.) [$BASE_PATH]
-v, --version Show Chronograf version info
--basic-auth-realm= User visible basic authentication
realm (default: Chronograf)
[$BASICAUTH_REALM]
--htpasswd= File location of .htpasswd file,
turns on HTTP basic
authentication when specified.
[$HTPASSWD]
--tls-ciphers= Comma-separated list of cipher
suites to use. Use 'help' cipher
to print available ciphers.
[$TLS_CIPHERS]
--tls-min-version= Minimum version of the TLS
protocol that will be negotiated.
(default: 1.2) [$TLS_MIN_VERSION]
--tls-max-version= Maximum version of the TLS
protocol that will be negotiated.
[$TLS_MAX_VERSION]
Help Options:
-h, --help Show this help message
Options (92)
| Option | Description | Source |
|---|---|---|
--host | The IP to listen on (default: 0.0.0.0) [$HOST] | help |
--port | The port to listen on for insecure connections, defaults to a random value (default: 8888) [$PORT] | help |
--disable-gzip | Disables gzip compression, even if client requests it. | help |
--pprof-enabled | Enable the /debug/pprof/* HTTP routes [$PPROF_ENABLED] | help |
--cert | Path to PEM encoded public key certificate. | help |
--key | Path to private key associated with given certificate. | help |
--influxdb-type | InfluxDB server type instance. | help |
--influxdb-url | Location of your InfluxDB instance [$INFLUXDB_URL] | help |
--influxdb-username | Username for your InfluxDB instance [$INFLUXDB_USERNAME] | help |
--influxdb-password | Password for your InfluxDB instance [$INFLUXDB_PASSWORD] | help |
--influxdb-org | Organization for your InfluxDB v2 instance [$INFLUXDB_ORG] | help |
--influxdb-token | Token for your InfluxDB v2, v3 Core/Enterprise, Cloud Dedicated or Serverless instance [$INFLUXDB_TOKEN] | help |
--influxdb-mgmt-token | Management token for your InfluxDB Cloud Dedicated instance [$INFLUXDB_MGMT_TOKEN] | help |
--influxdb-cluster-id | Cluster ID for your InfluxDB Cloud Dedicated instance [$INFLUXDB_CLUSTER_ID] | help |
--influxdb-account-id | Account ID for your InfluxDB Cloud Dedicated instance [$INFLUXDB_ACCOUNT_ID] | help |
--tags-csv-path | Path to a directory containing CSV files (per db) with tags for InfluxDB v3 sources. | help |
--influxdb-default-db | Default database for your InfluxDB instance [$INFLUXDB_DEFAULT_DB] | help |
--influxdb-cloud-dedicated-mgmt-url | Management URL for your InfluxDB Cloud Dedicated instance (default: https://console.influxdata.com) [$INFLUXDB_CLOUD_DEDICATED_MGMT_U- | help |
--influxdb-clustered-cluster-id | Cluster ID for your InfluxDB v3 Clustered instance (default: 11111111-1111-1111-1111-111111111- | help |
--influxdb-clustered-account-id | Account ID for your InfluxDB v3 Clustered instance (default: 11111111-1111-1111-1111-111111111- | help |
--influxdb-v3-support-enabled | Enable InfluxDB v3 support [$INFLUXDB_V3_SUPPORT_ENABLED] | help |
--influxdb-v3-time-condition | Time condition for SHOW TAG VALUES queries in InfluxDB v3 (e.g., 'time > now() - 1d') (default: time > now() - 1d) [$INFLUXDB_V3_TIME_CONDITION] | help |
--kapacitor-url | Location of your Kapacitor instance [$KAPACITOR_URL] | help |
--kapacitor-username | Username of your Kapacitor instance [$KAPACITOR_USERNAME] | help |
--kapacitor-password | Password of your Kapacitor instance [$KAPACITOR_PASSWORD] | help |
-d, --develop | Run server in develop mode. | help |
-b, --bolt-path | Full path to boltDB file (e.g. './chronograf-v1.db') (default: chronograf-v1.db) [$BOLT_PATH] | help |
-c, --canned-path | Path to directory of pre-canned application layouts (/usr/share/chronograf/canned) (default: canned) [$CANNED_PATH] | help |
--protoboards-path | Path to directory of protoboards (/usr/share/chronograf/protoboard- | help |
--resources-path | Path to directory of pre-canned dashboards, sources, kapacitors, and organizations (/usr/share/chronograf/resources) (default: canned) [$RESOURCES_PATH] | help |
-t, --token-secret | Secret to sign tokens [$TOKEN_SECRET] | help |
--jwks-url | URL that returns OpenID Key Discovery JWKS document. | help |
--use-id-token | Enable id_token processing. | help |
--login-hint | OpenID login_hint parameter to passed to authorization server during authentication [$LOGIN_HINT] | help |
--auth-duration | Total duration of cookie life for authentication (in hours). | help |
--inactivity-duration | Duration for which a token is valid without any new activity. | help |
-i, --github-client-id | Github Client ID for OAuth 2 support [$GH_CLIENT_ID] | help |
-s, --github-client-secret | Github Client Secret for OAuth 2 support [$GH_CLIENT_SECRET] | help |
-o, --github-organization | Github organization user is required to have active membership [$GH_ORGS] | help |
--github-url | Github base URL must be specified for Github Enterprise. | help |
-e, --etcd-endpoints | List of etcd endpoints [$ETCD_ENDPOINTS] | help |
--etcd-username | Username to log into etcd. | help |
--etcd-password | Password to log into etcd. | help |
--etcd-dial-timeout | Total time to wait before timing out while connecting to etcd endpoints. | help |
--etcd-request-timeout | Total time to wait before timing out the etcd view or update. | help |
--etcd-cert | Path to PEM encoded TLS public key certificate. | help |
--etcd-key | Path to private key associated with given certificate. | help |
--etcd-root-ca | File location of root CA cert for TLS verification. | help |
--google-client-id | Google Client ID for OAuth 2 support [$GOOGLE_CLIENT_ID] | help |
--google-client-secret | Google Client Secret for OAuth 2 support [$GOOGLE_CLIENT_SECRET] | help |
--google-domains | Google email domain user is required to have active membership [$GOOGLE_DOMAINS] | help |
--public-url | Full public URL used to access Chronograf from a web browser. | help |
--heroku-client-id | Heroku Client ID for OAuth 2 support [$HEROKU_CLIENT_ID] | help |
--heroku-secret | Heroku Secret for OAuth 2 support [$HEROKU_SECRET] | help |
--heroku-organization | Heroku Organization Memberships a user is required to have for access to Chronograf (comma separated) [$HEROKU_ORGS] | help |
--generic-name | Generic OAuth2 name presented on the login page [$GENERIC_NAME] | help |
--generic-client-id | Generic OAuth2 Client ID. | help |
--generic-client-secret | Generic OAuth2 Client Secret [$GENERIC_CLIENT_SECRET] | help |
--generic-scopes | Scopes requested by provider of web client. | help |
--generic-domains | Email domain users' email address to have (example.com) [$GENERIC_DOMAINS] | help |
--generic-auth-url | OAuth 2.0 provider's authorization endpoint URL [$GENERIC_AUTH_URL] | help |
--generic-token-url | OAuth 2.0 provider's token endpoint URL [$GENERIC_TOKEN_URL] | help |
--generic-api-url | URL that returns OpenID UserInfo compatible information. | help |
--generic-api-key | JSON lookup key into OpenID UserInfo. | help |
--generic-insecure | Whether or not to verify auth-url's tls certificates. | help |
--generic-root-ca | File location of root ca cert for generic oauth tls verification. | help |
--oauth-no-pkce | Disables OAuth PKCE. | help |
--oauth-logout-endpoint | OAuth endpoint to call for logout from OAuth Identity provider. | help |
--auth0-domain | Subdomain of auth0.com used for Auth0 OAuth2 authentication [$AUTH0_DOMAIN] | help |
--auth0-client-id | Auth0 Client ID for OAuth2 support [$AUTH0_CLIENT_ID] | help |
--auth0-client-secret | Auth0 Client Secret for OAuth2 support [$AUTH0_CLIENT_SECRET] | help |
--auth0-organizations | Auth0 organizations permitted to access Chronograf (comma separated) [$AUTH0_ORGS] | help |
--auth0-superadmin-org | Auth0 organization from which users are automatically granted SuperAdmin status [$AUTH0_SUPERADMIN_ORG] | help |
--redir-auth-login | Automatically redirect login to specified OAuth provider. | help |
--pub-key | Public key or superadmin token authentication [$PUB_KEY] | help |
--pub-key-file | File location of public key for superadmin token authentication. | help |
--nonce-expiration | Duration in which a signed nonce is valid. | help |
--status-feed-url | URL of a JSON Feed to display as a News Feed on the client Status page. | help |
--custom-link | Custom link to be added to the client User menu. | help |
--telegraf-system-interval | Duration used in the GROUP BY time interval for the hosts list (default: 1m) [$TELEGRAF_SYSTEM_INTERVAL] | help |
-H, --host-page-disabled | Disable the host list page [$HOST_PAGE_DISABLED] | help |
-r, --reporting-disabled | Disable reporting of usage stats (os,arch,version,cluster_id,uptim- | help |
--custom-auto-refresh | Adds custom auto refresh options using semicolon separated list of label=milliseconds pairs [$CUSTOM_AUTO_REFRESH] | help |
-l, --log-level choice[debug|info|error | Set the logging level (default: info) [$LOG_LEVEL] | help |
-p, --basepath | A URL path prefix under which all chronograf routes will be mounted. | help |
-v, --version | Show Chronograf version info | help |
--basic-auth-realm | User visible basic authentication realm (default: Chronograf) [$BASICAUTH_REALM] | help |
--htpasswd | File location of .htpasswd file, turns on HTTP basic authentication when specified. | help |
--tls-ciphers | Comma-separated list of cipher suites to use. | help |
--tls-min-version | Minimum version of the TLS protocol that will be negotiated. | help |
--tls-max-version | Maximum version of the TLS protocol that will be negotiated. | help |
-h, --help | Show this help message | help |