HomelabARR¶

Docker container management for homelabs. 157+ apps, one-click deploy. Optional Traefik reverse proxy with Authelia 2FA.

Quick Start -- Up and running in 60 seconds

curl -o homelabarr.yml https://raw.githubusercontent.com/smashingtags/homelabarr-ce/main/homelabarr.yml
export JWT_SECRET=$(openssl rand -base64 32)
export DOCKER_GID=$(getent group docker | cut -d: -f3)
docker compose -f homelabarr.yml up -d

Open http://your-server-ip:8084, log in with admin / admin, and start deploying apps. See the Quick Start Guide for all installation methods.

Migration¶

Migrating from another Docker management platform? Check the Migration Guide before you start.

Minimum Specs and Requirements¶

Stable: Ubuntu 22
CPU 2 Cores or 2 VCores (x86/x64)
- No ARM Support
4GB Ram
20GB Disk Space
A VPS/VM or Dedicated Server
your Domain or buy a new namecheap (only required for Traefik setup)
Cloudflare account free tier (only required for Traefik setup)

For Testing¶

Pre-Install¶

Only required for Traefik + domain setup (Method 2)

If you're using the Docker Compose method, skip this section and go straight to the Quick Start Guide.

Login to your Cloudflare Account & goto DNS click on Add record.
Add 1 A-Record pointed to your server's ip.
Copy your CloudFlare-Global-Key and CloudFlare-Zone-ID.

Set the following on Cloudflare¶

SSL = FULL ( not FULL/STRICT )
Always on = YES
HTTP to HTTPS = YES
RocketLoader and Broli / Onion Routing = NO
TLS min = 1.2
TLS = v1.3

Install¶

Follow our install instructions: Quick Start Guide

Documentation & Guides¶

Getting Started¶

Quick Start Guide - All installation methods (Docker Compose, CLI, Local)
Linux Installation Guide - Detailed Linux setup instructions
Local Mode Setup - Testing and development setup

Advanced Topics¶

Repository Structure - Understanding the organized codebase
Contributing Guidelines - How to contribute to the project
Architecture Overview - Technical system design

Release Information¶

Changelog - Latest updates and improvements
Release Notes - Detailed version information
YAML Standardization - Infrastructure improvements
Repository Cleanup - Organization and cleanup details

Support¶

Kindly report any issues/broken-parts/bugs on github or discord

Support Development - Help keep HomelabARR CE growing!

Code and Permissions¶

Copyright 2021 @homelabarr
Code owner @homelabarr
Dev Code @homelabarr
Co-Dev -APPS- @CONTRIBUTORS-LIST

Contributors¶

Thanks goes to these wonderful people (emoji key):

Contributors¶

_FSCorrupt	_DrAg0n141	_smashingtags
_Aelfa	_cyb3rgh05t	_{justinglock40}	_mrfret
_{DoCtEuR3805 \| FRENCH-QC}	_brtbach	_{Mend Renovate}	_ramsaytc
_Shayne	_Nossersvinet	_{Ookla, Ariel, Ride!}	_actions-user
_Imgbot	_{James Townsend}	_{Red Daut}	_{DomesticWarlord}