james/homelab-infra
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

CLean up site generation

Browse Source
This commit is contained in:
James Thompson
2026-03-23 04:29:25 +00:00
parent 716baafbc1
commit 90073c1d7a
40 changed files with 487 additions and 880 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/dev/check_env_sync.md Normal file
View File

@@ -0,0 +1,5 @@
# check_env_sync
> Python script documentation
::: scripts.check_env_sync

5
docs/dev/generate_docs.md Normal file
View File

@@ -0,0 +1,5 @@
# generate_docs
> Python script documentation
::: scripts.generate_docs

8
docs/index.md Normal file → Executable file
View File

@@ -1,6 +1,6 @@
# Homelab Documentation
# SJHL Documentation
> Auto-generated from `docker-compose.yml` files
Welcome to Seirian & James' homelab documentation! This is a docs site that is built to easily show all the configs we use. MOst of the content is auto-generated from the actual config files, so it should always be up to date. This should be completely publically viewable as all private information is kept in `.env` files that are not committed to Git. It should provide good information on how to recover and rebuild the homelab if needed, and also just be a nice reference for how everything is configured.
## Data Classification
@@ -17,10 +17,8 @@
|---------|-------|--------|
| [devbox](services/devbox.md) | `devbox-devcontainer` | active |
| [gitea](services/gitea.md) | `gitea/gitea:1.24.3` | active |
| [jellyfin](services/jellyfin.md) | `jellyfin/jellyfin:latest` | active |
| [nextcloud](services/nextcloud.md) | `ghcr.io/nextcloud-releases/all-in-one:latest` | active |
| [obsidian](services/obsidian.md) | `couchdb:latest` | active |
| [qbittorrent](services/qbittorrent.md) | `qmcgaw/gluetun`, `lscr.io/linuxserver/qbittorrent:latest`, `linuxserver/jackett:latest` | active |
| [obsidian-livesync](services/obsidian-livesync.md) | `couchdb:latest` | active |
| [traefik](services/traefik.md) | `traefik:v3.6` | active |
| [whoami](services/whoami.md) | `traefik/whoami` | active |

0
docs/recovery.md Normal file → Executable file
View File

45
docs/services/devbox.md Normal file → Executable file
View File

@@ -1,42 +1,15 @@
# devbox
> Auto-generated from `docker-compose.yml`
> This page auto-includes the service configuration files.
| Field | Value |
|-------|-------|
| **Image** | `devbox-devcontainer` |
| **Container** | `devcontainer` |
| **Restart** | `unless-stopped` |
## Docker Compose Configuration
### Environment
```yaml
--8<-- "devbox/docker-compose.yml"
```
**Env files:** `../.env`
## Environment Variables (`.env.example`)
### Secrets (from `.env.example`)
These variables must be set in the service's `.env` file:
| Variable | Default |
|----------|---------|
| `DEVBOX_SSH_PORT` | `46573` |
| `DEVBOX_MEM_LIMIT` | `10g` |
| `DEVBOX_SWAP_LIMIT` | `20g` |
### Ports
| Host | Container | Protocol |
|------|-----------|----------|
| `${DEVBOX_SSH_PORT:-46573}` | `2222` | tcp |
### Volumes
| Host Path | Container Path | Mode |
|-----------|----------------|------|
| `${STORAGE_PATH}/devbox` | `/home/devuser` | rw |
### Resources
- Memory limit: `${DEVBOX_MEM_LIMIT:-10g}`
- Memory+Swap limit: `${DEVBOX_SWAP_LIMIT:-20g}`
---
```bash
--8<-- "devbox/.env.example"
```

61
docs/services/gitea.md Normal file → Executable file
View File

