KansaiGaijin/Homelab
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Readme to show full service directory

Browse Source
This commit is contained in:
Jamie Miller
2025-08-18 05:31:03 +00:00
parent dd1a3f099c
commit 2b806d8506
1 changed files with 34 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@@ -15,38 +15,50 @@ docker compose up -d
## 📋 Services Overview ## 📋 Services Overview
### 🎬 Media Stack (`media` profile) ### 🎬 Media Management
- **Sonarr** (8989) - TV series management
- **Radarr** (7878) - Movie management
- **Lidarr** (8686) - Music management
- **Bazarr** (6767) - Subtitle management - **Bazarr** (6767) - Subtitle management
- **Prowlarr** (9696) - Indexer management
- **FlareSolverr** (8191) - Cloudflare bypass - **FlareSolverr** (8191) - Cloudflare bypass
- **Jellyfin** (8096) - Media streaming server - **Jellyfin** (8096) - Media streaming server
- **Jellyseerr** (5055) - Media request management - **Jellyseerr** (5055) - Media request management
- **Lidarr** (8686) - Music management
- **Prowlarr** (9696) - Indexer management
- **qBittorrent** (7070) - Download client - **qBittorrent** (7070) - Download client
- **Multi-Scrobbler** (9078) - Music scrobbling - **Radarr** (7878) - Movie management
- **Maloja** (42010) - Music statistics - **Sonarr** (8989) - TV series management
### 🛠️ Utilities (`utilities` profile) ### 🎵 Music & Scrobbling
- **Homepage** (7575) - Service dashboard - **Maloja** (42010) - Music statistics
- **FileBrowser** (6633) - Web file manager - **Multi-Scrobbler** (9078) - Music scrobbling
- **Syncthing** (8384) - File synchronization
- **Obsidian Remote** (8181) - Note-taking ### 📄 Document Management
- **Gotenberg** - Document conversion
- **OnlyOffice** (8054) - Document editing
- **Paperless AI** (3040) - AI document enhancement
- **Paperless NGX** (8100) - Document management
- **Redis** - Paperless broker
- **MariaDB** - Paperless database
- **Stirling PDF** (8090) - PDF processing - **Stirling PDF** (8090) - PDF processing
- **RustDesk** - Remote desktop server - **Tika** - Content extraction
### 🏠 Personal Applications
- **AdventureLog Frontend** (8015) - Adventure tracking interface
- **AdventureLog Backend** (8016) - Adventure tracking API
- **AdventureLog Database** - PostgreSQL database
- **Gramps** (5511) - Genealogy management - **Gramps** (5511) - Genealogy management
- **Gramps Celery** - Background task processing
- **Gramps Redis** - Task queue
- **Obsidian Remote** (8181) - Note-taking
- **Syncthing** (8384) - File synchronization
### 🛠️ System Utilities
- **Docker Proxy** (2375) - Docker API proxy
- **FileBrowser** (6633) - Web file manager
- **Homepage** (7575) - Service dashboard
- **RustDesk (hbbr)** - Remote desktop relay
- **RustDesk (hbbs)** - Remote desktop signaling
- **Newt** - Notification service - **Newt** - Notification service
- **RackNerd API Converter** (5000) - VPS monitoring API - **RackNerd API Converter** (5000) - VPS monitoring API
- **Speedtest Database** - MariaDB for speedtest
### 📄 Documents (`documents` profile)
- **Paperless NGX** (8100) - Document management
- **Paperless AI** (3040) - AI document enhancement
- **Gotenberg** - Document conversion
- **Tika** - Content extraction
- **OnlyOffice** - Document editing
### 📊 Monitoring (`monitoring` profile)
- **Speedtest Tracker** (8180) - Network monitoring - **Speedtest Tracker** (8180) - Network monitoring
- **Watchtower** - Container updates - **Watchtower** - Container updates
@@ -164,10 +176,6 @@ docker compose ps
3. Use environment variables for configuration 3. Use environment variables for configuration
4. Update documentation for new services 4. Update documentation for new services
## 📄 License
[Add your license here]
--- ---
**⚠️ Important**: This setup includes production credentials. Ensure `.env` is never committed to version control. **⚠️ Important**: This setup includes production credentials. Ensure `.env` is never committed to version control.