How devallek/homeserverconfig works
1. Nature of the repo
This is not an application codebase; it is a centralized home-server configuration and documentation repo for a Debian-based machine named *Firebat*. The repository is split into two architectural layers: OS-level services and Dockerized service stacks.
2. Host platform boundary
The physical host is a small home server running Debian 13.0.1 on an Intel N100 / 16 Go RAM / SSD setup. The repo documents how to turn that host into a multi-service server rather than describing a single product.
3. OS configuration layer (OsConfig/)
This folder contains server-side operational guides and scripts for services that live directly on the OS, not in containers. It covers SSH, Samba, XRDP, and Cloudflared, plus a bootstrapping script (AutoConfig.sh) and terminal customization via Starship.
4. Remote administration and access paths
The host is designed for both command-line and GUI administration: SSH is the primary remote control path, XRDP provides remote desktop access, and Cloudflared adds a zero-trust / tunnel-based access boundary for services or host endpoints without exposing them directly.
5. File-sharing subsystem
Samba is the main host-level file-sharing layer. It exposes shared folders from the Debian machine to the local network, making the server both a compute node and a storage/access point.
6. Docker orchestration layer (Docker/)
Each service group has its own directory with a dedicated docker-compose.yml and, when needed, an environment file. The architecture is intentionally stack-based and isolated: each folder is one independently managed deployment boundary.
7. Core application stacks
The Docker layer includes multiple functional stacks:
- Portfolio: WordPress + MySQL + phpMyAdmin
- Domotique: Home Assistant + Eclipse Mosquitto
- JellyPack: Jellyfin-centric media stack with additional supporting services
- N8N: workflow automation / integration platform
- Uptime Kuma: service monitoring
- YouTrack: project management
- DNSAdBlock: DNS-level ad blocking / filtering stack
8. Internal data flows between services
The most explicit service-to-service dependency in the repo is the Portfolio stack: WordPress depends on MySQL, and phpMyAdmin is used to inspect/manage that database. In Domotique, Home Assistant is paired with MQTT via Mosquitto, indicating event-driven home automation messaging.
9. Operational separation and persistence
The repo’s structure suggests a deliberate separation between documentation, configuration, and runtime state. Environment files such as portfolio.env and youtrack.env isolate sensitive or stack-specific settings, while the compose files define service lifecycles independently.
10. What to draw in an architecture diagram
A good diagram would show:
- one Debian host at the center,
- a left/top branch for OS services (SSH, Samba, XRDP, Cloudflared),
- a right/bottom branch for Docker stacks (Portfolio, Domotique, JellyPack, N8N, Uptime Kuma, YouTrack, DNSAdBlock),
- and internal arrows only where the repo clearly defines dependencies, especially WordPress → MySQL and Home Assistant ↔ Mosquitto.
Main entry points: Docker Docker Stacks · OsConfig OS Config · Portfolio Portfolio · Domotique Domotique
Components 22
Repository
Documentation and configuration for the home server
- Repo · Centralized home-server documentation and configuration
Host
Physical Debian machine boundary
- Firebat · Debian 13 home server on Intel N100 hardware
OS layer
Direct-on-host services and bootstrap configuration
- OS Config · Host-level service guides and bootstrap scripts
OsConfig - Bootstrap · Initial host provisioning and setup script
OsConfig/AutoConfig.sh - SSH · Primary command-line remote administration
OsConfig/SrvSSH.md - Samba · Network shares exposed from the host
OsConfig/SrvSamba.md - XRDP · GUI access path to the host
OsConfig/SrvXRP.md - Cloudflared · Zero-trust tunnel boundary for host endpoints and services
OsConfig/Cloudflared.md - Starship · Terminal customization profiles for host usage
OsConfig/Starship
Docker layer
Isolated compose-based service stacks
- Docker Stacks · Directory of isolated docker-compose deployments
Docker - Portfolio · WordPress-based site stack
Docker/Portfolio - WordPress · Main content application
- MySQL · Persistence layer for the Portfolio stack
- phpMyAdmin · Database inspection and administration UI
- Domotique · Home Assistant and MQTT automation stack
Docker/Domotique - Home Assistant · Automation control plane
- Mosquitto · Event messaging broker for home automation
- JellyPack · Jellyfin-centric media services
Docker/JellyPack - N8N · Workflow automation and integrations
Docker/N8N - Uptime Kuma · Service and endpoint monitoring
Docker/UptimeKuma - YouTrack · Issue tracking and project management stack
Docker/YouTrack - DNSAdBlock · DNS-level ad blocking and filtering stack
Docker/DNSAdBlock
Connections 26
- Repo → OS Config: documents · Repository includes host-level operational guidance
- Repo → Docker Stacks: documents · Repository includes compose-managed service stacks
- Firebat → OS Config: runs · OS services live directly on the host
- Firebat → Docker Stacks: hosts · Docker deployments run on the Debian machine
- OS Config → Bootstrap: bootstrap · Initial provisioning script
- OS Config → SSH: admin access · Primary remote shell path
- OS Config → Samba: sharing · Host file sharing service
- OS Config → XRDP: gui access · Remote desktop access path
- OS Config → Cloudflared: tunnel · Zero-trust access boundary
- OS Config → Starship: shell UX · Terminal prompt customization
- Docker Stacks → Portfolio: deploys · Independent compose stack
- Docker Stacks → Domotique: deploys · Independent compose stack
- Docker Stacks → JellyPack: deploys · Independent compose stack
- Docker Stacks → N8N: deploys · Independent compose stack
- Docker Stacks → Uptime Kuma: deploys · Independent compose stack
- Docker Stacks → YouTrack: deploys · Independent compose stack
- Docker Stacks → DNSAdBlock: deploys · Independent compose stack
- Portfolio → WordPress: contains · Main application in the stack
- Portfolio → MySQL: contains · Database backend in the stack
- Portfolio → phpMyAdmin: contains · Database administration component
- WordPress → MySQL: reads/writes · WordPress depends on MySQL persistence
- phpMyAdmin → MySQL: manages · phpMyAdmin operates on the MySQL database
- Domotique → Home Assistant: contains · Automation control application
- Domotique → Mosquitto: contains · MQTT broker in the automation stack
- Home Assistant → Mosquitto: publishes/subscribes · Event-driven home automation messaging
- Mosquitto → Home Assistant: events · Broker delivers MQTT messages back to automation