Skip to main content

CLI arguments

ArgumentEnvironment VariableDefault ValueDescription
--listenLISTEN0.0.0.0:8080Listen address in the format ip:port or :port.
--url-base-pathURL_BASE_PATH/Base URL to run Coroot at a sub-path, e.g., /coroot/.
--data-dirDATA_DIR/dataPath to the data directory.
--cache-ttlCACHE_TTL720hCache Time-To-Live (TTL).
--cache-gc-intervalCACHE_GC_INTERVAL10mCache Garbage Collection (GC) interval.
--pg-connection-stringPG_CONNECTION_STRINGPostgreSQL connection string (uses SQLite if not set).
--disable-usage-statisticsDISABLE_USAGE_STATISTICSfalseDisable usage statistics.
--read-onlyREAD_ONLYfalseEnable read-only mode where configuration changes don't take effect.
--do-not-check-sloDO_NOT_CHECK_SLOfalseDo not check Service Level Objective (SLO) compliance.
--do-not-check-for-deploymentsDO_NOT_CHECK_FOR_DEPLOYMENTSfalseDo not check for new deployments.
--do-not-check-for-updatesDO_NOT_CHECK_FOR_UPDATESfalseDo not check for new versions.
--auth-anonymous-roleAUTH_ANONYMOUS_ROLEDisable authentication and assign one of the following roles to the anonymous user: Admin, Editor, or Viewer.
--auth-bootstrap-admin-passwordAUTH_BOOTSTRAP_ADMIN_PASSWORDPassword for the default Admin user.
--license-keyLICENSE_KEYLicense key for Coroot Enterprise Edition.
--global-clickhouse-addressGLOBAL_CLICKHOUSE_ADDRESSThe address of the ClickHouse server to be used for all projects.
--global-clickhouse-userGLOBAL_CLICKHOUSE_USERThe username for the ClickHouse server to be used for all projects.
--global-clickhouse-passwordGLOBAL_CLICKHOUSE_PASSWORDThe password for the ClickHouse server to be used for all projects.
--global-clickhouse-initial-databaseGLOBAL_CLICKHOUSE_INITIAL_DATABASEThe initial database on the ClickHouse server to be used for all projects. Coroot will automatically create and manage a dedicated database for each project within the server.
--global-clickhouse-tls-enabledGLOBAL_CLICKHOUSE_TLS_ENABLEDWhether TLS is enabled for the ClickHouse server connection (true or false).
--global-clickhouse-tls-skip-verifyGLOBAL_CLICKHOUSE_TLS_SKIP_VERIFYWhether to skip verification of the ClickHouse server's TLS certificate (true or false).
--global-prometheus-urlGLOBAL_PROMETHEUS_URLThe URL of the Prometheus server to be used for all projects.
--global-prometheus-tls-skip-verifyGLOBAL_PROMETHEUS_TLS_SKIP_VERIFYfalseWhether to skip verification of the Prometheus server's TLS certificate (true or false).
--global-refresh-intervalGLOBAL_REFRESH_INTERVAL15sThe interval for refreshing Prometheus data.
--global-prometheus-userGLOBAL_PROMETHEUS_USERThe username for the Prometheus server to be used for all projects.
--global-prometheus-passwordGLOBAL_PROMETHEUS_PASSWORDThe password for the Prometheus server to be used for all projects.
--global-prometheus-custom-headersGLOBAL_PROMETHEUS_CUSTOM_HEADERSCustom headers to include in requests to the Prometheus server.