From 4092a0d543b2c8cf30c1dfd11638c8d39bd774b6 Mon Sep 17 00:00:00 2001 From: Shaun Collins Date: Thu, 19 Mar 2026 10:37:35 +0000 Subject: [PATCH] Updated readme --- README.md | 64 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 43 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 1b5be5a..7854616 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ -# README +# Lingen Homelab ## Overview -This repository contains multiple services, used within the Lingen Homelab. -They are all controlled via a `Makefile` +The Lingen Homelab is a comprehensive self-hosted services repository designed to provide a complete ecosystem of applications for media management, VPN services, development tools, and more. All services are containerized using Docker and managed through a unified `Makefile` for simplified operations. ![Lingen landing page](lingen.png) @@ -11,27 +10,50 @@ They are all controlled via a `Makefile` ## Available Services -Here is a list of available services within the repository: +### Media & Entertainment +- **AudioBookShelf** - Self-hosted audiobook and podcast server +- **Jellyfin** - Open-source media system and home theater +- **JellySeerr** - Media request management for Jellyfin +- **Radarr** - Movie collection manager and download automation +- **Sonarr** - TV series collection manager and download automation +- **Lidarr** - Music collection manager and download automation +- **Bazarr** - Subtitle management for Radarr and Sonarr -1. **AudioBookShelf** -2. **Cloudreve** -3. **Dockhand** -4. **Gitea** -5. **Jellyfin** -6. **Gluetun** -7. **JellySeerr** -8. **Prowlarr** -9. **Radarr** -10. **Sonarr** -11. **Minecraft** -12. **Scanopy** -13. **NginxReverseProxy** +### Content & Downloads +- **Prowlarr** - Indexer manager for Radarr, Sonarr, and Lidarr +- **Flaresolverr** - Proxy server to handle Cloudflare protection +- **Qbittorrent** - Lightweight torrent client for media downloads +- **Scanopy** - Container monitoring and management system + +### Infrastructure & Security +- **Gluetun** - VPN client container for secure connections +- **Gluetun WebUI** - Web interface for Gluetun management +- **NginxReverseProxy** - Reverse proxy for routing and SSL termination +- **Newt** - API management and monitoring tool + +### Development & Utilities +- **Gitea** - Lightweight Git service for version control +- **Cloudreve** - Self-hosted cloud storage solution +- **Dockhand** - Docker management utility +- **Database** - Shared database services + +### Additional Services +- **Ace** - Utility service +- **BoilerPlate** - Project template framework +- **Minecraft** - Minecraft game server management +- **Prunemate** - Docker cleanup and maintenance tool +- **StuShifters** - Custom utility service +- **Tools** - Development and operational tools --- -## General Commands +## Quick Start -The repository uses a `Makefile` to simplify service management across the project. Below are the common commands available: +### Basic Commands -- `make up` Bring service up -- `make down` Bring service down +The repository uses a `Makefile` to simplify service management. Below are the common commands available: + +```bash +make up # Bring all services up in the background +make down # Bring all services down +``` \ No newline at end of file