Documentation

Chronograf

chronograf - Chronograf server

The chronograf daemon starts and manages all the processes associated with the Chronograf server and includes options that manage many aspects of Chronograf security.

Usage

chronograf [flags]

Flags

Chronograf server flags

Flag Description Env. Variable
--host IP the Chronograf service listens on. By default, 0.0.0.0 HOST
--port Port the Chronograf service listens on for insecure connections. By default, 8888 PORT
-b --bolt-path File path to the BoltDB file. By default, ./chronograf-v1.db BOLT_PATH
-c --canned-path File path to the directory of canned dashboard files. By default, /usr/share/chronograf/canned CANNED_PATH
--resources-path Path to directory of canned dashboards, sources, Kapacitor connections, and organizations. By default, /usr/share/chronograf/resources RESOURCES_PATH
-p --basepath URL path prefix under which all Chronograf routes will be mounted. BASE_PATH
--status-feed-url URL of JSON feed to display as a news feed on the client status page. By default, https://www.influxdata.com/feed/json STATUS_FEED_URL
-v --version Displays the version of the Chronograf service
-h --host-page-disabled Disables the hosts page HOST_PAGE_DISABLED

InfluxDB connection flags

Flag Description Env. Variable
--influxdb-url InfluxDB URL, including the protocol, IP address, and port INFLUXDB_URL
--influxdb-username InfluxDB username INFLUXDB_USERNAME
--influxdb-password InfluxDB password INFLUXDB_PASSWORD
--influxdb-org InfluxDB 2.x or InfluxDB Cloud organization name INFLUXDB_ORG
--influxdb-token InfluxDB 2.x or InfluxDB Cloud authentication token INFLUXDB_TOKEN

Kapacitor connection flags

Flag Description Env. Variable
--kapacitor-url Location of your Kapacitor instance, including http://, IP address, and port KAPACITOR_URL
--kapacitor-username Username for your Kapacitor instance KAPACITOR_USERNAME
--kapacitor-password Password for your Kapacitor instance KAPACITOR_PASSWORD

TLS (Transport Layer Security) flags

Flag Description Env. Variable
--cert File path to PEM-encoded public key certificate TLS_CERTIFICATE
--key File path to private key associated with given certificate TLS_PRIVATE_KEY
--tls-ciphers Comma-separated list of supported cipher suites. Use help 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

Other server option flags

Flag Description Env. Variable
--custom-auto-refresh Add custom auto-refresh options using semicolon-separated list of label=milliseconds pairs CUSTOM-AUTO-REFRESH
--custom-link Add a custom link to Chronograf user menu options using <display_name>:<link_address> syntax. For multiple custom links, include multiple flags.
-d --develop Run the Chronograf service in developer mode
-h --help Display command line help for Chronograf
-l --log-level Set the logging level. Valid values include info (default), debug, and error LOG_LEVEL
-r --reporting-disabled Disable reporting of usage statistics. Usage statistics reported once every 24 hours include: OS, arch, version, cluster_id, and uptime. REPORTING_DISABLED

Authentication option flags

General authentication flags

Flag Description Env. Variable
-t --token-secret Secret for signing tokens TOKEN_SECRET
--auth-duration Total duration, in hours, of cookie life for authentication. Default value is 720h. AUTH_DURATION
--public-url Public URL required to access Chronograf using a web browser. For example, if you access Chronograf using the default URL, the public URL value would be http://localhost:8888. Required for Google OAuth 2.0 authentication. Used for Auth0 and some generic OAuth 2.0 authentication providers. PUBLIC_URL
—-htpasswd Path to password file for use with HTTP basic authentication. See NGINX documentation for more on password files. HTPASSWD

GitHub-specific OAuth 2.0 authentication flags

