mantrae/README.md

Mantræ

Mantræ is a web-based configuration manager for Traefik's dynamic configuration file. It provides a clean, intuitive interface to manage your routers, middleware, and services without editing YAML or TOML files manually.

Important

: Mantræ is not a dashboard for Traefik. It operates independently and does not monitor Traefik's status. Instead, Traefik connects to Mantræ to fetch its dynamic configuration.

Features

• 🎨 Clean Interface: Manage your Traefik configuration through a simple web UI
• 🔀 Router Management: Create and configure routers with custom rules, entrypoints, and middleware
• ⚙️ Middleware Support: Add rate limiting, authentication, headers, and other middleware
• 🏷️ Agent Mode: Label your containers with standard Traefik labels and let the agent automatically sync them
• 🌐 DNS Integration: Automatic DNS record management for Cloudflare, PowerDNS, and Technitium

How It Works

Mantræ generates and serves Traefik's dynamic configuration file. Configure Traefik to fetch its configuration from Mantræ's HTTP provider endpoint, and your changes will be applied automatically.

🚧 Development Status

This project is in active development and not yet production-ready. Expect breaking changes before the first stable release.

Quick Start

Installation

Using the install script:

curl -fsSL https://raw.githubusercontent.com/mizuchilabs/mantrae/main/install.sh | sh

Manual installation: Download the latest release from releases and extract to ~/.local/bin.

Docker (recommended for production): See the documentation for Docker setup instructions.

Usage

# Start the server
mantrae

# Display version
mantrae --version

# Check for updates
mantrae update

# Update to latest version (not available in Docker)
mantrae update --install

# Reset admin password
mantrae reset --password newpassword

# Reset password for a specific user
mantrae reset --user username --password newpassword

Command Reference

Command	Description
mantrae	Start the Mantræ server
mantrae update	Check for available updates
mantrae update --install	Download and install the latest version
mantrae reset	Reset user password (admin by default)
mantrae --version	Display version information

Flags

Flag	Aliases	Default	Description
--version	-v		Display version and exit
--password	-p		New password (used with reset)
--user	-u	admin	Username for password reset
--install		false	Install update (used with update command)

Documentation

Full documentation is available here

Screenshot

Contributing

Contributions are welcome! Feel free to submit issues, fork the repository, and create pull requests.

License

MIT License - See LICENSE

Acknowledgements

• Traefik - The powerful reverse proxy that this project manages
• Nginx Proxy Manager - Inspiration for the UI approach
• External-DNS - Inspiration for DNS management