Updated readme

This commit is contained in:
Shaun Collins
2026-03-19 10:37:35 +00:00
committed by shaun collins
parent e9d0613bd0
commit 4092a0d543
+43 -21
View File
@@ -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
```