← Directory

homelab-runbooks

Serves any MkDocs Material docs site (runbooks, wikis, project docs - anything written in Markdown with an mkdocs.yml) as a live-rendered site.

  • Productivity
  • Tools & Utilities
  • Web & Publishing
Serves any MkDocs Material docs site (runbooks, wikis, project docs - anything written in Markdown with an mkdocs.yml) as a live-rendered site. Point it at a read-only clone of your own docs git repo; edit the source on GitHub or locally, not in the container, and pull to refresh.

Platform availability

Available on 1 of 9 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)

Health score

Not enough data yet for a health score. It needs at least 2 of 4 factors: maintenance, popularity, ease of install, resource needs.

Availability: platform listings confirmed today, links checked 15 days ago

No GitHub repository data collected yet.

Resources & Compatibility

ARM (e.g. Raspberry Pi) is supported.

Checked 17 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

Fetched 17 days ago - each note links to its source

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

Collected 16 days ago - public community threads