Self-host Material for MkDocs with Levelrail

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.

  • Authorsquidfunk
  • LicenceMIT
  • Memory256 MiB
  • Services1

How to self-host Material for MkDocs

  1. Pull the images

    One image is pulled on your server.

    Show images
    • squidfunk/mkdocs-material:9.8.0
  2. Create the app

    One service starts in a single Compose app, with 1 named volume mount for your data, on port 8000.

  3. Fill in the secrets

    You do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

Material for MkDocs requirements

Memory
About 256 MiB
Architectures
amd64 unknown, arm64 unknown
Ports
8000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
MIT, permissive license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Material for MkDocs. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Material for MkDocs docs page.

Deploy Material for MkDocs your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Material for MkDocs from the CLI

levelrail-cli templates deploy mkdocs-material --name my-mkdocs-material

Deploy Material for MkDocs with the API

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/mkdocs-material/deploy

Material for MkDocs configuration

Material for MkDocs services

ServiceImagePortsVolumes
mkdocs-material squidfunk/mkdocs-material:9.8.0 8000 docs -> /docs/docs

Material for MkDocs environment variables

The catalog lists no environment variables for this template.

Ports and volumes

Ports
8000
Volumes
1 named mount: docs -> /docs/docs

Material for MkDocs FAQ

How much memory does Material for MkDocs need?

The catalog lists about 256 MiB of memory for Material for MkDocs.

Does Material for MkDocs run on arm64?

For Material for MkDocs, arm64 support is not confirmed; amd64 is unknown.

What licence is Material for MkDocs under?

Material for MkDocs is licensed under MIT, which is permissive, with few conditions on reuse.

Does Material for MkDocs need configuration before it starts?

No. The template fills in its own defaults.

Which ports does Material for MkDocs use?

Material for MkDocs listens on port 8000 inside the stack.

Where does Material for MkDocs keep its data?

In a named volume: docs mounted at /docs/docs.

Can I deploy Material for MkDocs on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Material for MkDocs, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image squidfunk/mkdocs-material:9.8.0 is what you deploy there.

levelrail-cli templates deploy mkdocs-material --name my-mkdocs-material