I have been using Docker for over 5 years and Traefik for over 4 years now. They are key parts of my smart home setup and I have documented their installation and setup in the following guides:
- Ultimate Traefik Docker Compose Guide [2022] with LetsEncrypt
- Docker Media Server Ubuntu 22.04 with 23 Awesome Apps
But Traefik reverse proxy can be tricky to setup as there are many things to pay attention to. Nearly 90% of the support requests we receive on our Discord server are user errors.
Maybe you have tried everything and you just can't figure out what the problem is. Maybe you just need to see some proof that Traefik even works in your setup. If so, this automated Traefik script is your friend.
Table of Contents
What is Auto-Traefik
I combined my years of experience writing guides and helping thousands of people on Traefik and docker to write this script, which is currently nearly 2500 lines long. It took weeks of writing and testing.
Thanks also to a few volunteers on our Discord server that tested the script.
What do Users Say About Auto-Traefik?
What does Auto-Traefik do?
It automates the installation of docker, Traefik, Portainer, Authelia, etc. (more apps to be added later) and secures it. It creates the Docker environment and the required files and folders with the right permissions, so you do not miss something important. All your applications will be available via a valid LetsEncrypt SSL certificate.
Screenshots (Version 3.0.1)
Script Updates
Current Version: 3.2 (April 25, 2024)
Release Announcement: Auto-Traefik Version 3.0 – Backups, Guacamole, More Free Options, etc.
GitHub Changelog: CHANGELOG.md
Cost
The main objective of Auto-Traefik is to help my visitors setup an environment that is exactly how I run my stuff. This is entirely possible for free with my guides and GitHub repo. And my GitHub repo is my real setup, shared 'as-is'.
The purpose of AutoTraefik licensing is to add value to the supporting members of the site. But I understand some of you may not want to sign up for membership. Hence, why is there now a possibility to purchase the script separately at a level of your choice. Here is a comparison.
| Feature | Free | Auto-Traefik | Auto-Traefik+ |
|---|---|---|---|
| Ensure prerequisites but build your stack manually. | Ensure prerequisites and setup the basic Docker-Traefik stack. Add authentication and additional apps manually. | Ensure prerequisites and setup scalable Docker-Traefik stack with Apps and Authentication. | |
| System checks | ✓ | ✓ | ✓ |
| Docker checks | ✓ | ✓ | ✓ |
| Port checks | ✓ | ✓ | ✓ |
| Domain and DNS checks | ✓ | ✓ | ✓ |
| Docker Environment Setup | ✓ (with STARTER - FREE membership) | ✓ | ✓ |
| Socket Proxy Setup | ✓ | ✓ | |
| Anand's Docker Bash Aliases | ✓ | ✓ | |
| Docker Disk Usage Management | ✓ | ✓ | |
| Traefik Environment Setup | ✓ | ✓ | |
| Traefik Staging Setup | ✓ | ✓ | |
| Traefik Production Setup | ✓ | ✓ | |
| Authelia Setup | ✓ | ||
| Authentication Management for Apps | ✓ | ||
| Additional Apps | ✓ (Portainer, Dozzle, Glances, Homepage, Homarr, Uptime-Kuma, MariaDB, InfluxDB, Prometheus, phpMyAdmin, Guacamole, Vaultwarden, DDNS Updater, VS Code, IT Tools, and Backups) | ||
| Upgrade any-time from your Account Page or Join Page. | |||
| One-time Cost | FREE | $19.99 | $69.99 |
| Included in MembershipsJoin Now | Silver - Yearly, Gold - Yearly, and Platinum (Lifetime) | Gold - Yearly and Platinum (Lifetime) | |
How to Use Auto Traefik
Here are the basic steps to get started. Download the script using the following command:
Auto-Traefik executable binary can be download the .shb file from the GitHub Repo and uploaded to your server using any SFTP client.
Alternatively, you can use wget command to download it directly on your server:
wget https://raw.githubusercontent.com/htpcBeginner/auto-traefik/main/auto-traefik_v3.2.shb
Remember to replace v3.2 with the current version number.
Once you have the script on the server, make it executable using the following command:
chmod +x auto-traefik_v3.2.shb
Then, run it using the following command:
./auto-traefik_v3.2.shb
You may run the script as many times as you like (only applies to a clean OS). In fact, if it errors for some reason, rerun it before reaching out for support.
Concluding Remarks
As mentioned in my recent post about the state of the site and introduction of memberships, I am working to add more value to members so I can sustain the operations in its current state.
However, I still truly believe in teaching. While this script is a nice perk, it definitely is not a requirement for you to setup Traefik. If you have the willingness to learn and time, my Traefik guide, Docker guide, and GitHub Repo are all you need.
Whatever the case for you to try this script, I hope that it served its purpose.
