Home

Muximux Wiki

Muximux is a modern, self-hosted web application portal for your homelab. It runs as a single binary, serves on a single port, and stores all configuration in one YAML file. Add your self-hosted applications, organize them into groups, and access them from a unified dashboard with health monitoring, keyboard shortcuts, and a built-in reverse proxy.

Table of Contents

• Installation -- Docker, binary, and building from source
• Getting Started -- First launch, onboarding wizard, and initial setup
• Configuration Reference -- Full config.yaml format and all available options
• Apps -- Adding, configuring, and managing applications
• Built-in Reverse Proxy -- Proxying app traffic through Muximux
• Authentication -- Built-in auth, forward auth, and OIDC
• TLS & HTTPS -- Automatic certificates, custom certificates, and gateway mode
• Navigation & Layout -- Sidebar positions, auto-hide, labels, and display options
• Themes -- Built-in themes, custom themes, and CSS custom properties
• Health Monitoring -- Automatic health checks and status indicators
• Keyboard Shortcuts -- Default shortcuts and custom keybindings
• Icons -- Dashboard Icons, Lucide icons, custom icons, and caching
• Deployment Guide -- Production deployment, reverse proxies, and networking
• Troubleshooting -- Common issues and solutions
• API Reference -- REST API endpoints for programmatic access