mligor/markdown-web repository overview

⁠Markdown Web

Self-hosted markdown notes in the browser — filesystem vault, single Go binary, Basic auth.

The image is a minimal Alpine runtime with a statically linked binary.

⁠Quick start

docker run -d --name markdown-web \
  -p 8080:8080 \
  -e AUTH_USERNAME=admin \
  -e AUTH_PASSWORD=changeme \
  -v markdown-web-vault:/data/vault \
  mligor/markdown-web:latest

Open http://localhost:8080⁠ — sign in with admin / changeme.

⁠Docker Compose

services:
  markdown-web:
    image: mligor/markdown-web:latest
    ports:
      - "8080:8080"
    environment:
      VAULT_PATH: /data/vault
      AUTH_USERNAME: admin
      AUTH_PASSWORD: changeme
      LISTEN_ADDRESS: ":8080"
    volumes:
      - ./vault:/data/vault
    restart: unless-stopped

⁠Platforms

Docker pulls the matching arch automatically on Apple Silicon, Raspberry Pi, and x86_64 servers.

⁠Configuration

Put a reverse proxy with TLS in front (Caddy, nginx, Traefik). Do not expose Basic auth on the public internet over plain HTTP.

⁠Volumes

Mount a persistent volume at /data/vault. Notes are ordinary markdown files; the search index lives under .markdown-web/ inside the vault.