You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Added a new 'Access Control' page detailing LibreChat's granular authorization system, including feature permissions, resource ACLs, and system grants.
- Introduced the 'Admin Panel' documentation, outlining its functionalities for managing users, groups, roles, and configuration overrides.
- Updated existing feature documentation (agents, MCP servers) to reflect the new access control model and emphasize the use of the Admin Panel for permission management.
- Marked several YAML fields as deprecated for permission management, recommending the Admin Panel for ongoing management.
Several fields below (`mcpServers`, `prompts`, `bookmarks`, `memories`, `multiConvo`, `agents`, `remoteAgents`, `temporaryChat`, `runCode`, `webSearch`, `fileSearch`, `fileCitations`, `peoplePicker`, `marketplace`) don't just toggle UI, they seed role permissions in the database at startup, and only for the built-in `USER` role.
41
+
42
+
For ongoing management, use the [**LibreChat Admin Panel**](/docs/features/admin_panel), which edits the permission matrix directly on each role (including custom roles). These YAML fields remain supported for bootstrapping a fresh instance or fully file-driven deployments, but should no longer be used as the primary way to manage feature permissions.
43
+
44
+
See [Access Control](/docs/features/access_control) for the full permission model.
45
+
</Callout>
46
+
39
47
## Example
40
48
41
49
```yaml filename="interface"
@@ -85,6 +93,8 @@ interface:
85
93
86
94
## mcpServers
87
95
96
+
> **Deprecated for permission management.** The `use`, `create`, `share`, and `public` sub-keys seed role permissions at startup. Prefer the [Admin Panel](/docs/features/admin_panel) for managing MCP server permissions per role/group/user. The `placeholder` and `trustCheckbox` sub-keys are unaffected.
97
+
88
98
**Key:**
89
99
<OptionTable
90
100
options={[
@@ -223,6 +233,8 @@ interface:
223
233
224
234
## prompts
225
235
236
+
> **Deprecated for permission management.** Seeds the `PROMPTS` role permissions at startup for the default `USER` role only. Prefer the [Admin Panel](/docs/features/admin_panel) for managing prompt permissions per role/group/user.
237
+
226
238
**Key:**
227
239
<OptionTable
228
240
options={[
@@ -277,6 +289,8 @@ interface:
277
289
278
290
## bookmarks
279
291
292
+
> **Deprecated for permission management.** Seeds the `BOOKMARKS` role permission at startup for the default `USER` role only. Prefer the [Admin Panel](/docs/features/admin_panel).
293
+
280
294
**Key:**
281
295
<OptionTable
282
296
options={[
@@ -294,6 +308,8 @@ interface:
294
308
295
309
## memories
296
310
311
+
> **Deprecated for permission management.** Seeds the `MEMORIES` role permissions at startup for the default `USER` role only. Prefer the [Admin Panel](/docs/features/admin_panel). Note this toggle is separate from the [`memory`](/docs/configuration/librechat_yaml/object_structure/memory) behavior configuration.
312
+
297
313
**Key:**
298
314
<OptionTable
299
315
options={[
@@ -313,6 +329,8 @@ interface:
313
329
314
330
## multiConvo
315
331
332
+
> **Deprecated for permission management.** Seeds the `MULTI_CONVO` role permission at startup for the default `USER` role only. Prefer the [Admin Panel](/docs/features/admin_panel).
333
+
316
334
**Key:**
317
335
<OptionTable
318
336
options={[
@@ -332,6 +350,8 @@ interface:
332
350
333
351
More info on [Agents](/docs/features/agents)
334
352
353
+
> **Deprecated for permission management.** Seeds the `AGENTS` role permissions at startup for the default `USER` role only. Prefer the [Admin Panel](/docs/features/admin_panel) for managing agent permissions per role/group/user.
354
+
335
355
**Key:**
336
356
<OptionTable
337
357
options={[
@@ -388,6 +408,8 @@ interface:
388
408
389
409
Controls access to the Agents API (OpenAI-compatible and Open Responses API endpoints), which allows external applications to interact with LibreChat agents programmatically via API keys.
390
410
411
+
> **Deprecated for permission management.** Seeds the `REMOTE_AGENTS` role permissions at startup for the default `USER` role only. Prefer the [Admin Panel](/docs/features/admin_panel).
412
+
391
413
**Key:**
392
414
<OptionTable
393
415
options={[
@@ -423,6 +445,8 @@ interface:
423
445
424
446
Controls whether the temporary chat feature is available to users. Temporary chats are not saved to conversation history and are automatically deleted after a configurable retention period.
425
447
448
+
> **Deprecated for permission management.** Seeds the `TEMPORARY_CHAT` role permission at startup for the default `USER` role only. Prefer the [Admin Panel](/docs/features/admin_panel). `temporaryChatRetention` below is not a permission and remains the recommended way to configure retention.
449
+
426
450
**Key:**
427
451
<OptionTable
428
452
options={[
@@ -500,6 +524,8 @@ Enables/disables the "Run Code" button for Markdown Code Blocks. More info on th
500
524
501
525
**Note:** This setting does not disable the [Agents Code Interpreter Capability](/docs/features/agents#code-interpreter). To disable the Agents Capability, see the [Agents Endpoint configuration](/docs/configuration/librechat_yaml/object_structure/agents) instead.
502
526
527
+
> **Deprecated for permission management.** Seeds the `RUN_CODE` role permission at startup for the default `USER` role only. Prefer the [Admin Panel](/docs/features/admin_panel).
528
+
503
529
**Key:**
504
530
<OptionTable
505
531
options={[
@@ -521,6 +547,8 @@ Enables/disables the web search button in the chat interface. More info on [Web
521
547
522
548
**Note:** This setting does not disable the [Agents Web Search Capability](/docs/features/agents#web-search). To disable the Agents Capability, see the [Agents Endpoint configuration](/docs/configuration/librechat_yaml/object_structure/agents) instead.
523
549
550
+
> **Deprecated for permission management.** Seeds the `WEB_SEARCH` role permission at startup for the default `USER` role only. Prefer the [Admin Panel](/docs/features/admin_panel).
551
+
524
552
**Key:**
525
553
<OptionTable
526
554
options={[
@@ -542,6 +570,8 @@ Enables/disables the file search (for RAG API usage via tool) button in the chat
542
570
543
571
**Note:** This setting does not disable the [Agents File Search Capability](/docs/features/agents#file-search). To disable the Agents Capability, see the [Agents Endpoint configuration](/docs/configuration/librechat_yaml/object_structure/agents) instead.
544
572
573
+
> **Deprecated for permission management.** Seeds the `FILE_SEARCH` role permission at startup for the default `USER` role only. Prefer the [Admin Panel](/docs/features/admin_panel).
574
+
545
575
**Key:**
546
576
<OptionTable
547
577
options={[
@@ -561,6 +591,8 @@ interface:
561
591
562
592
Controls the global availability of file citations functionality. When disabled, it effectively removes the `FILE_CITATIONS` permission for all users, preventing any file citations from being displayed when using file search, regardless of individual user permissions.
563
593
594
+
> **Deprecated for permission management.** Seeds/globally gates the `FILE_CITATIONS` role permission at startup. Prefer the [Admin Panel](/docs/features/admin_panel) for managing citations permissions per role/group/user.
595
+
564
596
**Note:**
565
597
- This setting acts as a global toggle for the `FILE_CITATIONS` permission system-wide.
566
598
- When set to `false`, no users will see file citations, even if they have been granted the permission through roles.
@@ -586,6 +618,8 @@ interface:
586
618
587
619
Controls which principal types (users, groups, roles) are available for selection in the people picker interface, typically used when sharing agents or managing access controls.
588
620
621
+
> **Deprecated for permission management.** Seeds the `PEOPLE_PICKER` role permissions at startup for the default `USER` role only. Prefer the [Admin Panel](/docs/features/admin_panel).
622
+
589
623
**Key:**
590
624
<OptionTable
591
625
options={[
@@ -624,6 +658,8 @@ interface:
624
658
625
659
Enables/disables access to the Agent Marketplace.
626
660
661
+
> **Deprecated for permission management.** Seeds the `MARKETPLACE` role permission at startup for the default `USER` role only. Prefer the [Admin Panel](/docs/features/admin_panel).
0 commit comments