Skip to content

Commit 8d60fc9

Browse files
danciaclaradanciaclara
authored
Merge pull request #235 from makeplane/remove-code-blocks-variable-names
Remove code blocks variable names
2 parents 9f502fd + 654a54a commit 8d60fc9

1 file changed

Lines changed: 32 additions & 32 deletions

File tree

‎docs/self-hosting/govern/environment-variables.md‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -179,53 +179,53 @@ This is where you'll make all configuration changes. Remember to restart the ins
179179

180180
To start Plane AI services, set each replica count to `1`:
181181

182-
| Variable | Description | Required |
183-
| ---------------------- | ---------------------------------- | -------- |
184-
| `PI_API_REPLICAS` | Plane AI API replica count | Yes |
185-
| `PI_BEAT_REPLICAS` | Plane AI Beat Worker replica count | Yes |
186-
| `PI_WORKER_REPLICAS` | Plane AI Worker replica count | Yes |
187-
| `PI_MIGRATOR_REPLICAS` | Plane AI Migrator replica count | Yes |
182+
| Variable | Description | Required |
183+
| ------------------------ | ---------------------------------- | -------- |
184+
| **PI_API_REPLICAS** | Plane AI API replica count | Yes |
185+
| **PI_BEAT_REPLICAS** | Plane AI Beat Worker replica count | Yes |
186+
| **PI_WORKER_REPLICAS** | Plane AI Worker replica count | Yes |
187+
| **PI_MIGRATOR_REPLICAS** | Plane AI Migrator replica count | Yes |
188188

189189
#### LLM provider API keys
190190

191191
Plane AI supports multiple LLM providers. Configure one or more by adding their API keys.
192192

193-
| Variable | Description | Required |
194-
| ------------------------ | --------------------------------------------------------------- | -------- |
195-
| `OPENAI_API_KEY` | API key for OpenAI models | Optional |
196-
| `CLAUDE_API_KEY` | API key for Anthropic models | Optional |
197-
| `GROQ_API_KEY` | API key for speech-to-text features | Optional |
198-
| `CUSTOM_LLM_ENABLED` | Set to `true` to use a custom LLM with an OpenAI-compatible API | Optional |
199-
| `CUSTOM_LLM_MODEL_KEY` | Identifier key for the custom model | Optional |
200-
| `CUSTOM_LLM_BASE_URL` | Base URL of the custom model's OpenAI-compatible endpoint | Optional |
201-
| `CUSTOM_LLM_API_KEY` | API key for the custom endpoint | Optional |
202-
| `CUSTOM_LLM_NAME` | Display name for the custom model | Optional |
203-
| `CUSTOM_LLM_DESCRIPTION` | Description of the custom model | Optional |
204-
| `CUSTOM_LLM_MAX_TOKENS` | Maximum token limit for the custom model | Optional |
193+
| Variable | Description | Required |
194+
| -------------------------- | --------------------------------------------------------------- | -------- |
195+
| **OPENAI_API_KEY** | API key for OpenAI models | Optional |
196+
| **CLAUDE_API_KEY** | API key for Anthropic models | Optional |
197+
| **GROQ_API_KEY** | API key for speech-to-text features | Optional |
198+
| **CUSTOM_LLM_ENABLED** | Set to `true` to use a custom LLM with an OpenAI-compatible API | Optional |
199+
| **CUSTOM_LLM_MODEL_KEY** | Identifier key for the custom model | Optional |
200+
| **CUSTOM_LLM_BASE_URL** | Base URL of the custom model's OpenAI-compatible endpoint | Optional |
201+
| **CUSTOM_LLM_API_KEY** | API key for the custom endpoint | Optional |
202+
| **CUSTOM_LLM_NAME** | Display name for the custom model | Optional |
203+
| **CUSTOM_LLM_DESCRIPTION** | Description of the custom model | Optional |
204+
| **CUSTOM_LLM_MAX_TOKENS** | Maximum token limit for the custom model | Optional |
205205

206206
#### Provider base URLs
207207

208208
Use these when routing requests through self-hosted gateways, proxies, or compatible third-party endpoints.
209209

210-
| Variable | Description | Default |
211-
| ----------------- | ------------------------------------------ | --------- |
212-
| `OPENAI_BASE_URL` | Custom base URL for OpenAI-compatible APIs | OpenAI |
213-
| `CLAUDE_BASE_URL` | Custom base URL for Claude-compatible APIs | Anthropic |
214-
| `COHERE_BASE_URL` | Custom base URL for Cohere APIs | Cohere |
215-
| `GROQ_BASE_URL` | Custom base URL for Groq APIs | Groq |
210+
| Variable | Description | Default |
211+
| ------------------- | ------------------------------------------ | --------- |
212+
| **OPENAI_BASE_URL** | Custom base URL for OpenAI-compatible APIs | OpenAI |
213+
| **CLAUDE_BASE_URL** | Custom base URL for Claude-compatible APIs | Anthropic |
214+
| **COHERE_BASE_URL** | Custom base URL for Cohere APIs | Cohere |
215+
| **GROQ_BASE_URL** | Custom base URL for Groq APIs | Groq |
216216

217217
#### Embedding model configuration
218218

219219
These settings are required for semantic search and Plane AI Chat. Configure one of the following options.
220220

221-
| Variable | Description | Required |
222-
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
223-
| `EMBEDDING_MODEL_ID` | ID of an existing embedding model deployed in OpenSearch (works with both self-hosted and AWS OpenSearch) | Conditional |
224-
| `EMBEDDING_MODEL` | Embedding model to automatically deploy (e.g., `cohere/embed-v4.0`, `openai/text-embedding-3-small`, `bedrock/amazon.titan-embed-text-v1`). Self-hosted OpenSearch only. | Conditional |
225-
| `COHERE_API_KEY` | API key for Cohere embedding models | Conditional |
226-
| `BR_AWS_ACCESS_KEY_ID` | AWS access key ID for Bedrock Titan embedding | Conditional |
227-
| `BR_AWS_SECRET_ACCESS_KEY` | AWS secret access key for Bedrock Titan embedding | Conditional |
228-
| `BR_AWS_REGION` | AWS region for Bedrock Titan embedding | Conditional |
221+
| Variable | Description | Required |
222+
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
223+
| **EMBEDDING_MODEL_ID** | ID of an existing embedding model deployed in OpenSearch (works with both self-hosted and AWS OpenSearch) | Conditional |
224+
| **EMBEDDING_MODEL** | Embedding model to automatically deploy (e.g., `cohere/embed-v4.0`, `openai/text-embedding-3-small`, `bedrock/amazon.titan-embed-text-v1`). Self-hosted OpenSearch only. | Conditional |
225+
| **COHERE_API_KEY** | API key for Cohere embedding models | Conditional |
226+
| **BR_AWS_ACCESS_KEY_ID** | AWS access key ID for Bedrock Titan embedding | Conditional |
227+
| **BR_AWS_SECRET_ACCESS_KEY** | AWS secret access key for Bedrock Titan embedding | Conditional |
228+
| **BR_AWS_REGION** | AWS region for Bedrock Titan embedding | Conditional |
229229

230230
For setup instructions, supported models, and IAM permissions, see [Enable Plane AI](/self-hosting/govern/plane-ai).
231231

0 commit comments

Comments
 (0)