Skip to content

Commit afc93e9

Browse files
committed
docs: update environment document
1 parent 0c0da21 commit afc93e9

File tree

2 files changed

+40
-19
lines changed

2 files changed

+40
-19
lines changed

website/docs/environment.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

website/docs/install/environment.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@ Tianji supports various environment variables to customize its behavior. You can
1818
| `DISABLE_AUTO_CLEAR` | Disable automatic data cleanup | `false` | `true` |
1919
| `DISABLE_ACCESS_LOGS` | Disable access logs | `false` | `true` |
2020
| `DB_DEBUG` | Enable database debugging | `false` | `true` |
21+
| `ALPHA_MODE` | Enable alpha features | `false` | `true` |
22+
| `ENABLE_FUNCTION_WORKER` | Enable function worker | `false` | `true` |
23+
| `REGISTER_AUTO_JOIN_WORKSPACE_ID` | Auto-join workspace ID for new users | - | `workspace-id-123` |
24+
25+
## Cache Configuration
26+
27+
| Variable | Description | Default | Example |
28+
| --- | --- | --- | --- |
29+
| `CACHE_MEMORY_ONLY` | Use memory-only caching | `false` | `true` |
30+
| `REDIS_URL` | Redis connection URL | - | `redis://localhost:6379` |
2131

2232
## Authentication
2333

@@ -26,6 +36,7 @@ Tianji supports various environment variables to customize its behavior. You can
2636
| `DISABLE_ACCOUNT` | Disable account-based authentication | `false` | `true` |
2737
| `AUTH_SECRET` | Authentication secret | MD5 of JWT secret | `your-auth-secret` |
2838
| `AUTH_RESTRICT_EMAIL` | Restrict registration to specific email domains | - | `@example.com` |
39+
| `AUTH_USE_SECURE_COOKIES` | Use secure cookies for authentication | `false` | `true` |
2940

3041
### Email Authentication and Email Invitation
3142

@@ -65,8 +76,37 @@ Tianji supports various environment variables to customize its behavior. You can
6576
| `SHARED_OPENAI_API_KEY` | OpenAI API key | - | `your-openai-api-key` |
6677
| `SHARED_OPENAI_BASE_URL` | Custom OpenAI API URL | - | `https://api.openai.com/v1` |
6778
| `SHARED_OPENAI_MODEL_NAME` | OpenAI model to use | `gpt-4o` | `gpt-3.5-turbo` |
79+
| `SHARED_OPENAI_TOKEN_CALC_CONCURRENCY` | Token calculation concurrency | `5` | `10` |
6880
| `DEBUG_AI_FEATURE` | Debug AI features | `false` | `true` |
6981

82+
## ClickHouse Configuration
83+
84+
| Variable | Description | Default | Example |
85+
| --- | --- | --- | --- |
86+
| `CLICKHOUSE_URL` | ClickHouse database URL | - | `http://localhost:8123` |
87+
| `CLICKHOUSE_USER` | ClickHouse username | - | `default` |
88+
| `CLICKHOUSE_PASSWORD` | ClickHouse password | - | `your-password` |
89+
| `CLICKHOUSE_DATABASE` | ClickHouse database name | - | `tianji` |
90+
| `CLICKHOUSE_DEBUG` | Enable ClickHouse debugging | `false` | `true` |
91+
| `CLICKHOUSE_DISABLE_SYNC` | Disable ClickHouse synchronization | `false` | `true` |
92+
| `CLICKHOUSE_SYNC_BATCH_SIZE` | Synchronization batch size | `10000` | `5000` |
93+
| `CLICKHOUSE_ENABLE_FALLBACK` | Enable ClickHouse fallback | `true` | `false` |
94+
| `CLICKHOUSE_HEALTH_CHECK_INTERVAL` | Health check interval (ms) | `30000` | `60000` |
95+
| `CLICKHOUSE_MAX_CONSECUTIVE_FAILURES` | Maximum consecutive failures | `3` | `5` |
96+
| `CLICKHOUSE_RETRY_INTERVAL` | Retry interval (ms) | `5000` | `10000` |
97+
98+
## Billing System (LemonSqueezy)
99+
100+
| Variable | Description | Default | Example |
101+
| --- | --- | --- | --- |
102+
| `ENABLE_BILLING` | Enable billing functionality | `false` | `true` |
103+
| `LEMON_SQUEEZY_SIGNATURE_SECRET` | LemonSqueezy webhook signature secret | - | `your-signature-secret` |
104+
| `LEMON_SQUEEZY_API_KEY` | LemonSqueezy API key | - | `your-api-key` |
105+
| `LEMON_SQUEEZY_STORE_ID` | LemonSqueezy store ID | - | `your-store-id` |
106+
| `LEMON_SQUEEZY_SUBSCRIPTION_FREE_ID` | Free tier subscription variant ID | - | `free-variant-id` |
107+
| `LEMON_SQUEEZY_SUBSCRIPTION_PRO_ID` | Pro tier subscription variant ID | - | `pro-variant-id` |
108+
| `LEMON_SQUEEZY_SUBSCRIPTION_TEAM_ID` | Team tier subscription variant ID | - | `team-variant-id` |
109+
70110
## Sandbox Configuration
71111

72112
| Variable | Description | Default | Example |

0 commit comments

Comments
 (0)