Skip to content

Commit fa3152b

Browse files
committed
docs: add admin UI hide vars to env, docker-compose, charts, schema, and docs
Signed-off-by: Madhav Kandukuri <madhav165@gmail.com>
1 parent 4bfaeca commit fa3152b

File tree

7 files changed

+78
-0
lines changed

7 files changed

+78
-0
lines changed

.env.example

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1195,6 +1195,14 @@ OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
11951195
# Example: MCPGATEWAY_UI_HIDE_HEADER_ITEMS=logout,team_selector
11961196
# MCPGATEWAY_UI_HIDE_HEADER_ITEMS=
11971197

1198+
# Admin-specific UI section/header hiding (separate from non-admin lists above)
1199+
# When unset, admins see all sections. Embedded mode defaults do NOT apply to admins.
1200+
# Same valid values as MCPGATEWAY_UI_HIDE_SECTIONS / MCPGATEWAY_UI_HIDE_HEADER_ITEMS
1201+
# Example: MCPGATEWAY_UI_HIDE_SECTIONS_ADMIN=maintenance
1202+
# MCPGATEWAY_UI_HIDE_SECTIONS_ADMIN=
1203+
# Example: MCPGATEWAY_UI_HIDE_HEADER_ITEMS_ADMIN=theme_toggle
1204+
# MCPGATEWAY_UI_HIDE_HEADER_ITEMS_ADMIN=
1205+
11981206
# Enable bulk import feature for mass tool/resource registration
11991207
# Options: true (default), false
12001208
# Allows importing multiple tools/resources in a single API call

