@@ -132,6 +132,59 @@ CUBEJS_EXT_DB_TYPE=cubestore
132132CUBEJS_EXT_DB_HOST=cubestore
133133` ` `
134134
135+ # ## Configuration
136+
137+ Cubestore can be configured via next (hopefuly self-explanatory) environment variables :
138+
139+ * `CUBESTORE_BIND_ADDR` - bind address, default `0.0.0.0:3306`
140+ * `CUBESTORE_PORT` - port, default `3306`
141+ * `CUBESTORE_STATUS_BIND_ADDR` - status probe bind address, default `0.0.0.0:3031`
142+ * `CUBESTORE_HTTP_BIND_ADDR` - HTTP API bind address, default `0.0.0.0:3030`
143+ * `CUBESTORE_STALE_STREAM_TIMEOUT` - stale stream timeout, default `600s`
144+ * `CUBESTORE_WORKERS` - number of workers
145+ * `CUBESTORE_WORKER_BIND_ADDR` - worker bind address, default `0.0.0.0:<CUBESTORE_WORKER_PORT>`
146+ * `CUBESTORE_WORKER_PORT` - worker port
147+ * `CUBESTORE_META_BIND_ADDR` - metastore bind address, default `0.0.0.0:<CUBESTORE_META_PORT>
148+ * `CUBESTORE_META_ADDR` - remote metastore address
149+ * `CUBESTORE_META_PORT` - remote metastore port
150+ * `CUBESTORE_SERVER_NAME` - server name, default `localhost`
151+ * `CUBESTORE_LONG_TERM_JOB_RUNNERS` - count of job runners, default `32`
152+ * `CUBESTORE_NO_UPLOAD` - disable uploading, default `false`
153+ * `CUBESTORE_ENABLE_TOPK` - enable TOP K, default `true`
154+ * `CUBESTORE_METRICS_FORMAT` - metrics format, can be `statsd` or `dogstatsd`
155+ * `CUBESTORE_METRICS_ADDRESS` - metrics address, default `127.0.0.1`
156+ * `CUBESTORE_METRICS_PORT` - metrics port, default `8125`
157+ * `CUBESTORE_TELEMETRY` - enable telemetry, default `true`
158+ * `CUBESTORE_LOG_LEVEL` - log level, can be `error`, `warn`, `info`, `debug`, `trace`, default `info`
159+ * `CUBESTORE_EVENT_LOOP_WORKER_THREADS` - number of event loop worker threads
160+ * `CUBESTORE_SELECT_WORKER_TITLE` - worker process title, default `--sel-worker`
161+ * `CUBESTORE_LOG_CONTEXT` - context string to add to all logs, default `<empty>`
162+ * `CUBESTORE_DATA_DIR` - data directory, default `<current_dir>/.cubestore`
163+ * `CUBESTORE_DUMP_DIR` - dump directory
164+ * `CUBESTORE_PARTITION_SPLIT_THRESHOLD` - partition split threshold, default `2 097 152`
165+ * `CUBESTORE_AGENT_ENDPOINT_URL` - agent endpoint url
166+
167+ * Storage configuration:
168+ * `CUBESTORE_REMOTE_DIR` - remote directory local path
169+ * `CUBESTORE_S3_BUCKET` - AWS S3 bucket name
170+ * `CUBESTORE_S3_REGION` - AWS S3 region
171+ * `CUBESTORE_S3_SUB_PATH` - AWS S3 sub path
172+ * `CUBESTORE_AWS_ACCESS_KEY_ID` - AWS access key id
173+ * `CUBESTORE_AWS_SECRET_ACCESS_KEY` - AWS secret access key
174+ * `CUBESTORE_AWS_CREDS_REFRESH_EVERY_MINS` - AWS credentials refresh interval in minutes
175+ * `CUBESTORE_MINIO_BUCKET` - MinIO bucket name
176+ * `CUBESTORE_MINIO_SUB_PATH` - MinIO sub path
177+ * `CUBESTORE_MINIO_ACCESS_KEY_ID` - MinIO access key id
178+ * `CUBESTORE_MINIO_SECRET_ACCESS_KEY` - MinIO secret access key
179+ * `CUBESTORE_MINIO_SERVER_ENDPOINT` - MinIO server endpoint
180+ * `CUBESTORE_MINIO_REGION` - MinIO region
181+ * `CUBESTORE_MINIO_CREDS_REFRESH_EVERY_MINS` - MinIO credentials refresh interval in minutes
182+ * `CUBESTORE_GCS_BUCKET` - GCS bucket name
183+ * `CUBESTORE_GCS_SUB_PATH` - GCS sub path
184+ * `CUBESTORE_GCP_CREDENTIALS` - GCP credentials
185+ * `CUBESTORE_GCP_KEY_FILE` - GCP key file path
186+
187+
135188# # Build
136189
137190` ` ` bash
0 commit comments