Updated readme
This commit is contained in:
committed by
shaun collins
parent
e9d0613bd0
commit
4092a0d543
@@ -1,9 +1,8 @@
|
|||||||
# README
|
# Lingen Homelab
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
This repository contains multiple services, used within the Lingen Homelab.
|
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.
|
||||||
They are all controlled via a `Makefile`
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -11,27 +10,50 @@ They are all controlled via a `Makefile`
|
|||||||
|
|
||||||
## Available Services
|
## 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**
|
### Content & Downloads
|
||||||
2. **Cloudreve**
|
- **Prowlarr** - Indexer manager for Radarr, Sonarr, and Lidarr
|
||||||
3. **Dockhand**
|
- **Flaresolverr** - Proxy server to handle Cloudflare protection
|
||||||
4. **Gitea**
|
- **Qbittorrent** - Lightweight torrent client for media downloads
|
||||||
5. **Jellyfin**
|
- **Scanopy** - Container monitoring and management system
|
||||||
6. **Gluetun**
|
|
||||||
7. **JellySeerr**
|
### Infrastructure & Security
|
||||||
8. **Prowlarr**
|
- **Gluetun** - VPN client container for secure connections
|
||||||
9. **Radarr**
|
- **Gluetun WebUI** - Web interface for Gluetun management
|
||||||
10. **Sonarr**
|
- **NginxReverseProxy** - Reverse proxy for routing and SSL termination
|
||||||
11. **Minecraft**
|
- **Newt** - API management and monitoring tool
|
||||||
12. **Scanopy**
|
|
||||||
13. **NginxReverseProxy**
|
### 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
|
The repository uses a `Makefile` to simplify service management. Below are the common commands available:
|
||||||
- `make down` Bring service down
|
|
||||||
|
```bash
|
||||||
|
make up # Bring all services up in the background
|
||||||
|
make down # Bring all services down
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user