Configuration¶
Configuration belongs to the operator of each installation. The names below are public interfaces; their actual values must come from your environment or approved secret store. No deployment values are supplied by this manual.
Storage¶
| Variable | Purpose |
|---|---|
DATABASE_FOLDER |
Primary writable data root |
DATABASE_FOLDERS |
Comma-separated data roots; set consistently with the primary root |
SOURCE_FOLDER |
Repository root used by worker routines |
SHAREDDATA_S3_ENABLED |
Explicitly enable or disable object-store integration |
For the quick start, use the isolated relative example directories shown there. Memory mapping shares pages between processes on the same host. A network mount does not turn its host-local lock into a distributed lock.
Configuration sources¶
SharedData reads environment variables and may load a dotenv file from the working
directory and a persisted user configuration. SHAREDDATA_ENV_FILE selects the
persisted environment file. Use a fresh environment and working directory for examples.
Do not publish that file or copy an environment dump into an issue.
Some WebUI-managed service settings can override inherited connection settings. Review effective configuration privately before starting a worker or server.
Remote clients and authentication¶
| Variable | Purpose |
|---|---|
SHAREDDATA_ENDPOINT |
Your server's HTTPS origin |
SHAREDDATA_TOKEN |
A token with permission for the requested operation |
SHAREDDATA_SECRET_KEY / FLASK_SECRET_KEY |
Signing configuration for the applicable server/auth mode |
A generic endpoint is https://data.example.com. Replace it in your private
configuration. Keep secrets out of URLs, shell history, source files and screenshots.
Read tokens and command tokens have different permissions; a successful read does not
grant permission to dispatch routines.
Optional services¶
Configure only the integrations your application uses. Their connection values and credentials are installation-specific.
| Integration | Configuration names |
|---|---|
| S3-compatible storage | S3_BUCKET, AWS credential/profile variables, S3 endpoint settings |
| MongoDB | MONGODB_HOST, MONGODB_USER, MONGODB_PWD, replica-set/auth settings |
| Redis | REDIS_CLUSTER_NODES |
| Kafka | KAFKA_BOOTSTRAP_SERVERS, KAFKA_PARTITIONS, KAFKA_REPLICATION, KAFKA_RETENTION |
| Semantic data API | SHAREDDATA_DATA_API_CONFIG |
Use service documentation and the matching package version when provisioning these backends. Provider names, accounts, buckets, cluster members and dataset preferences are not universal defaults.
Logging¶
LOG_API controls API logging and LOG_FILE file logging. Turn both off for an
isolated example without configured log destinations. Credential redaction
protects recognized credential shapes in owned sinks; inspect reports before sharing.