# Homelab-runbooks

Homelab-runbooks is a self-hosted productivity app. 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. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/533/homelab-runbooks

## Description

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. Point the container at a read-only clone of your own docs git repo and pull to refresh after editing the Markdown on GitHub or locally, never inside the container.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

45/100 (Fair), based on 3 of 4 factors.
- Maintained: 79 (last commit 12 days ago)
- Popular: 0 (0 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/squidfunk/mkdocs-material
- GitHub: https://github.com/davide97g/homelab
- Unraid: https://ca.unraid.net/apps/homelab-runbooks-0rfmai11rthhnh?q=homelab-runbooks
- Official website: https://squidfunk.github.io/mkdocs-material/

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/533/homelab-runbooks), the self-hosted and open-source app directory.