Documentation

Configuring Chronograf

Chronograf is configured by passing command line options when starting the Chronograf service. However, it is also possible to set custom default configuration options in the filesystem so they don’t have to be passed in when starting Chronograf.

Starting the Chronograf service

Start Chronograf using the default configuration options, or customize your configuration with environment variables and command line options (for example, to configure OAuth 2.0 authentication) based on your requirements.

Linux:

sudo systemctl start chronograf [OPTIONS]

macOS:

chronograf [OPTIONS]

[OPTIONS] are available Chronograf command line options, separated by spaces. See the Chronograf configuration options documentation for details about configuration options, including command line options and corresponding environment variables.

Setting custom default Chronograf config options

Custom default Chronograf configuration settings can be defined in /etc/default/chronograf. This file consists of key-value pairs. See keys (environment variables) for Chronograf configuration options, and set values for the keys you want to configure.

HOST=0.0.0.0
PORT=8888
TLS_CERTIFICATE=/path/to/cert.pem
TOKEN_SECRET=MySup3rS3cretT0k3n
LOG_LEVEL=info

Note: /etc/default/chronograf is only created in Linux-based operating systems. It is neither created nor used in macOS.

Setting up security, organizations, and users

To set up security for Chronograf, configure:

After you configure OAuth 2.0 authentication, you can set up multiple organizations, roles, and users. For details, check out the following topics:


Was this page helpful?

Thank you for your feedback!


Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

InfluxDB Cloud backed by InfluxDB IOx

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by IOx, this is the correct documentation.

If powered by TSM, see the TSM-based InfluxDB Cloud documentation.

InfluxDB Cloud backed by InfluxDB TSM

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine which enables nearly unlimited series cardinality and SQL query support. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by TSM, this is the correct documentation.

If powered by IOx, see the IOx-based InfluxDB Cloud documentation.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.