Deployarr automates Homelab setup using Docker and Docker Compose. Below you will find more information its features and what it can/cannot do.

What Apps are Supported by Deployarr?

Deployarr can automatically setup Socket Proxy, Traefik (fetch LE SSL certificates), Authelia, Portainer, Plex, Jellyfin, Starr Apps, Gluetun, Dozzle, Uptime-Kuma, Homepage, and other apps.

Supported Apps - 65 (and increasing)

As Deployarr simplifies setup of several homelab apps, and not just Traefik, it was recently renamed from Auto-Traefik to Deployarr. You may still find references to Auto-Traefik until the rebrand is complete.

Downloading and Running Deployarr

wget https://raw.githubusercontent.com/anandslab/deployarr/main/deployarr_v4.5.4.app

chmod +x deployarr_v4.5.4.app

./deployarr_v4.5.4.app

Use the -arm.app version of the file for Raspberry Pi.

References

More information on Deployarr and how to use it:

Official Website: https://www.smarthomebeginner.com/deployarr/

Guides:

Text Guide: https://www.smarthomebeginner.com/course/how-to-use-auto-traefik/
Video Guide: https://www.youtube.com/playlist?list=PL1Hno7tIbSWViTyCXl9xNdXXU-1bVxIFD

Support

Please do not open issues on GitHub. There is a dedicated Auto-Traefik/Deployarr support channel on our Discord server for Supporters.

Licenses Types

Free License

No registration required. Anyone can download and run the script as described above. Free to explore all the available options.
Perform system, port, and Docker checks to ensure your system is ready for Traefik. Get your system ready to follow Traefik v3 Setup guide.

Basic License (Free)

Register for a free account on SmartHomebeginner.com and activate the ability to automatically setup Docker Environment with proper files, folders, and permissions, as described in the Ultimate Docker Media Server guide.
Ability to view Docker disk usage and clean up.

Plus License

Ensure prerequisites and setup the basic Docker-Traefik stack.
Add authentication and additional apps manually.
Expert Mode to override checks for advanced setups.
Perfect for anyone that wants to setup the basic Docker environment with Traefik reverse proxy.

Pro License

Everything above, plus automated setup of 40 total apps, including Authelia, Google OAuth, Starr Apps, and more.
Backup and Migration features.
Stack Manager to manage the environment.

FAQ

What is the purpose of Deployarr?

The reason I created Deployarr was to enable people to automatically replicate the setup from my guides (and my own setup follows this). It is not a blackbox solution that one has no control over. My vision is for people to use it to setup their homelab for quick setup, testing, and customization. And if things break, learn from it, and quickly re-setup everything. Although Deployarr has some management tools it is not intended to be a homelab manager.

What OSes are supported?

Deployarr is primarily developed and tested on Ubuntu. But it should work on other Debian environments.

What hardware are supported?

At this point, Deployarr only works on Linux in Barebones, VM, and LXC environments. I do plan to include Synology devices in future. I am just waiting for Synology to update their Docker Package, which is several years old.

Why not Free?

Deployarr is meant to be a perk for followers and supporters of SmartHomeBeginner.com. But keep in mind that everything that the script does can be learned using the guides on SmartHomeBeginner.com.

Parts of the script are free to use without registration (see License Types).

Any support received via the purchase of the script goes towards publishing more videos guides on my Youtube Channel. At this point, I spend 15x more on editing costs compared to Youtube Ad income. This also does not include 1000s of hours spent on writing guides, making videos, maintaining the community, and developing the script.

Why not Open-Source?

Paid supporters receive full access to the script's functionalities. Implementing this requires license checks with some sensitive information. Unfortunately, this requires compiling the source.

What are the limitations of Deployarr?

With a bit of knowledge, the basic framework created by Deployarr can be adapted to any situation. With that said, here is what Deployarr can cannot do today.

Current Situation

Today, Deployarr works best for the most common scenario with the assumption that the user wants to expose all services safely to the internet to be accessed using a fully qualified domain name and strong authentication on top (e.g. Authelia/Google OAuth). Requirements for this are: