Environment Variables
This document lists the environment variables used to configure the Kleinkram application. These variables are typically defined in a .env file in the root directory.
Server Configuration
| Variable | Description | Default |
|---|---|---|
SERVER_PORT | The port on which the backend server listens. | 3000 |
Service URLs
These URLs are used for communication between services and for generating links.
| Variable | Description | Default |
|---|---|---|
FRONTEND_URL | The URL where the frontend application is accessible. | http://localhost:8003 |
DOCS_URL | The URL where the documentation site is accessible. | http://localhost:4000 |
BACKEND_URL | The URL where the backend API is accessible. | http://localhost:3000 |
S3 Configuration (Object Storage)
Configuration for SeaweedFS (or S3-compatible storage), which is used for object storage.
| Variable | Description | Default |
|---|---|---|
S3_USER | The username for S3 access. | seaweed |
S3_PASSWORD | The password for S3 access. | seaweed |
S3_ACCESS_KEY | The access key for S3 clients. | pMEKIOCnYJhmssiKZDGU |
S3_SECRET_KEY | The secret key for S3 clients. | ECnXGyUR5ZrPsxeD5JEWxtI1CMZFMJ8kTJMMAQ5B |
S3_DATA_BUCKET_NAME | The bucket name for main data storage. | data |
S3_DB_BUCKET_NAME | The bucket name for database dumps/backups. | dbdumps |
S3_ARTIFACTS_BUCKET_NAME | The bucket name for build artifacts. | artifacts |
S3_SCRIPTS_BUCKET_NAME | The bucket name for single-file action scripts. | action-scripts |
S3_ENDPOINT | The hostname or IP address of the S3 service. | localhost |
Database Configuration
Configuration for the PostgreSQL database.
| Variable | Description | Default |
|---|---|---|
DB_HOST | The hostname of the database server. | database |
DB_PORT | The port of the database server. | 5432 |
DB_DATABASE | The name of the database. | dbname |
DB_USER | The database username. | dbuser |
DB_PASSWORD | The database password. | dbuserpass |
DATA_SOURCE_NAME | The full connection string/DSN for TypeORM/Postgres. | postgresql://dbuser:dbuserpass@database:5432/dbname?sslmode=disable |
DEV | Set to true to enable development features (verbose logging, etc.). | true |
TypeORM Configuration
| Variable | Description | Default |
|---|---|---|
ENTITIES | Glob pattern to locate entity files. | dist/**/*.entity.js |
Seeding Configuration
| Variable | Description | Default |
|---|---|---|
SEED | Set to true to populate the database with initial seed data on startup. | true |
Authentication Configuration
| Variable | Description | Default |
|---|---|---|
VITE_USE_FAKE_OAUTH_FOR_DEVELOPMENT | Set to true to enable the mock OAuth provider for local dev. | true |
GOOGLE_KEY_FILE | Path to the Google Cloud service account key file. | google-service-account.json |
GOOGLE_CLIENT_ID | Google OAuth Client ID. | - |
GOOGLE_CLIENT_SECRET | Google OAuth Client Secret. | - |
GITHUB_CLIENT_ID | GitHub OAuth Client ID. | - |
GITHUB_CLIENT_SECRET | GitHub OAuth Client Secret. | - |
Access Config
| Variable | Description | Default |
|---|---|---|
ACCESS_CONFIG_PATH | Path (inside the container) to the access_config.json that defines the affiliation groups. Required: the backend refuses to start without a valid config. | /app/backend/access_config.dev.json |
ACCESS_CONFIG_FILE | Host path of the deployment's access_config.json, mounted by docker-compose.dev.yml and docker-compose.prod.yml. | ./access_config.json |
JWT_SECRET | Secret key used to sign and verify JWT tokens. | SECRET |
Docker & Registry Configuration
| Variable | Description | Default |
|---|---|---|
DOCKER_HUB_USERNAME | Username for Docker Hub authentication. | - |
DOCKER_HUB_PASSWORD | Password for Docker Hub authentication. | - |
VITE_DOCKER_HUB_NAMESPACE | Restricts allowed Docker images to a specific namespace. | - |
ARTIFACTS_UPLOADER_IMAGE | Docker image used for uploading artifacts. | rslethz/kleinkram:artifact-uploader-latest |
DOCKER_GID | The group ID of the docker group on the host system. | 984 |