Repository navigation
Expand file tree
/
Copy pathconfig.example.yaml
More file actions
311 lines (289 loc) · 15.8 KB
/
Copy pathconfig.example.yaml
File metadata and controls
311 lines (289 loc) · 15.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
# Muximux 3 Configuration Example
# Copy this file to data/config.yaml and customize as needed
#
# Environment variable expansion:
# Use ${VAR_NAME} in any string value to reference environment variables.
# This keeps secrets out of config files - set them in your environment,
# Docker Compose, or systemd unit instead.
# Example: client_secret: ${OIDC_CLIENT_SECRET}
#
# Environment overrides:
# MUXIMUX_LISTEN, MUXIMUX_BASE_PATH, MUXIMUX_LOG_LEVEL, MUXIMUX_LOG_FORMAT,
# MUXIMUX_DISCOVERY_AUTO_IMPORT, MUXIMUX_DISCOVERY_REQUIRE_EXPLICIT_ENABLE,
# MUXIMUX_AUTH_METHOD and MUXIMUX_OIDC_* (with _FILE variants for the client
# ID and secret) override the matching setting below. Overrides apply in
# memory only and are never written back to this file. See the
# Configuration wiki page for the full list.
# ─── Server ─────────────────────────────────────
server:
listen: ":8080" # Listen address (host:port)
title: "Muximux" # Page title shown in browser tab
log_level: info # debug, info, warn, error (hot-reloadable)
log_format: text # text or json
proxy_timeout: 30s # Global timeout for proxied requests
# base_path: /muximux # Subpath when behind a reverse proxy (e.g. /muximux)
# Optional: enable HTTPS on this port
# tls:
# domain: "muximux.example.com" # Auto-HTTPS via Let's Encrypt (requires email)
# email: "admin@example.com" # Let's Encrypt registration email
# # Or bring your own certs (use domain OR cert/key, not both):
# # cert: /path/to/cert.pem
# # key: /path/to/key.pem
# Optional: gateway sites served by the embedded Caddy. Each entry
# gets its own subdomain with optional auto-HTTPS via Let's Encrypt,
# iframe-blocker stripping, custom headers, and (3.1.0+) an optional
# Muximux-login gate. Edit visually in Settings -> Gateway, or by
# hand here. See the Gateway Examples and Gateway Auth Gate wiki
# pages for the full reference.
# gateway_sites:
# - domain: sonarr.example.com
# backend_url: http://192.168.1.5:8989
# tls: auto # auto (Let's Encrypt) | none | custom
# # tls_cert: /path/to/cert.pem # required when tls: custom
# # tls_key: /path/to/key.pem # required when tls: custom
# streaming: false # set true for live-streaming backends
# strip_frame_blockers: true # strip X-Frame-Options for embedding
# forwarded_headers: true # forward X-Forwarded-Proto/Host/Real-IP
# # proxy_headers: {} # extra headers injected on upstream requests
# # require_auth: true # gate this subdomain behind Muximux login
# # min_role: user # "user" / "power-user" / "admin"
# # allowed_groups: [family, admins] # case-insensitive; admins bypass
# Optional: bind the embedded Caddy on an unprivileged port instead
# of :80/:443. Useful when fronting Muximux with another reverse
# proxy (Cloudflare Tunnel, an upstream Traefik) that terminates TLS,
# or when you cannot grant CAP_NET_BIND_SERVICE / run as root.
# Empty = legacy behaviour (:80 + :443 + auto-HTTPS).
# gateway_listen: ":8443"
# Optional: cookie scope for cross-subdomain session sharing.
# Required when any gateway_sites[] entry has require_auth=true,
# otherwise the session cookie won't reach the gated subdomain.
# Leading dot is optional (browsers normalise).
# session_cookie_domain: ".example.com"
# ─── Docker Discovery (3.1.0+) ──────────────────
# Off by default. When enabled, Muximux scans the Docker daemon and
# the Discover modal (Settings -> Discovery) offers to import running
# containers as apps with auto-filled name, icon, port, and URL.
# A background refresh poller keeps imported URLs current as
# container IPs shift across restarts.
# discovery:
# docker:
# enabled: true
# endpoint: unix:///var/run/docker.sock # or tcp://host:2376 for a remote daemon
# network_strategy: container_ip # container_ip | container_dns | host_port | host_docker_internal
# refresh_interval: 60s # how often the poller re-checks tracked apps
# # network_filter: my-stack # only scan containers on this one network (empty = all)
# # host_ip: 192.168.1.10 # required by the host_port strategy
# auto_import: off # off (default) | add | update | sync
# # imports only containers with a muximux.* label
# require_explicit_enable: false # auto-import only containers labelled muximux.app.enabled=true
# # lifecycle_enabled: false # start/stop/restart tracked containers (needs a daemon that accepts writes; :ro does not limit API calls)
# # lifecycle_min_role: admin # minimum role for lifecycle controls
# # lifecycle_allowed_groups: [] # also require one of these user / identity-provider groups
# # health_badge_placement: overview # overview | overview_and_nav | off
# # tls: # only for tcp:// endpoints with mTLS
# # enabled: true
# # ca_cert: /path/to/ca.pem
# # client_cert: /path/to/cert.pem
# # client_key: /path/to/key.pem
# ─── Health Monitoring ──────────────────────────
health:
enabled: true
interval: 30s # How often to check app health
timeout: 5s # Request timeout for each health check
# ─── Authentication ─────────────────────────────
auth:
method: none # none, builtin, forward_auth, oidc
# session_max_age: 24h # How long sessions last (default: 24h)
# secure_cookies: false # Set true when serving over HTTPS
# api_key_hash: "sha256:..." # Optional: SHA-256 hash of API key for X-Api-Key header auth
# Generate with: muximux hash --api-key 'my-api-key'
# (A legacy bcrypt hash is still accepted and auto-upgrades to SHA-256 on first use.)
# ── Builtin auth ──
# users:
# - username: admin
# password_hash: "$2a$10$..." # bcrypt hash (generate with: muximux hash)
# role: admin # admin, power-user, or user
# email: "admin@example.com" # Optional
# display_name: "Admin User" # Optional
# ── Forward auth (Authelia / Authentik / Traefik Forward Auth) ──
# trusted_proxies: # CIDR ranges of your reverse proxy
# - 192.168.0.0/16
# - 172.16.0.0/12
# - 192.168.0.0/16
# headers: # Header names set by your auth proxy (defaults shown)
# user: Remote-User
# email: Remote-Email
# groups: Remote-Groups
# name: Remote-Name # Note: key is "name" not "display_name"
# logout_url: "" # Auth provider logout URL - redirected to on sign-out
# # Authelia: https://auth.example.com/logout
# # Authentik: https://app.example.com/outpost.goauthentik.io/sign_out
# ── OIDC (OpenID Connect) ──
# oidc:
# enabled: true
# issuer_url: https://auth.example.com
# client_id: ${OIDC_CLIENT_ID}
# client_secret: ${OIDC_CLIENT_SECRET}
# redirect_url: https://muximux.example.com/api/auth/oidc/callback
# scopes: [openid, profile, email] # Default scopes
# username_claim: preferred_username # Claim for username (default)
# email_claim: email # Claim for email (default)
# groups_claim: groups # Claim for group membership (default)
# display_name_claim: name # Claim for display name (default)
# admin_groups: [admins] # Groups that grant admin role
# provider_logout: false # End the session at the provider on logout
# post_logout_redirect_url: "" # Default: <origin of redirect_url>/login?logged_out=1 (register at provider)
# logout_url: "" # End-session URL for providers without one in discovery
# auto_redirect: false # Login page goes straight to SSO
# disable_local_login: false # Refuse password sign-in (API keys still work)
# ─── Theme ──────────────────────────────────────
theme:
family: default # default, nord, dracula, catppuccin, solarized,
# tokyo-night, gruvbox, plex, rose-pine
variant: system # dark, light, system (follow OS preference)
# ─── Navigation ─────────────────────────────────
navigation:
position: top # top, left, right, bottom, floating
width: 220px # Sidebar width (left/right positions)
auto_hide: false # Auto-hide navigation after delay
auto_hide_delay: 0.5s # Delay before hiding (requires auto_hide: true)
show_on_hover: true # Show navigation on mouse hover when auto-hidden
show_labels: true # Show app names alongside icons
show_logo: true # Show Muximux logo in navigation
show_app_colors: true # Tint nav items with their app color
show_icon_background: false # Show icon background circles
show_splash_on_startup: false # Show splash screen on first load
dynamic_tab_branding: false # Browser tab shows the active app's name + icon
show_shadow: true # Drop shadow on navigation bar
show_docker_badge: true # Docker whale next to Docker-discovered apps in the nav (admins only)
icon_scale: 1.0 # Icon zoom multiplier (e.g. 1.2 = 20% larger)
bar_style: grouped # grouped (default) or flat (top/bottom bars only)
floating_position: bottom-right # Floating button position (when position: floating)
# bottom-right, bottom-left, top-right, top-left
hide_sidebar_footer: false # Hide the footer section in left/right sidebars
max_open_tabs: 0 # Max app tabs kept alive in memory (0 = unlimited)
# ─── Keyboard Shortcuts ────────────────────────
# Only overrides - defaults are managed client-side.
# keybindings:
# bindings:
# search:
# - key: "k"
# ctrl: true # Modifiers: ctrl, alt, shift, meta (all optional)
# ─── Icons ──────────────────────────────────────
icons:
dashboard_icons:
enabled: true
mode: on_demand # on_demand: fetch when needed
# prefetch: fetch all on startup
# offline: use only cached icons
cache_dir: icons/dashboard # Relative to data directory
cache_ttl: 7d # How long cached icons are valid
# ─── Groups ─────────────────────────────────────
groups:
- name: Media
icon:
type: lucide # lucide, dashboard, custom, url
name: play # Icon name (Lucide icon name or Dashboard Icon slug)
color: "#e5a00d" # Group accent color
order: 1 # Sort order
expanded: true # Whether group starts expanded in sidebar
# docker_managed: true # Set by Docker discovery on groups it creates; muximux.group.*
# # labels apply while set. Editing the icon or colour in Settings clears it.
- name: Downloads
icon:
type: lucide
name: download
color: "#3498db"
order: 2
expanded: true
- name: System
icon:
type: lucide
name: server
color: "#e74c3c"
order: 3
expanded: true
# ─── Applications ───────────────────────────────
apps:
- name: Plex
url: http://localhost:32400
# health_url: "" # Custom health check URL (defaults to app url)
icon:
type: dashboard # Icon types: dashboard, lucide, custom, url
name: plex # Dashboard Icons slug or Lucide icon name
# variant: light # Icon variant (e.g. light, dark - Dashboard Icons only)
# file: healarr # Filename in data/icons/ (type: custom only)
# url: https://example.com/icon.png # Remote image URL (type: url only)
# color: "#ff0000" # Tint color (Lucide icons only)
# background: "#1a1a2e" # Override icon background color
# invert: false # Flip icon colors (dark ↔ light)
color: "#e5a00d" # App accent color
group: Media # Group name (must match a group above)
order: 1 # Sort order within group
enabled: true # Show/hide this app
default: true # Load this app on startup
open_mode: iframe # iframe, new_tab, new_window, redirect
proxy: false # Route through built-in reverse proxy
scale: 1 # Iframe zoom level (1 = 100%)
# health_check: true # Enable health monitoring for this app
# shortcut: 1 # Assign keyboard shortcut (1-9)
# min_role: "" # Minimum role to see this app (user, power-user, admin)
# force_icon_background: false # Show icon background even when global setting is off
# access: # Fine-grained access control
# roles: [] # Roles that can see this app
# users: [] # Usernames that can see this app
# Docker auto-management (set by Discovery on import; editing url
# by hand auto-detaches). Set these to track an app yourself:
# docker_key: "label:sonarr" # stable identifier for the container
# docker_endpoint: unix:///var/run/docker.sock
# docker_strategy: container_ip # container_ip | container_dns | host_port | host_docker_internal
# docker_managed_url, docker_managed_health_check and docker_auto are
# also written by Discovery. They are server-owned: leave them alone.
- name: Sonarr
url: http://localhost:8989
# health_url: http://localhost:8989/ping # Custom health endpoint
icon:
type: dashboard
name: sonarr
color: "#3498db"
group: Downloads
order: 1
enabled: true
open_mode: iframe
proxy: true # Proxy through /proxy/sonarr/ - strips iframe-blocking headers
proxy_skip_tls_verify: true # Skip backend TLS cert verification (default: true)
# proxy_headers: # Custom headers sent to the backend
# X-Api-Key: "your-api-key"
auth_bypass: # Paths that bypass authentication for this proxied app
- path: /api/*
require_api_key: true # Require X-Api-Key header instead
- path: /feed/*
methods: [GET] # Only allow specific HTTP methods
# allowed_ips: # Restrict to specific IPs/CIDRs
# - 192.168.0.0/16
- name: Radarr
url: http://localhost:7878
icon:
type: dashboard
name: radarr
color: "#ffc107"
group: Downloads
order: 2
enabled: true
open_mode: iframe
proxy: true
auth_bypass:
- path: /api/*
require_api_key: true
- name: Portainer
url: http://localhost:9000
icon:
type: dashboard
name: portainer
color: "#13bef9"
group: System
order: 1
enabled: true
open_mode: new_tab # Opens in new browser tab instead of iframe
proxy: false
# min_role: admin # Only visible to admin users