@@ -1,58 +1,15 @@
# gitea
> Auto-generated from `docker-compose.yml`
> This page auto-includes the service configuration files.
| Field | Value |
|-------|-------|
| **Image** | `gitea/gitea:1.24.3` |
| **Container** | `gitea` |
| **Restart** | `always` |
## Docker Compose Configuration
### Environment
```yaml
--8<-- "gitea/docker-compose.yml"
```
**Env files:** `../.env`, `.env`
## Environment Variables (`.env.example`)
| Variable | Value |
|----------|-------|
| `USER_UID` | `${USER_UID}` |
| `USER_GID` | `${USER_GID}` |
| `GITEA__database__DB_TYPE` | `sqlite3` |
| `GITEA__server__ROOT_URL` | `https://gitea.${DOMAIN}/` |
| `USER` | `git` |
| `GITEA_CUSTOM` | `/data/gitea` |
### Ports
| Host | Container | Protocol |
|------|-----------|----------|
| `222` | `22` | tcp |
### Volumes
| Host Path | Container Path | Mode |
|-----------|----------------|------|
| `${STORAGE_PATH}/gitea` | `/data` | rw |
| `/etc/timezone` | `/etc/timezone` | ro |
| `/etc/localtime` | `/etc/localtime` | ro |
### Networks
- `gitea` (internal)
- `web` (internal)
### Labels
| Key | Value |
|-----|-------|
| `traefik.enable` | `true` |
| `traefik.http.routers.gitea.entrypoints` | `websecure` |
| `traefik.http.routers.gitea.rule` | `Host(`gitea.${DOMAIN}`)` |
| `traefik.http.routers.gitea.tls.certresolver` | `letsencrypt` |
| `traefik.http.services.gitea.loadbalancer.server.port` | `3000` |
### Networks (compose-level)
- `gitea` (internal)
- `web` (external)
---
```bash
--8<-- "gitea/.env.example"
```

55
docs/services/jellyfin.md
View File

@@ -1,55 +0,0 @@
# jellyfin
> Auto-generated from `docker-compose.yml`
| Field | Value |
|-------|-------|
| **Image** | `jellyfin/jellyfin:latest` |
| **Container** | `jellyfin` |
| **Restart** | `unless-stopped` |
### Environment
**Env files:** `../.env`
### Secrets (from `.env.example`)
These variables must be set in the service's `.env` file:
| Variable | Default |
|----------|---------|
| `JELLYFIN_PORT` | `8096` |
### Ports
| Host | Container | Protocol |
|------|-----------|----------|
| `${JELLYFIN_PORT:-8096}` | `8096` | tcp |
### Volumes
| Host Path | Container Path | Mode |
|-----------|----------------|------|
| `${STORAGE_PATH}/jellyfin/config` | `/config` | rw |
| `${STORAGE_PATH}/jellyfin/cache` | `/cache` | rw |
| `${MEDIA_PATH}` | `/media` | rw |
### Networks
- `web` (internal)
### Labels
| Key | Value |
|-----|-------|
| `traefik.enable` | `true` |
| `traefik.http.routers.jellyfin.entrypoints` | `websecure` |
| `traefik.http.routers.jellyfin.rule` | `Host(`jellyfin.${DOMAIN}`)` |
| `traefik.http.routers.jellyfin.tls.certresolver` | `letsencrypt` |
| `traefik.http.services.jellyfin.loadbalancer.server.port` | `8096` |
### Networks (compose-level)
- `web` (external)
---

9
docs/services/n8n.md
View File

@@ -1,9 +0,0 @@
# N8N
Workflow automation platform. **Planned - not yet deployed.**
## Planned Configuration
- **URL:** `https://n8n.sjhl.nz`
- **Port:** 5678
- **Data:** `/mnt/storage/docker-data/n8n`

59
docs/services/nextcloud.md Normal file → Executable file
View File

@@ -1,56 +1,15 @@
# nextcloud
> Auto-generated from `docker-compose.yml`
> This page auto-includes the service configuration files.
| Field | Value |
|-------|-------|
| **Image** | `ghcr.io/nextcloud-releases/all-in-one:latest` |
| **Container** | `nextcloud-aio-mastercontainer` |
| **Restart** | `always` |
## Docker Compose Configuration
### Environment
```yaml
--8<-- "nextcloud/docker-compose.yml"
```
**Env files:** `../.env`
## Environment Variables (`.env.example`)
| Variable | Value |
|----------|-------|
| `APACHE_PORT` | `11000` |
| `NEXTCLOUD_DATADIR` | `${STORAGE_PATH}/nextcloud` |
| `APACHE_ADDITIONAL_NETWORK` | `web` |
### Secrets (from `.env.example`)
These variables must be set in the service's `.env` file:
| Variable | Default |
|----------|---------|
| `AIO_PORT` | `8081` |
### Ports
| Host | Container | Protocol |
|------|-----------|----------|
| `${AIO_PORT:-8081}` | `8080` | tcp |
### Volumes
| Host Path | Container Path | Mode |
|-----------|----------------|------|
| `nextcloud_aio_mastercontainer` | `/mnt/docker-aio-config` | rw |
| `/var/run/docker.sock` | `/var/run/docker.sock` | ro |
### Networks
- `nextcloud-aio` (internal)
- `web` (internal)
### Named Volumes (compose-level)
- `nextcloud_aio_mastercontainer` (managed by compose)
### Networks (compose-level)
- `nextcloud-aio` (internal)
- `web` (external)
---
```bash
--8<-- "nextcloud/.env.example"
```

15
docs/services/obsidian-livesync.md Executable file
View File

@@ -0,0 +1,15 @@
# obsidian-livesync
> This page auto-includes the service configuration files.
## Docker Compose Configuration
```yaml
--8<-- "obsidian-livesync/docker-compose.yml"
```
## Environment Variables (`.env.example`)
```bash
--8<-- "obsidian-livesync/.env.example"
```

42
docs/services/obsidian.md
View File

@@ -1,42 +0,0 @@
# obsidian
> Auto-generated from `docker-compose.yml`
| Field | Value |
|-------|-------|
| **Image** | `couchdb:latest` |
| **Container** | `obsidian-livesync` |
| **Restart** | `unless-stopped` |
### Environment
**Env files:** `../.env`, `.env`
| Variable | Value |
|----------|-------|
| `COUCHDB_USER` | `${COUCHDB_USER:-admin}` |
| `COUCHDB_PASSWORD` | `${COUCHDB_PASSWORD}` |
### Secrets (from `.env.example`)
These variables must be set in the service's `.env` file:
| Variable | Default |
|----------|---------|
| `COUCHDB_USER` | `admin` |
| `COUCHDB_PASSWORD` | `REPLACE_WITH_STRONG_PASSWORD` |
| `COUCHDB_PORT` | `5984` |
### Ports
| Host | Container | Protocol |
|------|-----------|----------|
| `${COUCHDB_PORT:-5984}` | `5984` | tcp |
### Volumes
| Host Path | Container Path | Mode |
|-----------|----------------|------|
| `${STORAGE_PATH}/obsidian` | `/opt/couchdb/data` | rw |
---

153
docs/services/qbittorrent.md
View File

@@ -1,153 +0,0 @@
# qbittorrent
> Auto-generated from `docker-compose.yml`
## `gluetun`
| Field | Value |
|-------|-------|
| **Image** | `qmcgaw/gluetun` |
| **Container** | `qbittorrent_gluetun` |
| **Restart** | `unless-stopped` |
### Environment
**Env files:** `../.env`, `.env`
| Variable | Value |
|----------|-------|
| `VPN_SERVICE_PROVIDER` | `protonvpn` |
| `VPN_TYPE` | `wireguard` |
| `VPN_PORT_FORWARDING` | `on` |
| `TZ` | `${TZ}` |
| `SERVER_COUNTRIES` | `New Zealand` |
| `PORT_FORWARD_ONLY` | `on` |
| `VPN_PORT_FORWARDING_UP_COMMAND` | `/bin/sh -c 'wget -O- --post-data "json={\"listen_port\":{{PORTS}}}" http://localhost:8080/api/v2/app/setPreferences 2>/dev/null || true'` |
### Secrets (from `.env.example`)
These variables must be set in the service's `.env` file:
| Variable | Default |
|----------|---------|
| `WIREGUARD_PRIVATE_KEY` | `REPLACE_WITH_YOUR_WIREGUARD_PRIVATE_KEY` |
| `QBITTORRENT_PORT` | `8080` |
| `JACKETT_PORT` | `9117` |
### Ports
| Host | Container | Protocol |
|------|-----------|----------|
| `${QBITTORRENT_PORT:-8080}` | `8080` | tcp |
| `${JACKETT_PORT:-9117}` | `9117` | tcp |
### Volumes
| Host Path | Container Path | Mode |
|-----------|----------------|------|
| `${STORAGE_PATH}/qbittorrent/gluetun` | `/gluetun` | rw |
| `${STORAGE_PATH}/qbittorrent/wireguard` | `/gluetun/wireguard` | rw |
### Networks
- `qbittorrent` (internal)
### Capabilities
`NET_ADMIN`
### Devices
- `/dev/net/tun:/dev/net/tun`
### Networks (compose-level)
- `qbittorrent` (internal)
---
## `qbittorrent`
| Field | Value |
|-------|-------|
| **Image** | `lscr.io/linuxserver/qbittorrent:latest` |
| **Container** | `qbittorrent` |
| **Restart** | `unless-stopped` |
### Environment
| Variable | Value |
|----------|-------|
| `TZ` | `${TZ}` |
| `WEBUI_PORT` | `8080` |
| `PUID` | `${USER_UID}` |
| `PGID` | `${USER_GID}` |
### Secrets (from `.env.example`)
These variables must be set in the service's `.env` file:
| Variable | Default |
|----------|---------|
| `WIREGUARD_PRIVATE_KEY` | `REPLACE_WITH_YOUR_WIREGUARD_PRIVATE_KEY` |
| `QBITTORRENT_PORT` | `8080` |
| `JACKETT_PORT` | `9117` |
### Volumes
| Host Path | Container Path | Mode |
|-----------|----------------|------|
| `${STORAGE_PATH}/qbittorrent/config` | `/config` | rw |
| `${MEDIA_PATH}/torrents` | `/downloads` | rw |
### Dependencies
- `gluetun`
### Networks (compose-level)
- `qbittorrent` (internal)
---
## `jackett`
| Field | Value |
|-------|-------|
| **Image** | `linuxserver/jackett:latest` |
| **Container** | `jackett` |
| **Restart** | `unless-stopped` |
### Environment
| Variable | Value |
|----------|-------|
| `TZ` | `${TZ}` |
| `PUID` | `${USER_UID}` |
| `PGID` | `${USER_GID}` |
### Secrets (from `.env.example`)
These variables must be set in the service's `.env` file:
| Variable | Default |
|----------|---------|
| `WIREGUARD_PRIVATE_KEY` | `REPLACE_WITH_YOUR_WIREGUARD_PRIVATE_KEY` |
| `QBITTORRENT_PORT` | `8080` |
| `JACKETT_PORT` | `9117` |
### Volumes
| Host Path | Container Path | Mode |
|-----------|----------------|------|
| `${STORAGE_PATH}/qbittorrent/config/jackett` | `/config` | rw |
### Dependencies
- `gluetun`
### Networks (compose-level)
- `qbittorrent` (internal)
---

9
docs/services/supersync.md
View File

@@ -1,9 +0,0 @@
# Supersync
File synchronization service. **Planned - not yet deployed.**
## Planned Configuration
- **URL:** `https://supersync.sjhl.nz`
- **Port:** 8443
- **Data:** `/mnt/storage/docker-data/supersync`

69
docs/services/traefik.md Normal file → Executable file
View File

@@ -1,67 +1,16 @@
# traefik
> Auto-generated from `docker-compose.yml`
> This page auto-includes the service configuration files.
| Field | Value |
|-------|-------|
| **Image** | `traefik:v3.6` |
| **Container** | `traefik` |
| **Restart** | `unless-stopped` |
--8<-- "traefik/README.md"
## Docker Compose Configuration
### Command
```
--entrypoints.web.address=:80 --entrypoints.web.http.redirections.entrypoint.to=websecure --entrypoints.web.http.redirections.entrypoint.scheme=https --entrypoints.websecure.address=:443 --providers.docker=true --providers.docker.exposedbydefault=false --providers.docker.network=web --certificatesresolvers.letsencrypt.acme.httpchallenge=true --certificatesresolvers.letsencrypt.acme.httpchallenge.entrypoint=web --certificatesresolvers.letsencrypt.acme.email=${ACME_EMAIL} --certificatesresolvers.letsencrypt.acme.storage=/certs/acme.json --metrics.prometheus=true --accesslog=true --providers.file.directory=/dynamic --providers.file.watch=true
```yaml
--8<-- "traefik/docker-compose.yml"
```
### Secrets (from `.env.example`)
## Environment Variables (`.env.example`)
These variables must be set in the service's `.env` file:
| Variable | Default |
|----------|---------|
| `TRAEFIK_DASHBOARD_PORT` | `8082` |
| `ACME_EMAIL` | `letsencrypt@example.com` |
| `DASHBOARD_BASIC_AUTH` | `admin:$$apr1$$changeme$$REPLACE_WITH_HTPASSWD_HASH` |
### Ports
| Host | Container | Protocol |
|------|-----------|----------|
| `80` | `80` | tcp |
| `443` | `443` | tcp |
| `${TRAEFIK_DASHBOARD_PORT:-8082}` | `8080` | tcp |
### Volumes
| Host Path | Container Path | Mode |
|-----------|----------------|------|
| `/var/run/docker.sock` | `/var/run/docker.sock` | ro |
| `${STORAGE_PATH}/traefik/certs` | `/certs` | rw |
| `${STORAGE_PATH}/traefik/dynamic` | `/dynamic` | ro |
### Networks
- `web` (internal)
### Security Options
- `no-new-privileges:true`
### Labels
| Key | Value |
|-----|-------|
| `traefik.enable` | `true` |
| `traefik.http.middlewares.dashboard-auth.basicauth.users` | `${DASHBOARD_BASIC_AUTH}` |
| `traefik.http.routers.dashboard.entrypoints` | `websecure` |
| `traefik.http.routers.dashboard.middlewares` | `dashboard-auth@docker` |
| `traefik.http.routers.dashboard.rule` | `Host(`dashboard.${DOMAIN}`)` |
| `traefik.http.routers.dashboard.service` | `api@internal` |
| `traefik.http.routers.dashboard.tls` | `true` |
### Networks (compose-level)
- `web` (external)
---
```bash
--8<-- "traefik/.env.example"
```

29
docs/services/whoami.md Normal file → Executable file
View File

@@ -1,28 +1,9 @@
# whoami
> Auto-generated from `docker-compose.yml`
> This page auto-includes the service configuration files.
| Field | Value |
|-------|-------|
| **Image** | `traefik/whoami` |
| **Container** | `whoami` |
| **Restart** | `unless-stopped` |
## Docker Compose Configuration
### Networks
- `web` (internal)
### Labels
| Key | Value |
|-----|-------|
| `traefik.enable` | `true` |
| `traefik.http.routers.whoami.entrypoints` | `websecure` |
| `traefik.http.routers.whoami.rule` | `Host(`whoami.${DOMAIN}`)` |
| `traefik.http.routers.whoami.tls` | `true` |
### Networks (compose-level)
- `web` (external)
---
```yaml
--8<-- "whoami/docker-compose.yml"
```