Flag Description Env. Variable
--github-url GitHub base URL. Default is https://github.com. Required if using GitHub Enterprise GH_URL
-i --github-client-id GitHub client ID value for OAuth 2.0 support GH_CLIENT_ID
-s --github-client-secret GitHub client secret value for OAuth 2.0 support GH_CLIENT_SECRET
-o --github-organization Restricts authorization to users from specified GitHub organizations. To add more than one organization, add multiple flags. Optional. GH_ORGS

Google-specific OAuth 2.0 authentication flags

Flag Description Env. Variable
--google-client-id Google client ID value for OAuth 2.0 support GOOGLE_CLIENT_ID
--google-client-secret Google client secret value for OAuth 2.0 support GOOGLE_CLIENT_SECRET
--google-domains Restricts authorization to users from specified Google email domain. To add more than one domain, add multiple flags. Optional. GOOGLE_DOMAINS

Auth0-specific OAuth 2.0 authentication flags

Flag Description Env. Variable
--auth0-domain Subdomain of your Auth0 client. Available on the configuration page for your Auth0 client. AUTH0_DOMAIN
--auth0-client-id Auth0 client ID value for OAuth 2.0 support AUTH0_CLIENT_ID
--auth0-client-secret Auth0 client secret value for OAuth 2.0 support AUTH0_CLIENT_SECRET
--auth0-organizations Restricts authorization to users specified Auth0 organization. To add more than one organization, add multiple flags. Optional. Organizations are set using an organization key in the user’s app_metadata. AUTH0_ORGS

Heroku-specific OAuth 2.0 authentication flags

Flag Description Env. Variable
--heroku-client-id Heroku client ID value for OAuth 2.0 support HEROKU_CLIENT_ID
--heroku-secret Heroku secret for OAuth 2.0 support HEROKU_SECRET
--heroku-organization Restricts authorization to users from specified Heroku organization. To add more than one organization, add multiple flags. Optional. HEROKU_ORGS

Generic OAuth 2.0 authentication flags

Flag Description Env. Variable
--generic-name Generic OAuth 2.0 name presented on the login page GENERIC_NAME
--generic-client-id Generic OAuth 2.0 client ID value. Can be used for a custom OAuth 2.0 service. GENERIC_CLIENT_ID
--generic-client-secret Generic OAuth 2.0 client secret value GENERIC_CLIENT_SECRET
--generic-scopes Scopes requested by provider of web client GENERIC_SCOPES
--generic-domains Email domain required for user email addresses GENERIC_DOMAINS
--generic-auth-url Authorization endpoint URL for the OAuth 2.0 provider GENERIC_AUTH_URL
--generic-token-url Token endpoint URL for the OAuth 2.0 provider GENERIC_TOKEN_URL
--generic-api-url URL that returns OpenID UserInfo-compatible information GENERIC_API_URL
--oauth-no-pkce Disable OAuth PKCE OAUTH_NO_PKCE

etcd flags

Flag Description Env. Variable
-e --etcd-endpoints etcd endpoint URL (include multiple flags for multiple endpoints) ETCD_ENDPOINTS
--etcd-username etcd username ETCD_USERNAME
--etcd-password etcd password 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 for use with TLS ETCD_CERTIFICATE
--etcd-key Path to private key associated with given certificate for use with TLS ETCD_PRIVATE_KEY
--etcd-root-ca Path to root CA certificate for TLS verification ETCD-ROOT-CA

Was this page helpful?

Thank you for your feedback!

© 2024 InfluxData, Inc.

Where are you running InfluxDB?

Select your InfluxDB Cloud region and cluster or your InfluxDB OSS URL and we’ll customize code examples for you. Identify your InfluxDB Cloud cluster.

  • InfluxDB Cloud
  • InfluxDB OSS or Enterprise
AWS

  • US West (Oregon)

GCP
Azure
Default
Custom

For more information, see InfluxDB Cloud regions or InfluxDB OSS URLs.

Thank you for your feedback!

Let us know what we can do better:

Thank you!

No thanks

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: