Skip to main content

Configuration

Fivemanage Lite is configured entirely via environment variables. This makes it easy to deploy in containerized environments like Docker and Kubernetes.

Environment Variables

VariableDescriptionRequiredDefault
PORTPort the server listens onNo8080
DSNPostgreSQL connection stringYes-
ADMIN_PASSWORDPassword for the initial admin accountYespassword
API_TOKEN_HMAC_SECRET32-byte secret key for signing API tokensYes-
CLICKHOUSE_HOSTAddress of the ClickHouse serverNolocalhost:19000
CLICKHOUSE_USERNAMEClickHouse usernameNodefault
CLICKHOUSE_PASSWORDClickHouse passwordNopassword
CLICKHOUSE_DATABASEClickHouse database nameNodefault
S3_PROVIDERStorage backend: s3, r2, or minioNominio
AWS_ACCESS_KEY_IDS3 Access KeyIf using S3-
AWS_SECRET_ACCESS_KEYS3 Secret KeyIf using S3-
AWS_BUCKETTarget bucket nameIf using S3-
AWS_REGIONS3 regionIf using S3-
AWS_ENDPOINTCustom endpoint (required for MinIO/R2)No-
ENVEnvironment mode (production or dev)Nodev

Infrastructure Dependencies

To run a fully functional instance, you must provision the following dependencies:

1. PostgreSQL (Primary Database)

Used for storing relational data, including user accounts, organization hierarchies, file metadata, and API tokens.
  • Version: 14+ recommended.
  • Connection: Configured via the DSN environment variable.

2. ClickHouse (Log Store)

Used for the high-performance ingestion and querying of structured logs. This is mandatory if you intend to use the logging features.
  • Why ClickHouse?: It handles millions of log rows with minimal storage footprint and instant query speeds compared to traditional SQL databases.

3. S3-Compatible Storage

Used for storing actual file assets (images, user uploads).
  • Supported Providers: AWS S3, Cloudflare R2, or MinIO (for self-hosting).

4. OpenTelemetry (Optional)

The application has native tracing support. You can connect it to a collector like Jaeger to visualize request flows and performance bottlenecks.