Environment Variables
Tianji supports various environment variables to customize its behavior. You can configure these variables in your docker compose env field or through your deployment environment.
Basic Configuration
| Variable | Description | Default | Example |
|---|---|---|---|
PORT | Server port | 12345 | 3000 |
JWT_SECRET | Secret for JWT tokens | Random Text | your-secret-key |
ALLOW_REGISTER | Enable user registration | false | true |
ALLOW_OPENAPI | Enable OpenAPI access | true | false |
WEBSITE_ID | Website identifier | - | your-website-id |
DISABLE_AUTO_CLEAR | Disable automatic data cleanup | false | true |
DISABLE_ACCESS_LOGS | Disable access logs | false | true |
DB_DEBUG | Enable database debugging | false | true |
Authentication
| Variable | Description | Default | Example |
|---|---|---|---|
DISABLE_ACCOUNT | Disable account-based authentication | false | true |
AUTH_SECRET | Authentication secret | MD5 of JWT secret | your-auth-secret |
AUTH_RESTRICT_EMAIL | Restrict registration to specific email domains | - | @example.com |
Email Authentication
| Variable | Description | Default | Example |
|---|---|---|---|
EMAIL_SERVER | SMTP server for email | - | smtp://user:pass@smtp.example.com:587 |
EMAIL_FROM | Email sender address | - | noreply@example.com |
GitHub Authentication
| Variable | Description | Default | Example |
|---|---|---|---|
AUTH_GITHUB_ID | GitHub OAuth client ID | - | your-github-client-id |
AUTH_GITHUB_SECRET | GitHub OAuth client secret | - | your-github-client-secret |
Google Authentication
| Variable | Description | Default | Example |
|---|---|---|---|
AUTH_GOOGLE_ID | Google OAuth client ID | - | your-google-client-id |
AUTH_GOOGLE_SECRET | Google OAuth client secret | - | your-google-client-secret |
Custom OAuth/OIDC Authentication
| Variable | Description | Default | Example |
|---|---|---|---|
AUTH_CUSTOM_ID | Custom OAuth/OIDC client ID | - | your-custom-client-id |
AUTH_CUSTOM_SECRET | Custom OAuth/OIDC client secret | - | your-custom-client-secret |
AUTH_CUSTOM_NAME | Custom provider name | Custom | Enterprise SSO |
AUTH_CUSTOM_TYPE | Authentication type | oidc | oauth |
AUTH_CUSTOM_ISSUR | OIDC issuer URL | - | https://auth.example.com |
AI Features
| Variable | Description | Default | Example |
|---|---|---|---|
OPENAI_API_KEY | OpenAI API key | - | your-openai-api-key |
OPENAI_BASE_URL | Custom OpenAI API URL | - | https://api.openai.com/v1 |
OPENAI_MODEL_NAME | OpenAI model to use | gpt-4o | gpt-3.5-turbo |
DEBUG_AI_FEATURE | Debug AI features | false | true |
Sandbox Configuration
| Variable | Description | Default | Example |
|---|---|---|---|
USE_VM2 | Use VM2 for sandbox execution | false | true |
SANDBOX_MEMORY_LIMIT | Memory limit for sandbox (MB) | 16 | 32 |
PUPPETEER_EXECUTABLE_PATH | Custom path to Puppeteer executable | - | /usr/bin/chromium |
Maps Integration
| Variable | Description | Default | Example |
|---|---|---|---|
AMAP_TOKEN | AMap (Gaode) API token | - | your-amap-token |
MAPBOX_TOKEN | Mapbox API token | - | your-mapbox-token |
Telemetry
| Variable | Description | Default | Example |
|---|---|---|---|
DISABLE_ANONYMOUS_TELEMETRY | Disable anonymous telemetry | false | true |
CUSTOM_TRACKER_SCRIPT_NAME | Custom tracker script name | - | custom-tracker.js |
Setting Environment Variables
You can set these environment variables in different ways:
-
Set them directly in your deployment environment (Docker, Kubernetes, etc.)
-
For Docker deployments, you can use environment variables in your docker-compose.yml:
services:
tianji:
image: moonrailgun/tianji:latest
environment:
- PORT=3000
- ALLOW_REGISTER=true
Boolean Values
For boolean environment variables, you can use either "1" or "true" to enable the feature, and either omit the variable or set it to any other value to disable it.