Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anandslab/deployarr
Deployarr automates Homelab setup using Docker and Docker Compose. Below you will find more information its features and what it can/cannot do.
https://github.com/anandslab/deployarr
Last synced: 3 days ago
JSON representation
Deployarr automates Homelab setup using Docker and Docker Compose. Below you will find more information its features and what it can/cannot do.
- Host: GitHub
- URL: https://github.com/anandslab/deployarr
- Owner: anandslab
- License: mit
- Created: 2024-06-13T20:58:40.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-30T22:09:15.000Z (9 days ago)
- Last Synced: 2024-10-30T23:19:12.509Z (9 days ago)
- Language: Shell
- Homepage: https://www.deployarr.app
- Size: 14.2 MB
- Stars: 208
- Watchers: 14
- Forks: 28
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-arr - Deployarr - Deployarr automates Homelab setup using Docker and Docker Compose. (Complimenting Apps)
README
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.
[Full List of Apps](APPS.md)
## Supported Apps - 91 (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.
# Features
- Docker Environment Setup (FREE) - as in my guides
- System Checks (FREE)
- Domain Checks to prepare for Traefik (FREE)
- Full control over all apps and files
- Descriptive error messages for troubleshooting
- Socket-Proxy to protect Docker Socket from compromised apps
- Deployarr Dashboard - Auto-populating Homelab Dashboard
- Bash Aliases for Linux, Docker, and Docker Compose
- Local-only Setup without reverse proxy or port forwarding
- Traefik Reverse Proxy App Exposure Modes: Internal Only, External Only, or Both
- Multi-server Setup
- Domain passthrough for multi-domain multi-Traefik setups
- Google OAuth and Authelia for Authentication layer
- 90+ Total Apps
- Stack Manager: Update Apps, Enable Apps, Disable Apps, Delete Apps, Up/Down Stack, Recreate/Start/Stop containers, etc.
- Backups, Restore, and Migration of whole setup
- Expert Mode for advanced users
- PLANNED: Several more apps including Authentik, CrowdSec, etc.
# Downloading and Running Deployarr
```
wget https://raw.githubusercontent.com/anandslab/deployarr/main/deployarr_v5.1.app
```
```
chmod +x deployarr_v5.1.app
```
```
./deployarr_v5.1.app
```
Use the -arm.app version of the file for Raspberry Pi.
## Migrate from v4 to v5
[How to Migrate from v4.6.1 to v5?](v4-to-v5-migration.md)
## Deployarr Stats - Jan to Sep 2024
# References
More information on Deployarr and how to use it:
Official Website: https://www.smarthomebeginner.com/deployarr/
Video Guides:
- 20-min Intro: https://www.smarthomebeginner.com/go/deployarr-v5-intro/
- Detailed Guide: https://www.smarthomebeginner.com/go/deployarr-v5-detailed-guide/
# Support
Please do not open issues on GitHub. There is a dedicated Auto-Traefik/Deployarr support channel on our [Discord server](https://www.smarthomebeginner.com/discord/) for Supporters.
# Cost / Licenses Types
Any one can download the use the free features in Deployarr without registration.
Optionally, if you decide to sponsor my work, then there are 3 different options; Basic, Plus, and Pro, which will open up additional features. In addition, all [**annual** memberships](https://www.smarthomebeginner.com/membership-account/join-the-geek-army/) on my website include Deployarr access.
More Details: [Detailed Version Comparison](https://www.smarthomebeginner.com/deployarr/#Cost)
# 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 with little to no tweaking.
### 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 or my [Docker-Traefik GitHub Repo](https://github.com/anandslab/docker-traefik).
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](https://www.youtube.com/@anandslab). 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.
In addition, Deployarr also allows me to [contribute to he open-source projects](https://opencollective.com/deployarr) we all love.
### 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 are some limitations and known issues.
- DNS Challenge Provider: Cloudflare (only supported provider at this point). You may have you domain registered with any registrar, but you will have to use Cloudflare for DNS (its free).
- Port Forwarding is required (80/443).
- Some apps (Guacamole, Speedtest-Tracker) that depend on databases may fail upon reinstallation from scratch. This will be fixed at some point. Clean installation should work.
# Screenshots
#### Splash Screen
#### Main Menu
#### Prerequisites
#### Local Setup
#### Hybrid Setup
#### System Checks
#### System Prep Menu
#### Rclone Remote Mounts
#### Setting Folders
#### Docker Menu
#### Reverse Proxy Menu
#### Descriptive Error Messages
#### Security Menu
#### Manage Authentication
#### Apps List
#### App Install
#### App Uninstall
#### Deployarr Dashboard
#### Tools Menu
#### Stack Manager
#### Containers Status
#### Services Status
#### Backups Menu
#### Restore Backups
#### Deployarr Settings
#### License Types
#### Setup Options
#### Getting Support
