mirror of
https://github.com/lobehub/lobehub.git
synced 2026-09-20 04:56:13 +08:00
YuTengjing
191f3fe776
* 📝 docs: fix outdated content across the docs site Audited docs/ against the current codebase and fixed stale content that drifted after major refactors (Clerk/NextAuth → Better Auth, src/server → apps/server, src/{config,envs,locales} → packages/*, model-bank updates). - self-hosting/auth: mark removed NextAuth/Clerk pages with deprecation warnings; fix microsoft/zitadel alias claims and the Logto callback path - environment-variables & advanced: correct wrong defaults (S3_SET_ACL, AI_IMAGE_DEFAULT_IMAGE_NUM, index/proxy URLs), drop non-existent env vars and fictional feature flags, fix OIDC config guidance - development: update refactored paths, Better Auth, .mjs configs, remove the MSW section (msw is not a dependency) - providers & model examples: replace retired model ids with in-bank ones; fix comfyui frontmatter corruption - usage: rename Moderator→Orchestrator, GTD→Task, correct shortcut keys, channel capability tables, Feishu/Lark WebSocket mode - platform/migration: fix dead links, docker service name, npx/npm → bun EN and zh-CN pairs updated together. * 📝 docs: fix Logto callback path and AUTH_SECRET deprecation guidance - Revert Logto/Sealos callback URLs to /api/auth/callback/logto to match the runtime SSO redirectURI override - Narrow legacy auth Callout: AUTH_SECRET remains required for Better Auth; mark NEXT_AUTH_SECRET as deprecated in zh-CN * 📝 docs: refresh agent skills for locales, env, auth, and agentRun paths Align OSS agent guidance with post-refactor layout: - packages/locales/src/default + bun run i18n - packages/env/src for env schemas (@/envs alias) - spa-auth shell + src/routes/auth segments - chat agentRun/transports/hetero instead of aiChat * 📝 docs: document APP_URL as required for Better Auth base URL Self-hosted auth uses appEnv.APP_URL as baseURL, not request-header auto-detection. NEXT_PUBLIC_AUTH_URL remains deprecated. * 📝 docs: note self-host search provider setup for web search Built-in lobe-web-browsing needs no client plugin, but self-hosted servers still require SEARCH_PROVIDERS / SEARXNG_URL (default SearXNG). * 📝 docs: point feature guide welcome UI at AgentHome Opening message/questions on the agent chat page live in src/features/AgentHome, not Onboarding WelcomeMessage.
56 lines
4.5 KiB
Plaintext
56 lines
4.5 KiB
Plaintext
---
|
|
title: LobeHub Feature Flags Environment Variables Configuration Guide
|
|
description: >-
|
|
Learn how to use environment variables to customize LobeHub's feature flags,
|
|
including controlling whether a feature is enabled or disabled, or enabling or
|
|
disabling features for specific user groups or environments as needed.
|
|
tags:
|
|
- LobeHub
|
|
- Environment Variables
|
|
- Configuration Guide
|
|
- Feature Flags
|
|
---
|
|
|
|
# Feature Flags
|
|
|
|
In addition to basic environment variable configuration, LobeHub also offers feature flags to control whether a feature is enabled globally, or to enable or disable features for specific user groups or environments as needed.
|
|
|
|
## Feature Flags Environment Variable `FEATURE_FLAGS`
|
|
|
|
- Type: Optional
|
|
- Description: Used to control LobeHub's feature functionalities. Supports multiple feature flags, using `+` to add a feature and `-` to disable a feature. Separate multiple feature flags with a comma `,` and enclose the entire value in quotes `"` to avoid parsing errors.
|
|
- Default: `-`
|
|
- Example: `"-welcome_suggest"`
|
|
|
|
All features are controlled by the `FEATURE_FLAGS` variable as the sole configuration variable.
|
|
|
|
You can achieve various feature combinations using the above configuration syntax. All feature flags are Boolean values, enabled with `+` and disabled with `-`.
|
|
|
|
<Callout type={'tip'}>
|
|
Attention: Unlike the `OPENAI_MODEL_LIST` variable, the `FEATURE_FLAGS` variable does not support
|
|
the `all` keyword. You need to manually control all feature flags (otherwise, they will adopt
|
|
their default values).
|
|
</Callout>
|
|
|
|
| Configuration Item | Description | Default Value |
|
|
| ------------------------ | -------------------------------------------------------------------------------------------------------- | ------------- |
|
|
| `check_updates` | Allows checking for updates. | Enabled |
|
|
| `provider_settings` | Controls model provider settings display. | Enabled |
|
|
| `openai_api_key` | Allows users to customize the OpenAI API Key. | Enabled |
|
|
| `openai_proxy_url` | Allows users to customize the OpenAI proxy URL. | Enabled |
|
|
| `api_key_manage` | Controls access to API key management page (/profile/apikey). | Disabled |
|
|
| `edit_agent` | Allows users to edit assistants. | Enabled |
|
|
| `ai_image` | Controls AI image generation feature and page (/image). | Enabled |
|
|
| `speech_to_text` | Enables speech-to-text functionality. | Enabled |
|
|
| `token_counter` | Reserved for token counter display. | Enabled |
|
|
| `welcome_suggest` | Displays welcome suggestions. | Enabled |
|
|
| `changelog` | Controls changelog modal/page display. | Enabled |
|
|
| `market` | Enables the assistant market functionality. | Enabled |
|
|
| `knowledge_base` | Enables the knowledge base functionality. | Enabled |
|
|
| `rag_eval` | Controls RAG evaluation feature (/repos/\[id]/evals). | Disabled |
|
|
| `cloud_promotion` | Controls cloud service promotion link display in user menu. | Disabled |
|
|
| `commercial_hide_github` | Hides GitHub-related links in settings footer (requires commercial license). | Disabled |
|
|
| `commercial_hide_docs` | Hides documentation and help menu including changelog, docs, and feedback (requires commercial license). | Disabled |
|
|
|
|
You can always check the [featureFlags](https://github.com/lobehub/lobehub/blob/main/packages/app-config/src/featureFlags/schema.ts) to get the latest list of feature flags.
|