Update README.md with new service details, add healthcheck improvements for Immich, and remove deprecated Watchtower service configuration.
This commit is contained in:
GSRN
65
README.md
65
README.md
@@ -4,17 +4,18 @@ 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 | | | | | | | | | | ✅ | | | | | | |
|
||||
| Service | 80 | 81 | 222 | 2283 | 3000 | 5000 | 5540 | 5678 | 6379 | 8001 | 8554 | 8555 | 8971 | 9000 | 9443 | 9999 | 27017 |
|
||||
|---------|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|
|
||||
| 🔥 Firefly III | ✅ | ✅ | | | | | | | | | | | | | | | |
|
||||
| 📹 Frigate | | | | | | ✅ | | | | | ✅ | ✅ | ✅ | | | | |
|
||||
| 🐙 Gitea | | | ✅ | | ✅ | | | | | | | | | | | | |
|
||||
| 📱 Immich | | | | ✅ | | | | | | | | | | | | | |
|
||||
| 🍃 MongoDB | | | | | | | | | | | | | | | | | ✅ |
|
||||
| 🔄 n8n | | | | | | | | ✅ | | | | | | | | | |
|
||||
| 🐳 Portainer | | | | | | | | | | | | | | ✅ | ✅ | | |
|
||||
| 🔴 Redis | | | | | | | ✅ | | ✅ | | | | | | | | |
|
||||
| 📊 What's Up Docker | | | | | | | | | | | | | | | | ✅ | |
|
||||
| 🗺️ WebMap | | | | | | | | | | ✅ | | | | | | | |
|
||||
|
||||
## Services
|
||||
|
||||
@@ -23,8 +24,9 @@ A collection of Docker services for a home lab environment.
|
||||
**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.
|
||||
**Ports:** 8971 (Web UI), 5000 (Internal API), 8554 (RTSP), 8555 (WebRTC)
|
||||
**Description:** AI-powered NVR with real-time object detection using USB Coral TPU. Features face recognition, license plate recognition, and motion detection with custom zones.
|
||||
**Configuration:** 3 cameras (achtertuin, tuinhuis, carport) via NVR at 192.168.2.26. MQTT integration with Home Assistant for automation. Recording strategy: motion/detection clips retained for 3 days, no continuous recording.
|
||||
|
||||
### 🐙 Gitea
|
||||
**Ports:** 3000 (Web), 222 (SSH)
|
||||
@@ -32,7 +34,8 @@ A collection of Docker services for a home lab environment.
|
||||
|
||||
### 📱 Immich
|
||||
**Ports:** 2283
|
||||
**Description:** Self-hosted photo and video backup solution with machine learning capabilities. Features automatic organization, face recognition, and mobile app support.
|
||||
**Description:** Self-hosted photo and video backup solution with machine learning capabilities. Features automatic organization, face recognition, and mobile app support.
|
||||
**Notes:** Healthcheck uses bash TCP probe on `localhost:2283`. Database is optimized for HDD with `DB_STORAGE_TYPE: 'HDD'`.
|
||||
|
||||
### 🍃 MongoDB
|
||||
**Ports:** 27017
|
||||
@@ -50,8 +53,10 @@ A collection of Docker services for a home lab environment.
|
||||
**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.
|
||||
### 📊 What's Up Docker
|
||||
**Ports:** 9999
|
||||
**Description:** Web-based container update monitoring tool that tracks available updates for Docker containers. Provides a dashboard to view outdated containers and sends notifications via webhooks.
|
||||
**Notes:** Webhook configured to send update notifications to external endpoint.
|
||||
|
||||
### 🗺️ WebMap
|
||||
**Ports:** 8001
|
||||
@@ -59,13 +64,39 @@ A collection of Docker services for a home lab environment.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Each service is contained in its own directory with a `compose.yaml` file. To start a service:
|
||||
### Option 1: Single Command (Recommended)
|
||||
Start all services with one command:
|
||||
|
||||
```bash
|
||||
# Start all services
|
||||
docker-compose up -d
|
||||
|
||||
# Or use the management script
|
||||
./manage.sh start
|
||||
```
|
||||
|
||||
### Option 2: Individual Services
|
||||
Each service is contained in its own directory with a `compose.yaml` file:
|
||||
|
||||
```bash
|
||||
cd <service-directory>
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### Management Script
|
||||
Use the included `manage.sh` script for easy management:
|
||||
|
||||
```bash
|
||||
./manage.sh start # Start all services
|
||||
./manage.sh stop # Stop all services
|
||||
./manage.sh restart # Restart all services
|
||||
./manage.sh status # Show service status
|
||||
./manage.sh logs [service] # View logs
|
||||
./manage.sh update # Update and restart
|
||||
./manage.sh backup # Backup data volumes
|
||||
./manage.sh clean # Clean up unused resources
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- Docker and Docker Compose
|
||||
|
||||
Reference in New Issue
Block a user