Mantræ

Mantræ is a user-friendly web interface designed to simplify the management of Traefik's dynamic configurations. Similar to Nginx Proxy Manager (NPM), this application allows you to manage your dynamic Traefik configuration from the comfort of a simple web ui.

Features

• Domain Management: Easily manage your domains and assign them to specific hosts via the web interface.
• Router Configuration: Create and manage Traefik routers with custom rules, entrypoints, and middleware configurations.
• Middleware Management: Add middlewares to your routers, including rate limiting, authentication, and more.
• Service Status: Monitor the status of your services and see their health information.
• Simplified UI: A clean and intuitive interface that keeps the complexity to a minimum.

Getting Started

Prerequisites

• Traefik: Ensure you have Traefik set up with a static configuration file that defines your entrypoints, certificates, and any other necessary static settings.
• Docker: Optionally, use Docker for easier deployment.

Installation

1. Download the latest release from the releases page

2. Extract the downloaded file

3. Run the application ./mantrae

4. Access the Web UI: Open your web browser and navigate to http://localhost:3000

5. Or use docker docker run -p 3000:3000 ghcr.io/mizuchilabs/mantrae:latest

6. You can also use the example docker-compose.yml file to run mantrae and traefik together

7. Use the admin password, which will be printed in the logs after the first start

Usage

Managing Routers

1. Navigate to the "Routers" section in the web UI.
2. Click "Create Router" to define a new router.
3. Assign a name, service, and rule to the router. Optionally, set entrypoints, middlewares, and other advanced settings.
4. Save your router to apply the changes.

Managing Middlewares

1. Open the "Middlewares" section.
2. Create new middleware by defining its type and associated settings.
3. Save the middleware and attach it to your routers as needed.

Example Workflow

1. Create a Router: Set up a router that directs traffic to the service based on specific rules (e.g., domain names).
2. Attach Middlewares: Apply any required middlewares to the router, such as authentication or headers.

Static Configuration

Please note that some aspects, such as Let's Encrypt certificates, need to be configured via Traefik's static configuration. Traefik Web UI focuses solely on managing dynamic configurations like routers, services, and middlewares.

Example Static Configuration

Below is a simple example of a Traefik static configuration in traefik.yml:

entryPoints:
  web:
    address: ":80"
  websecure:
    address: ":443"

certificatesResolvers:
  myresolver:
    acme:
      email: your-email@example.com
      storage: /acme.json
      httpChallenge:
        entryPoint: web

providers:
  http:
    endpoint: "<endpoint where mantrae is running>"

Contributing

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

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Acknowledgements

• Traefik: For providing the powerful reverse proxy that powers this application.
• Nginx Proxy Manager: For inspiration on building a simple and effective web UI for managing reverse proxies.