Enhance README.md with detailed service descriptions and port matrix for Docker services in the home lab environment.

This commit is contained in:
GSRN
2025-08-30 22:50:16 +02:00
parent a61cbc64cb
commit 3d4c01fc1b
12 changed files with 609 additions and 0 deletions

View File

@@ -1,2 +1,74 @@
# homelab_docker
A collection of Docker services for a home lab environment.
## Port Matrix
| Service | 80 | 81 | 222 | 2283 | 3000 | 5000 | 5540 | 5678 | 6379 | 8001 | 8554 | 8555 | 8971 | 9000 | 9443 | 27017 |
|---------|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|
| 🔥 Firefly III | ✅ | ✅ | | | | | | | | | | | | | | |
| 📹 Frigate | | | | | | ✅ | | | | | ✅ | ✅ | ✅ | | | |
| 🐙 Gitea | | | ✅ | | ✅ | | | | | | | | | | | |
| 📱 Immich | | | | ✅ | | | | | | | | | | | | |
| 🍃 MongoDB | | | | | | | | | | | | | | | | ✅ |
| 🔄 n8n | | | | | | | | ✅ | | | | | | | | |
| 🐳 Portainer | | | | | | | | | | | | | | | ✅ | ✅ |
| 🔴 Redis | | | | | | | ✅ | | ✅ | | | | | | | |
| 🗺️ WebMap | | | | | | | | | | ✅ | | | | | | |
## Services
### 🔥 Firefly III
**Ports:** 80 (Core), 81 (Data Importer)
**Description:** Personal finance manager with budgeting, expense tracking, and financial insights. Includes data import capabilities and automated cron jobs for recurring transactions.
### 📹 Frigate
**Ports:** 8971, 5000, 8554, 8555
**Description:** NVR (Network Video Recorder) with real-time object detection using AI. Supports RTSP cameras, USB Coral TPU for hardware acceleration, and provides web interface for monitoring.
### 🐙 Gitea
**Ports:** 3000 (Web), 222 (SSH)
**Description:** Self-hosted Git service similar to GitHub/GitLab. Provides repository hosting, issue tracking, and collaboration tools with PostgreSQL backend.
### 📱 Immich
**Ports:** 2283
**Description:** Self-hosted photo and video backup solution with machine learning capabilities. Features automatic organization, face recognition, and mobile app support.
### 🍃 MongoDB
**Ports:** 27017
**Description:** NoSQL database service for applications requiring flexible document storage and high performance data operations.
### 🔄 n8n
**Ports:** 5678
**Description:** Workflow automation platform that connects different services and APIs. Create automated workflows with a visual interface.
### 🐳 Portainer
**Ports:** 9000, 9443
**Description:** Web-based Docker management interface for managing containers, images, volumes, and networks through a user-friendly GUI.
### 🔴 Redis
**Ports:** 6379 (Redis), 5540 (RedisInsight)
**Description:** In-memory data structure store with RedisInsight for database management and monitoring. Used as cache, message broker, and session store.
### 👀 Watchtower
**Description:** Automated Docker container updater that monitors running containers and automatically updates them to the latest available image versions.
### 🗺️ WebMap
**Ports:** 8001
**Description:** Network discovery and visualization tool that scans network devices and provides a web interface to view network topology and device information.
## Getting Started
Each service is contained in its own directory with a `compose.yaml` file. To start a service:
```bash
cd <service-directory>
docker-compose up -d
```
## Requirements
- Docker and Docker Compose
- Sufficient storage for data volumes
- Network access for services that require external connections