OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-19 10:52:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add environment variable references to permissions documentation

Browse Source
This commit is contained in:
Taylor Wilsdon 2025-02-26 12:25:33 -05:00
parent 3d06bde8c6
commit 9b66637de9
1 changed files with 28 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
docs/features/workspace/permissions.md
View File

@ -5,57 +5,59 @@ title: "🔒 Permissions"
The `Permissions` section of the `Workspace` within Open WebUI allows administrators to configure access controls and feature availability for users. This powerful system enables fine-grained control over what users can access and modify within the application. The `Permissions` section of the `Workspace` within Open WebUI allows administrators to configure access controls and feature availability for users. This powerful system enables fine-grained control over what users can access and modify within the application.
### Workspace Permissions ## Workspace Permissions
Workspace permissions control access to core components of the Open WebUI platform: Workspace permissions control access to core components of the Open WebUI platform:
* **Models Access**: Toggle to allow users to access and manage custom models. * **Models Access**: Toggle to allow users to access and manage custom models. (Environment variable: `USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS`)
* **Knowledge Access**: Toggle to allow users to access and manage knowledge bases. * **Knowledge Access**: Toggle to allow users to access and manage knowledge bases. (Environment variable: `USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS`)
* **Prompts Access**: Toggle to allow users to access and manage saved prompts. * **Prompts Access**: Toggle to allow users to access and manage saved prompts. (Environment variable: `USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS`)
* **Tools Access**: Toggle to allow users to access and manage tools. *Note: Enabling this gives users the ability to upload arbitrary code to the server.* * **Tools Access**: Toggle to allow users to access and manage tools. (Environment variable: `USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS`) *Note: Enabling this gives users the ability to upload arbitrary code to the server.*
* **Public Sharing**: Toggle to allow users to share content publicly from their workspace. * **Public Sharing**: Toggle to allow users to share content publicly from their workspace.
### Chat Permissions ## Chat Permissions
Chat permissions determine what actions users can perform within chat conversations: Chat permissions determine what actions users can perform within chat conversations:
* **Allow Chat Controls**: Toggle to enable access to chat control options. * **Allow Chat Controls**: Toggle to enable access to chat control options.
* **Allow File Upload**: Toggle to permit users to upload files during chat sessions. * **Allow File Upload**: Toggle to permit users to upload files during chat sessions. (Environment variable: `USER_PERMISSIONS_CHAT_FILE_UPLOAD`)
* **Allow Chat Delete**: Toggle to permit users to delete chat conversations. * **Allow Chat Delete**: Toggle to permit users to delete chat conversations. (Environment variable: `USER_PERMISSIONS_CHAT_DELETE`)
* **Allow Chat Edit**: Toggle to permit users to edit messages in chat conversations. * **Allow Chat Edit**: Toggle to permit users to edit messages in chat conversations. (Environment variable: `USER_PERMISSIONS_CHAT_EDIT`)
* **Allow Temporary Chat**: Toggle to permit users to create temporary chat sessions. * **Allow Temporary Chat**: Toggle to permit users to create temporary chat sessions. (Environment variable: `USER_PERMISSIONS_CHAT_TEMPORARY`)
### Features Permissions ## Features Permissions
Features permissions control access to specialized capabilities within Open WebUI: Features permissions control access to specialized capabilities within Open WebUI:
* **Web Search**: Toggle to allow users to perform web searches during chat sessions. * **Web Search**: Toggle to allow users to perform web searches during chat sessions. (Environment variable: `ENABLE_RAG_WEB_SEARCH`)
* **Image Generation**: Toggle to allow users to generate images. * **Image Generation**: Toggle to allow users to generate images. (Environment variable: `ENABLE_IMAGE_GENERATION`)
* **Code Interpreter**: Toggle to allow users to use the code interpreter feature. * **Code Interpreter**: Toggle to allow users to use the code interpreter feature.
### Default Permission Settings ## Default Permission Settings
By default, Open WebUI applies the following permission settings: By default, Open WebUI applies the following permission settings:
**Workspace Permissions**: **Workspace Permissions**:
- Models Access: Disabled - Models Access: Disabled (`USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS=False`)
- Knowledge Access: Disabled - Knowledge Access: Disabled (`USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS=False`)
- Prompts Access: Disabled - Prompts Access: Disabled (`USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS=False`)
- Tools Access: Disabled - Tools Access: Disabled (`USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS=False`)
- Public Sharing: Enabled - Public Sharing: Enabled
**Chat Permissions**: **Chat Permissions**:
- Allow Chat Controls: Enabled - Allow Chat Controls: Enabled
- Allow File Upload: Enabled - Allow File Upload: Enabled (`USER_PERMISSIONS_CHAT_FILE_UPLOAD=True`)
- Allow Chat Delete: Enabled - Allow Chat Delete: Enabled (`USER_PERMISSIONS_CHAT_DELETE=True`)
- Allow Chat Edit: Enabled - Allow Chat Edit: Enabled (`USER_PERMISSIONS_CHAT_EDIT=True`)
- Allow Temporary Chat: Enabled - Allow Temporary Chat: Enabled (`USER_PERMISSIONS_CHAT_TEMPORARY=True`)
**Features Permissions**: **Features Permissions**:
- Web Search: Enabled - Web Search: Enabled (`ENABLE_RAG_WEB_SEARCH=True`)
- Image Generation: Enabled - Image Generation: Enabled (`ENABLE_IMAGE_GENERATION=True`)
- Code Interpreter: Enabled - Code Interpreter: Enabled
### Managing Permissions ## Managing Permissions
Administrators can adjust these permissions through the user interface to create appropriate access levels for different user groups or scenarios. This flexibility allows organizations to implement security policies while still providing users with the tools they need. Administrators can adjust these permissions through the user interface or by setting the corresponding environment variables in the configuration. All permission-related environment variables are marked as `PersistentConfig` variables, meaning they are stored internally after the first launch and can be managed through the Open WebUI interface.
This flexibility allows organizations to implement security policies while still providing users with the tools they need. For more detailed information about environment variables related to permissions, see the [Environment Variable Configuration](../../getting-started/env-configuration.md#workspace-permissions) documentation.