|
| 1 | +--- |
| 2 | +description: Guide for adding environment variables to configure user settings |
| 3 | +alwaysApply: false |
| 4 | +--- |
| 5 | + |
| 6 | +# Adding Environment Variable for User Settings |
| 7 | + |
| 8 | +Add server-side environment variables to configure default values for user settings. |
| 9 | + |
| 10 | +**Priority**: User Custom > Server Env Var > Hardcoded Default |
| 11 | + |
| 12 | +## Steps |
| 13 | + |
| 14 | +### 1. Define Environment Variable |
| 15 | + |
| 16 | +Create `src/envs/<domain>.ts`: |
| 17 | + |
| 18 | +```typescript |
| 19 | +import { createEnv } from '@t3-oss/env-nextjs'; |
| 20 | +import { z } from 'zod'; |
| 21 | + |
| 22 | +export const get<Domain>Config = () => { |
| 23 | + return createEnv({ |
| 24 | + server: { |
| 25 | + YOUR_ENV_VAR: z.coerce.number().min(MIN).max(MAX).optional(), |
| 26 | + }, |
| 27 | + runtimeEnv: { |
| 28 | + YOUR_ENV_VAR: process.env.YOUR_ENV_VAR, |
| 29 | + }, |
| 30 | + }); |
| 31 | +}; |
| 32 | + |
| 33 | +export const <domain>Env = get<Domain>Config(); |
| 34 | +``` |
| 35 | + |
| 36 | +### 2. Update Type (Optional) |
| 37 | + |
| 38 | +**Skip this step if the domain field already exists in `GlobalServerConfig`.** |
| 39 | + |
| 40 | +Add to `packages/types/src/serverConfig.ts`: |
| 41 | + |
| 42 | +```typescript |
| 43 | +export interface GlobalServerConfig { |
| 44 | + <domain>?: { |
| 45 | + <settingName>?: <type>; |
| 46 | + }; |
| 47 | +} |
| 48 | +``` |
| 49 | + |
| 50 | +**Prefer reusing existing types** from `packages/types/src/user/settings` with `PartialDeep`: |
| 51 | + |
| 52 | +```typescript |
| 53 | +import { User<Domain>Config } from './user/settings'; |
| 54 | + |
| 55 | +export interface GlobalServerConfig { |
| 56 | + <domain>?: PartialDeep<User<Domain>Config>; |
| 57 | +} |
| 58 | +``` |
| 59 | + |
| 60 | +### 3. Assemble Server Config (Optional) |
| 61 | + |
| 62 | +**Skip this step if the domain field already exists in server config.** |
| 63 | + |
| 64 | +In `src/server/globalConfig/index.ts`: |
| 65 | + |
| 66 | +```typescript |
| 67 | +import { <domain>Env } from '@/envs/<domain>'; |
| 68 | +import { cleanObject } from '@/utils/object'; |
| 69 | + |
| 70 | +export const getServerGlobalConfig = async () => { |
| 71 | + const config: GlobalServerConfig = { |
| 72 | + // ... |
| 73 | + <domain>: cleanObject({ |
| 74 | + <settingName>: <domain>Env.YOUR_ENV_VAR, |
| 75 | + }), |
| 76 | + }; |
| 77 | + return config; |
| 78 | +}; |
| 79 | +``` |
| 80 | + |
| 81 | +If the domain already exists, just add the new field to the existing `cleanObject()`: |
| 82 | + |
| 83 | +```typescript |
| 84 | +<domain>: cleanObject({ |
| 85 | + existingField: <domain>Env.EXISTING_VAR, |
| 86 | + <settingName>: <domain>Env.YOUR_ENV_VAR, // Add this line |
| 87 | +}), |
| 88 | +``` |
| 89 | + |
| 90 | +### 4. Merge to User Store (Optional) |
| 91 | + |
| 92 | +**Skip this step if the domain field already exists in `serverSettings`.** |
| 93 | + |
| 94 | +In `src/store/user/slices/common/action.ts`, add to `serverSettings`: |
| 95 | + |
| 96 | +```typescript |
| 97 | +const serverSettings: PartialDeep<UserSettings> = { |
| 98 | + defaultAgent: serverConfig.defaultAgent, |
| 99 | + <domain>: serverConfig.<domain>, // Add this line |
| 100 | + // ... |
| 101 | +}; |
| 102 | +``` |
| 103 | + |
| 104 | +### 5. Update .env.example |
| 105 | + |
| 106 | +```bash |
| 107 | +# <Description> (range/options, default: X) |
| 108 | +# YOUR_ENV_VAR=<example> |
| 109 | +``` |
| 110 | + |
| 111 | +### 6. Update Documentation |
| 112 | + |
| 113 | +Update both English and Chinese documentation: |
| 114 | +- `docs/self-hosting/environment-variables/basic.mdx` |
| 115 | +- `docs/self-hosting/environment-variables/basic.zh-CN.mdx` |
| 116 | + |
| 117 | +Add new section or subsection with environment variable details (type, description, default, example, range/constraints). |
| 118 | + |
| 119 | +## Type Reuse |
| 120 | + |
| 121 | +**Prefer reusing existing types** from `packages/types/src/user/settings` instead of defining inline types in `serverConfig.ts`. |
| 122 | + |
| 123 | +```typescript |
| 124 | +// ✅ Good - reuse existing type |
| 125 | +import { UserImageConfig } from './user/settings'; |
| 126 | + |
| 127 | +export interface GlobalServerConfig { |
| 128 | + image?: PartialDeep<UserImageConfig>; |
| 129 | +} |
| 130 | + |
| 131 | +// ❌ Bad - inline type definition |
| 132 | +export interface GlobalServerConfig { |
| 133 | + image?: { |
| 134 | + defaultImageNum?: number; |
| 135 | + }; |
| 136 | +} |
| 137 | +``` |
| 138 | + |
| 139 | +## Example: AI_IMAGE_DEFAULT_IMAGE_NUM |
| 140 | + |
| 141 | +```typescript |
| 142 | +// src/envs/image.ts |
| 143 | +export const getImageConfig = () => { |
| 144 | + return createEnv({ |
| 145 | + server: { |
| 146 | + AI_IMAGE_DEFAULT_IMAGE_NUM: z.coerce.number().min(1).max(20).optional(), |
| 147 | + }, |
| 148 | + runtimeEnv: { |
| 149 | + AI_IMAGE_DEFAULT_IMAGE_NUM: process.env.AI_IMAGE_DEFAULT_IMAGE_NUM, |
| 150 | + }, |
| 151 | + }); |
| 152 | +}; |
| 153 | + |
| 154 | +// packages/types/src/serverConfig.ts |
| 155 | +import { UserImageConfig } from './user/settings'; |
| 156 | + |
| 157 | +export interface GlobalServerConfig { |
| 158 | + image?: PartialDeep<UserImageConfig>; |
| 159 | +} |
| 160 | + |
| 161 | +// src/server/globalConfig/index.ts |
| 162 | +image: cleanObject({ |
| 163 | + defaultImageNum: imageEnv.AI_IMAGE_DEFAULT_IMAGE_NUM, |
| 164 | +}), |
| 165 | + |
| 166 | +// src/store/user/slices/common/action.ts |
| 167 | +const serverSettings: PartialDeep<UserSettings> = { |
| 168 | + image: serverConfig.image, |
| 169 | + // ... |
| 170 | +}; |
| 171 | + |
| 172 | +// .env.example |
| 173 | +# AI_IMAGE_DEFAULT_IMAGE_NUM=4 |
| 174 | +``` |
| 175 | + |
0 commit comments