charts/mcp-stack/values.schema.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -740,6 +740,16 @@
740740
"description": "CSV/JSON list of header items to hide (logout, team_selector, user_identity, theme_toggle)",
741741
"default": ""
742742
},
743+
"MCPGATEWAY_UI_HIDE_SECTIONS_ADMIN": {
744+
"type": "string",
745+
"description": "CSV/JSON list of UI sections to hide for admin users. When empty, admins see all sections. Same valid values as MCPGATEWAY_UI_HIDE_SECTIONS.",
746+
"default": ""
747+
},
748+
"MCPGATEWAY_UI_HIDE_HEADER_ITEMS_ADMIN": {
749+
"type": "string",
750+
"description": "CSV/JSON list of header items to hide for admin users. Same valid values as MCPGATEWAY_UI_HIDE_HEADER_ITEMS.",
751+
"default": ""
752+
},
743753
"MCPGATEWAY_ADMIN_API_ENABLED": {
744754
"type": "string",
745755
"enum": ["true", "false"],

charts/mcp-stack/values.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,6 +337,8 @@ mcpContextForge:
337337
MCPGATEWAY_UI_EMBEDDED: "false" # embedded UI mode (hides logout + team selector by default)
338338
MCPGATEWAY_UI_HIDE_SECTIONS: "" # CSV/JSON list of UI sections to hide (e.g. prompts,resources,teams)
339339
MCPGATEWAY_UI_HIDE_HEADER_ITEMS: "" # CSV/JSON list of header items to hide (e.g. logout,team_selector)
340+
MCPGATEWAY_UI_HIDE_SECTIONS_ADMIN: "" # CSV/JSON list of UI sections to hide for admin users (empty = admins see all)
341+
MCPGATEWAY_UI_HIDE_HEADER_ITEMS_ADMIN: "" # CSV/JSON list of header items to hide for admin users
340342

341343
# ─ ToolOps Feature ─
342344
TOOLOPS_ENABLED: "false" # enable ToolOps feature

docker-compose-embedded.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ services:
5050
# ── Embedded UI ──
5151
- MCPGATEWAY_UI_EMBEDDED=true
5252
- MCPGATEWAY_UI_HIDE_SECTIONS=overview,logs,maintenance,mcp-registry,plugins,roots,llm-settings,teams,tokens,users
53+
# Admin users see all sections by default in embedded mode
54+
- MCPGATEWAY_UI_HIDE_SECTIONS_ADMIN=
55+
- MCPGATEWAY_UI_HIDE_HEADER_ITEMS_ADMIN=
5356

5457
# ── CORS & iframe embedding ──
5558
- CORS_ENABLED=true

docker-compose.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,9 @@ services:
296296
# CSV list (or JSON array) of UI sections/header items to hide for embedded contexts
297297
- MCPGATEWAY_UI_HIDE_SECTIONS=
298298
- MCPGATEWAY_UI_HIDE_HEADER_ITEMS=
299+
# Admin-specific UI hide lists (empty = admins see all; embedded defaults skip admins)
300+
- MCPGATEWAY_UI_HIDE_SECTIONS_ADMIN=
301+
- MCPGATEWAY_UI_HIDE_HEADER_ITEMS_ADMIN=
299302
# Security configuration (using defaults)
300303
- ENVIRONMENT=development
301304
- SECURITY_HEADERS_ENABLED=true

docs/docs/config.schema.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1423,6 +1423,22 @@
14231423
"title": "Mcpgateway Ui Hide Header Items",
14241424
"type": "array"
14251425
},
1426+
"mcpgateway_ui_hide_sections_admin": {
1427+
"description": "CSV/JSON list of UI sections to hide for admin users. Same valid values as mcpgateway_ui_hide_sections. When unset, admins see all sections.",
1428+
"items": {
1429+
"type": "string"
1430+
},
1431+
"title": "Mcpgateway Ui Hide Sections Admin",
1432+
"type": "array"
1433+
},
1434+
"mcpgateway_ui_hide_header_items_admin": {
1435+
"description": "CSV/JSON list of header items to hide for admin users. Same valid values as mcpgateway_ui_hide_header_items.",
1436+
"items": {
1437+
"type": "string"
1438+
},
1439+
"title": "Mcpgateway Ui Hide Header Items Admin",
1440+
"type": "array"
1441+
},
14261442
"mcpgateway_bulk_import_enabled": {
14271443
"default": true,
14281444
"title": "Mcpgateway Bulk Import Enabled",

docs/docs/manage/admin-ui-customization.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,42 @@ MCPGATEWAY_UI_EMBEDDED=true
105105

106106
This is equivalent to setting `MCPGATEWAY_UI_HIDE_HEADER_ITEMS=logout,team_selector` but communicates intent more clearly. If both are set, the values are merged.
107107

108+
## Role-Based Visibility
109+
110+
By default, the hide settings above apply to **non-admin users only**. Admin users have separate configuration:
111+
112+
### `MCPGATEWAY_UI_HIDE_SECTIONS_ADMIN`
113+
114+
Comma-separated or JSON list of sections to hide for admin users. Accepts the same values and aliases as `MCPGATEWAY_UI_HIDE_SECTIONS`.
115+
116+
When unset (empty), admins see all sections — even if `MCPGATEWAY_UI_HIDE_SECTIONS` hides sections for non-admins.
117+
118+
```bash
119+
# Admins see everything except maintenance
120+
MCPGATEWAY_UI_HIDE_SECTIONS_ADMIN=maintenance
121+
```
122+
123+
### `MCPGATEWAY_UI_HIDE_HEADER_ITEMS_ADMIN`
124+
125+
Comma-separated or JSON list of header items to hide for admin users.
126+
127+
```bash
128+
MCPGATEWAY_UI_HIDE_HEADER_ITEMS_ADMIN=theme_toggle
129+
```
130+
131+
### Embedded Mode and Admins
132+
133+
When `MCPGATEWAY_UI_EMBEDDED=true`, the automatic hiding of `logout` and `team_selector` **only applies to non-admin users**. Admins retain full header controls unless explicitly configured via `MCPGATEWAY_UI_HIDE_HEADER_ITEMS_ADMIN`.
134+
135+
### Example: Embedded deployment with admin access
136+
137+
```bash
138+
MCPGATEWAY_UI_EMBEDDED=true
139+
MCPGATEWAY_UI_HIDE_SECTIONS=users,teams,tokens,settings
140+
# Admins see everything (default empty = no hiding)
141+
# MCPGATEWAY_UI_HIDE_SECTIONS_ADMIN=
142+
```
143+
108144
## Per-Request Hiding with `?ui_hide=`
109145

110146
For embedded contexts where different pages need different views, use the `?ui_hide=` query parameter:

0 commit comments

Comments
 (0)