Documentation

Guides for installing, writing with and connecting BurzBlog, and the reference for its API and security model.

Guides

• Running BurzBlog

  BurzBlog is one binary and one SQLite file. These steps run it under systemd on a Raspberry Pi or any Linux host, behind HTTPS.

• Writing from the terminal

  The burzblog binary is also the client. Posts always live on the server; files on your computer are working copies.

• Connecting your website

  BurzBlog is where posts are written. Your website stays a separate project, built and hosted wherever you like. While it builds, it downloads the published posts from BurzBlog as Markdown files.

• Containers

  The plain binary under systemd is the simplest way to run BurzBlog (see self-hosting). If you prefer containers, the image holds the same single binary on a distroless base, under 20 MB.

Reference

• HTTP API

  Everything the panel, the CLI and the website do goes through this JSON API under /api. There are no unauthenticated content routes. The one public route outside /api serves uploaded files at /media/{name}; see Media.

• Security model

  BurzBlog is a private writing tool for a few trusted authors. Readers never talk to it; they read the website your build produces.

• Architecture

  BurzBlog is one Go binary, burzblog. It is the server, the browser panel it serves, and the terminal client: