Homelab-runbooks
A self-hosted MkDocs Material server that renders any Markdown docs site — runbooks, wikis, or project docs with an mkdocs.yml — into a live, browsable website.
Platform availability
Available on 1 of 10 platforms
- Unraid
- TrueNAS (not listed)
- Umbrel (not listed)
- ZimaOS (not listed)
- Proxmox (not listed)
- Helm (not listed)
- Mac (not listed)
- Windows (not listed)
- Linux (not listed)
- Any server (not listed)
Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.
48/100 Fair
- Maintained
- 84last commit 14 days ago
- Popular
- 00 GitHub stars
- Easy to install
- 351 install platform, install notes, Docker image
- Light to run
- No data
Based on 3 of 4 factors.
Availability: platform listings confirmed today, links checked 53 days ago
- GitHub stars
- 0
- Open issues
- 1
- Last commit
- 2026-11-07
- Activity
- declining
Checked 12 days ago - source: GitHub (davide97g/homelab)
Resources & Compatibility
ARM (e.g. Raspberry Pi) is supported.
Checked 54 days ago - source: Docker Hub image tags and published docs
First-install notes
- Fill your .env and secrets first Copy docs/example.env to .env and docs/example-secrets to secrets/, then replace your domain, Cloudflare/DuckDNS credentials, PUID/PGID (the user and group IDs the containers run as), timezone, and OAuth/secret values. Starting with missing or placeholder values can break reverse proxy, DNS, logins, or file ownership. source
- Set up Let's Encrypt certificate storage Run make config-acme (or homelab config-acme) once before starting core services to create the secured acme.json file for Traefik. Without it, Traefik cannot save HTTPS certificates, so your apps may fail to get or serve TLS. source
- Start core services before the rest Use homelab core-up (or make core-up) to start the base pieces like Traefik and OAuth2 before adding media or app services. This gives the rest of your stack the login and web routing foundation it needs. source
- Source your docs from a git repository Point the container at a read-only clone of your docs git repository. Edit the Markdown in the repo (on GitHub or locally) and pull to refresh the site; avoid editing files directly inside the container, as changes there won't persist. source
Fetched 37 days ago - each note links to its source
Variants
Alternatives
No alternatives collected yet.
Common questions
Do I need to know HTML, CSS, or JavaScript to write the runbooks?
No. You write the docs in Markdown and let MkDocs Material generate the site.
Do I need a third-party crawler for docs search?
No. MkDocs Material includes built-in search that runs entirely in the user's browser without a third-party crawler.
Can I customize the look of the docs site?
You can change colors, fonts, language, icons, logo, and other appearance options through configuration.
Should I start core services before adding other app services?
Use homelab core-up to start Traefik and OAuth2 before adding media or app services. This gives the rest of your stack the login and web routing foundation it needs.
Do I need to create the ACME config before starting core services?
Run make config-acme once before starting core services to create the acme.json file for Traefik. Without it, Traefik cannot save HTTPS certificates and apps may fail to get or serve TLS.
Answers sourced from context7.com, github.com, squidfunk.github.io
Community
- Project Homelab Forums (forum)
- Do you guys have a "Run Book" for your home life : r/homelab - Reddit (reddit)
- faq - homelab - Reddit (reddit)
Collected 53 days ago - public community threads