Skip to content

Commit 3d1533f

Browse files
committed
new readme
1 parent 07177d9 commit 3d1533f

File tree

2 files changed

+232
-0
lines changed

2 files changed

+232
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
!.gitignore
55
!README.md
6+
!README-new.md
67
!LICENSE
78
!.env.example
89

README-new.md

Lines changed: 231 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,231 @@
1+
# 🐳 Ultimate Docker Homelab Setup
2+
3+
> **Real-world Docker configurations** from Anand at [SimpleHomelab.com](https://www.simplehomelab.com/) (formerly SmartHomeBeginner.com)
4+
5+
[![Deployrr](https://img.shields.io/badge/Powered%20by-Deployrr-blue?style=flat-square)](https://www.simplehomelab.com/deployrr/)
6+
[![UDMS Series](https://img.shields.io/badge/UDMS-Series-green?style=flat-square)](https://www.simplehomelab.com/ultimate-docker-media-server-udms-01/)
7+
[![150+ Apps](https://img.shields.io/badge/Apps-150%2B-orange?style=flat-square)](#-featured-applications)
8+
9+
---
10+
11+
## 🎯 What This Repository Offers
12+
13+
This repository contains my **actual production Docker setups** that power my homelab infrastructure. Unlike theoretical guides, these are real-world configurations that I use daily.
14+
15+
### ✨ Key Features
16+
- **Real-world configurations** based on [Deployrr](https://www.simplehomelab.com/deployrr/) and [Ultimate Docker Media Server](https://www.simplehomelab.com/ultimate-docker-media-server-udms-01/) series
17+
- **150+ Docker applications** ready to deploy
18+
- **Multi-host architecture** spanning home servers, cloud VPS, and NAS
19+
- **Production-tested** setups with security and performance optimizations
20+
- **Extensive documentation** and video tutorials
21+
22+
### 🎯 Repository Purpose
23+
1. **Share actual setups** - Real configurations I use in production
24+
2. **Extend Deployrr capabilities** - Examples beyond standard Deployrr templates
25+
3. **Provide advanced configurations** - Complex setups not covered in basic guides
26+
27+
---
28+
29+
## 🖥️ Infrastructure Overview
30+
31+
I believe in **simple, energy-efficient homelab** design that maximizes performance while minimizing complexity.
32+
33+
### 🏠 Home Network Architecture
34+
- **OPNsense** firewall running on Proxmox VM
35+
- **Tailscale** mesh networking connecting all hosts
36+
- **Multi-tier deployment** across different hardware platforms
37+
38+
### 📊 Hardware Specifications
39+
40+
| Component | Specifications | Purpose |
41+
|-----------|---------------|---------|
42+
| **TopTon V700 Mini PC** | Intel i7-13800H, 64GB RAM, 2×2TB NVMe ZFS RAID1, 4TB SATA SSD | Primary Proxmox host |
43+
| **Synology DS918+** | DX517 Expansion, 8GB RAM, 4×18TB SHR2 (×2 volumes) | Storage & legacy apps |
44+
| **Oracle Ampere A1** | 4 vCPU ARM64, 24GB RAM, 200GB storage | Web server & ARM workloads |
45+
46+
---
47+
48+
## 🐳 Docker Hosts
49+
50+
All Docker configurations are organized by host with clear naming conventions:
51+
52+
### 🏠 Home Server (`hs-*`)
53+
```yaml
54+
Platform: Ubuntu 24.04 LXC on Proxmox
55+
Resources: 8 vCPU, 8GB RAM, 4GB Swap
56+
Storage: 64GB OS + 32GB Docker data
57+
Purpose: Core homelab services
58+
```
59+
60+
### 🎬 Media Database Server (`mds-*`)
61+
```yaml
62+
Platform: Ubuntu 24.04 LXC on Proxmox
63+
Resources: 12 vCPU, 12GB RAM, 4GB Swap
64+
Storage: 64GB OS + 72GB Docker data
65+
Purpose: Media management & processing
66+
```
67+
68+
### 🌐 Web Server (`ws-arm-*`)
69+
```yaml
70+
Platform: Ubuntu 24.04 ARM64 on Oracle Cloud
71+
Resources: 4 vCPU, 24GB RAM
72+
Storage: 100GB OS + 100GB data
73+
Purpose: Web applications & ARM workloads
74+
```
75+
76+
### 💾 Synology NAS (`ds918-*`)
77+
```yaml
78+
Platform: DSM 7.2
79+
Resources: 8GB RAM, 144TB storage (SHR2)
80+
Purpose: Storage & legacy applications
81+
```
82+
83+
### 📁 Archives
84+
Legacy configurations in `_archives_` folder - not actively maintained but useful as reference.
85+
86+
---
87+
88+
## 📚 Learning Resources
89+
90+
### 🎥 Ultimate Docker Media Server Series
91+
92+
**Complete step-by-step guide** to building a professional Docker homelab:
93+
94+
#### 🚀 Getting Started
95+
1. [Introduction and Overview](https://www.simplehomelab.com/udms-01-introduction-and-overview/)
96+
2. [Hardware: NAS, Mini PC, or VPS (FREE!). Which one?](https://www.simplehomelab.com/udms-02-hardware-nas-minipc-vps/)
97+
3. [Best Home Server OS, Proxmox LXC vs VM](https://www.simplehomelab.com/udms-03-best-home-server-os/)
98+
99+
#### ⚙️ Infrastructure Setup
100+
4. [Install Proxmox on Mini PC with ZFS RAID1 Mirror + 3 Tweaks](https://www.simplehomelab.com/udms-04-install-proxmox-on-mini-pc/) [📹](https://youtu.be/2nIPY7D-UA0)
101+
5. [Installing and Prepping Ubuntu/Debian](https://www.simplehomelab.com/udms-05-installing-ubuntu-on-proxmox/) [📹](https://youtu.be/-ZSQdJ62r-Q)
102+
6. [Mounting Remote Folders using Rclone](https://youtu.be/D-XS0biLP14) [📹]
103+
7. Mounting Remote Folders using SMB/CIFS *(Coming Soon)*
104+
8. Mounting Remote Folders using NFS *(Coming Soon)*
105+
9. Binding Mounting on Proxmox Unprivileged LXC *(Coming Soon)*
106+
107+
#### 🔧 Advanced Configuration
108+
10. [Proxmox Unprivileged LXC Network Node Passthrough](https://www.simplehomelab.com/udms-10-proxmox-lxc-network-device-passthrough/) [📹](https://youtu.be/r0nGMFs5pCY)
109+
11. [Proxmox Unprivileged LXC iGPU Node Passthrough](https://www.simplehomelab.com/udms-11-gpu-passthrough-on-proxmox-lxc/) [📹](https://youtu.be/kvnJYyyLoIk)
110+
111+
#### 🐳 Docker Fundamentals
112+
12. [Installing Docker and Docker Compose on Ubuntu/Debian](https://www.simplehomelab.com/udms-12-install-docker-and-docker-compose/)
113+
13. [Essential Docker Commands & Time-Saving Aliases](https://www.simplehomelab.com/udms-13-docker-and-docker-compose-commands/)
114+
14. [Kickass Docker Media Server with 150+ Apps](https://www.simplehomelab.com/udms-14-docker-media-server/) [📹](https://youtu.be/THuLgGwq0vg)
115+
15. Best Docker Containers for Homelab *(Coming Soon)*
116+
117+
#### 🌐 Remote Access & Security
118+
16. [Exposing Apps to the Internet: Tailscale](https://www.simplehomelab.com/udms-part-16-tailscale-homelab-remote-access/) [📹](https://youtu.be/M6GMp4FJrB8)
119+
17. Exposing Apps to the Internet: Nginx Proxy Manager *(Coming Soon)*
120+
18. [Exposing Apps to the Internet: Traefik Reverse Proxy](https://www.simplehomelab.com/udms-18-traefik-docker-compose-guide/) [📹](https://www.youtube.com/playlist?list=PL1Hno7tIbSWUGrZSqeB9aCsdAuoeVwvgh)
121+
122+
#### 🔐 Authentication & Security
123+
19. [Authentication for Docker Apps - Authelia](https://www.simplehomelab.com/udms-19-authelia-docker-compose/) [📹](https://youtu.be/UIq8PLZHBtk)
124+
20. [Authentication for Docker Apps - Google OAuth 2](https://youtu.be/SCKALXprTQE) [📹]
125+
21. [Authentication for Docker Apps - Authentik](https://youtu.be/GoUmJAe1MKc) [📹]
126+
22. [CrowdSec Docker Compose – Bulletproof IPS for Homelabs](https://www.simplehomelab.com/udms-22-crowdsec-docker-compose/)
127+
23. [Setting up Crowdsec Cloudflare Bouncer](https://www.simplehomelab.com/udms-23-crowdsec-cloudflare-bouncer/)
128+
24. [Setting up Crowdsec Traefik Bouncer](https://www.simplehomelab.com/udms-24-crowdsec-traefik-bouncer/)
129+
130+
#### 🚀 Advanced Topics
131+
25. Advanced Topics: Traefik Plugins *(Coming Soon)*
132+
26. Advanced Topics: Traefik Multiple Domains *(Coming Soon)*
133+
27. Advanced Topics: Traefik Domain Passthrough *(Coming Soon)*
134+
28. Advanced Topics: [Traefik Conditional Auth Bypass](https://www.simplehomelab.com/udms-28-traefik-auth-bypass/)
135+
29. Advanced Topics: [CrowdSec Multiserver Setup](https://www.simplehomelab.com/udms-29-crowdsec-multiserver/)
136+
30. Closing Thoughts and Options to Level Up *(Coming Soon)*
137+
138+
### 📖 Additional Guides
139+
140+
#### 🏢 Synology NAS
141+
- [Ultimate Synology NAS Docker Compose Media Server 2022](https://www.simplehomelab.com/synology-nas-docker-media-server-2022/) *(Update Pending)*
142+
143+
#### 🌐 Web Server
144+
- [WordPress on Docker with Nginx, Traefik, LE SSL, Security, and Speed](https://www.simplehomelab.com/wordpress-on-docker-traefik/) *(Update Pending)*
145+
146+
#### 🤖 Automation
147+
- [Deployrr: Automate Docker Compose based Homelab Setup](https://www.simplehomelab.com/deployrr/) [📹](https://youtu.be/OnoKy73b-w4)
148+
149+
---
150+
151+
## 🚀 Featured Applications
152+
153+
**150+ Docker applications** ready for deployment, sourced from the [Deployrr Repository](https://github.com/SimpleHomelab/Deployrr/blob/main/APPS.md):
154+
155+
### 📱 Media & Entertainment
156+
**Adminer**, **Airsonic-Advanced**, **Audiobookshelf**, **Bazarr**, **Beets**, **Calibre**, **Calibre-Web**, **Emby**, **Funkwhale**, **GameVault**, **Immich**, **Jellyfin**, **Jellyseerr**, **Kavita**, **Kometa**, **Komga**, **Lidarr**, **Mylar3**, **Navidrome**, **Ombi**, **Overseerr**, **Plex**, **Radarr**, **Sonarr**, **Tautulli**, **Trilium Next**
157+
158+
### 🏠 Home Automation & IoT
159+
**ESPHome**, **Home Assistant Core**, **Homebridge**, **Mosquitto**, **MQTTX Web**, **Node-RED**, **OpenHands**
160+
161+
### 🔧 Development & Productivity
162+
**Authentik**, **Authelia**, **Bookstack**, **CyberChef**, **DokuWiki**, **Flowise**, **FreshRSS**, **Grocy**, **Guacamole**, **IT-Tools**, **Nextcloud**, **n8n**, **Ollama**, **Open-WebUI**, **Paperless-AI**, **Paperless-NGX**, **PdfDing**, **Privatebin**, **Stirling PDF**, **Visual Studio Code Server**, **Vikunja**, **WikiDocs**
163+
164+
### 📊 Monitoring & Analytics
165+
**cAdvisor**, **Change Detection**, **Dockwatch**, **Dozzle**, **Dozzle Agent**, **Glances**, **Grafana**, **InfluxDB**, **Netdata**, **Node Exporter**, **Prometheus**, **Scrutiny**, **Smokeping**, **Speedtest-Tracker**, **Uptime-Kuma**, **Watchtower**, **What's Up Docker (WUD)**
166+
167+
### 🌐 Networking & Security
168+
**Cloudflare Tunnel**, **CrowdSec**, **CrowdSec Firewall Bouncer**, **Gluetun**, **Pi-hole**, **Tailscale**, **Traefik**, **Traefik Access Logs**, **Traefik Bouncer**, **Traefik Certs Dumper**, **Traefik Error Logs**, **WG-Easy**, **Wireguard**, **ZeroTier**
169+
170+
### 🎨 Dashboards & Organization
171+
**Dashy**, **Flame**, **Heimdall**, **Homarr**, **Homer**, **Homepage**, **Organizr**, **Theme Park**
172+
173+
### 💾 Storage & Backup
174+
**Resilio Sync**, **Vaultwarden**
175+
176+
### 🗄️ Databases & Data
177+
**Baikal**, **MariaDB**, **PostgreSQL**, **PgAdmin**, **phpMyAdmin**, **Qdrant**, **Redis**, **Redis Commander**, **Weaviate**
178+
179+
### 🎯 Utilities & Tools
180+
**Chromium**, **Cleanuparr**, **Cloud Commander**, **DDNS Updater**, **DeUnhealth**, **DigiKam**, **Docker Garbage Collection**, **Double Commander**, **DweebUI**, **FileZilla**, **Flaresolverr**, **Gotenberg**, **GPTWOL**, **Huntarr**, **Jackett**, **Kasm**, **Lollypop**, **Maintainerr**, **Notifiarr**, **OAuth**, **Piwigo**, **Portainer**, **Prowlarr**, **qBittorrent**, **qBittorrent with VPN**, **Remmina**, **SABnzbd**, **SearXNG**, **ShellInABox**, **Socket Proxy**, **SSHwifty**, **Tika**, **TinyAuth**, **Transmission**, **Wallos**
181+
182+
---
183+
184+
## ⚡ Quick Start Commands
185+
186+
### 🎯 Essential Docker Aliases
187+
188+
I use **Bash Aliases** installed via Deployrr for streamlined Docker management:
189+
190+
| Command | Description |
191+
|---------|-------------|
192+
| `dcup` | Start Docker stack |
193+
| `dcdown` | Stop Docker stack |
194+
| `dcrec` | Start or recreate specific service/full stack |
195+
| `dcstop` | Stop specific service/full stack |
196+
| `dcrestart` | Restart specific service/full stack |
197+
| `dclogs` | View real-time logs for stack/service |
198+
| `dcpull` | Pull new images for stack/service |
199+
200+
> 📖 **Learn More**: [Essential Docker Commands & Time-Saving Aliases](https://www.simplehomelab.com/udms-13-docker-and-docker-compose-commands/) | [Bash Aliases in Deployrr](https://docs.deployrr.app/operating-system/bash-aliases-explained)
201+
202+
---
203+
204+
## 🤝 Support & Community
205+
206+
**Documenting, writing guides, and maintaining this repository** requires hundreds of hours of dedicated work. Your support helps keep this project alive and continuously updated.
207+
208+
### 🎖️ Join the Geek Army
209+
<div style="text-align:center;margin:20px">
210+
<a href="https://www.simplehomelab.com/geek-army/join/" target="_blank" rel="nofollow noopener noreferrer">
211+
<img src="https://www.simplehomelab.com/images/2024/01/become-a-member.png" alt="Join the Geek Army" width="258" height="76" />
212+
</a>
213+
</div>
214+
215+
### 💬 Join the Discord Community
216+
<div style="text-align:center;margin:20px">
217+
<a href="https://www.simplehomelab.com/discord-github/" target="_blank" rel="nofollow noopener noreferrer">
218+
<img src="https://www.simplehomelab.com/images/2022/05/join-discord-300x75.png" alt="Join Discord" width="300" height="75" />
219+
</a>
220+
</div>
221+
222+
---
223+
224+
## 📝 License & Attribution
225+
226+
This repository contains real-world Docker configurations based on:
227+
- [Deployrr](https://www.simplehomelab.com/deployrr/) automation platform
228+
- [Ultimate Docker Media Server](https://www.simplehomelab.com/ultimate-docker-media-server-udms-01/) series
229+
- [SimpleHomelab.com](https://www.simplehomelab.com/) community resources
230+
231+
**Created by**: Anand from [SimpleHomelab.com](https://www.simplehomelab.com/) (formerly SmartHomeBeginner.com)

0 commit comments

Comments
 (0)