Self-host Material for MkDocs on a VPS
A documentation site generator with a searchable Material theme. This serves your Markdown files live; put them in the docs volume and edit the generated config to set the site name and navigation.
levelrail-cli templates deploy mkdocs-material --name my-mkdocs-materialSpecification
- Status
- Listed
- Category
- Developer Tools
- Services
- mkdocs-material
- Ports
- 8000
- Volumes
- 1
- Memory
- about 256 MiB
- arm64
- unknown
- amd64
- unknown
- Settings to fill in
- none
- License
- Permissive license, MIT
- Listing
- Community template
About Material for MkDocs
A documentation site generator with a searchable Material theme. This serves your Markdown files live; put them in the docs volume and edit the generated config to set the site name and navigation.
What it deploys
Material for MkDocs runs as one service in a single Compose app, listening on port 8000, with 1 named volume mount.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| mkdocs-material | squidfunk/mkdocs-material | 9.8.0 | 8000 | docs -> /docs/docs |
Before you install
- CPU architecture. arm64 unknown. The scan could not read a manifest or the tag is chosen at install time. This is not a claim either way.
- Listed. It is in the catalog. Back up the data volume before changing an image tag.
Settings and environment
The catalog lists no environment variables for this template.
Install Material for MkDocs on a VPS
-
Install Levelrail on a fresh VPS
Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.
curl -fsSL https://levelrail.com/install.sh | sudo sh -
Sign in
Open the setup link, choose a password, then log the CLI in. The CLI install command is
curl -fsSL https://levelrail.com/install-cli.sh | shif the machine does not have it. See Getting started.levelrail-cli login --device -
Read the template
Shows the entry, including its full compose.yaml.
levelrail-cli templates get mkdocs-material -
Deploy it
This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.
levelrail-cli templates deploy mkdocs-material --name my-mkdocs-material
Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Material for MkDocs.
Docs and upstream
More in Developer Tools
- marimoA reactive Python notebook that is reproducible, git-friendly, and shareable as an app.
- MailpitA local SMTP server and web inbox for catching and inspecting outgoing email during development.
- MAZANOKEA private image optimizer that compresses and converts photos in the browser. Images are processed on the visitor device and never uploaded to the server.
- MailHogAn SMTP test server that catches outgoing mail from your apps and shows it in a web inbox.
- MCP InspectorThe official visual tester for Model Context Protocol servers: connect, list tools and resources and call them from the browser. MIT licensed. Open the logs to copy the session token.
- MailCatcherA development SMTP server that catches every message and shows it in a web inbox. Send mail from services in this project to mailcatcher:1025. Messages are kept in memory only.