README.md

Traefik Proxy Manager
beta

Simply manage your Traefik Proxy with a web interface

🚀 Getting started

🔴 Officially, our app runs in a container. It may be possible to run it without Docker. However, we won't provide any documentation or help at the moment for those who want to try it.

1. Install docker if you don't have it : Docker install documentation
2. Download our docker compose file : curl -O https://raw.githubusercontent.com/SPLRGE/traefik/main/docker-compose.yml
3. Generate the application key with docker run --rm ghcr.io/splrge/traefik node ace generate:key
4. Open the docker-compose.yml file and fill all the missing values
5. Start the stack with docker compose up -d
6. Open the admin dashboard on http://your-server-ip:3333 and create your admin account

⚠ This project is still in beta and may not be fully functional. Opening issues is highly appreciated.

💻 Built with

• Back · AdonisJS
• Front · Tabler
• Database · SQLite

🤝 Contribute

All contributions are welcome!

1. Fork the repository
2. Add your changes
3. We use conventionnals commits, please follow them as much as possible.
4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!
   ⚠ Please submit them to the develop branch only.

Contributors

Special thank you for all people that contributed for this project. Feel free to submit a PR and add your name ❤

SPLRGE

vic256

🛡️ Licence

This project is open-sourced and licensed under the MIT Licence.

For any security concerns, private requests, sponsorship feel free to send us an e-mail at [email protected]