pixie / docs
SOURCE GUIDE GitHub ↗
User guide

Put your pages online.

Pixie maps simple URL names to HTML files in a single directory.

Create a site directory

mkdir -p my-site
printf '<!doctype html><title>My site</title><h1>Hello</h1>' > my-site/hello.html
printf '<!doctype html><title>About</title><h1>About us</h1>' > my-site/about.html
printf '<!doctype html><title>Not found</title><h1>Page not found</h1>' > my-site/404.html
Request File
/ hello.html
/about about.html
/about?lang=en about.html
/missing 404.html, with status 404

Mount a site into Docker

From the directory containing my-site/:

docker run --rm -p 8080:8080 \
  -v "$PWD/my-site:/usr/share/pixie/web:ro" \
  -e PIXIE_WEB_ROOT=/usr/share/pixie/web \
  ghcr.io/laflut3/pixie:latest

For a local source build, set PIXIE_WEB_ROOT to the same directory instead. Each request reads the current file; restarting is unnecessary for page edits.

Use your Linux service

The packaged service uses /usr/share/pixie/web. To use a custom root, add a systemd override:

sudo systemctl edit pixie
[Service]
Environment=PIXIE_WEB_ROOT=/srv/pixie/site
sudo systemctl daemon-reload
sudo systemctl restart pixie

Create the directory first and ensure the service account can read the files and traverse the parent directories. The supplied unit protects home directories, so use a path such as /srv/pixie/site.

Need more than one site?

Use separate Pixie instances behind a reverse proxy to select a site by domain name.

Pixie documentation Built from the source. Updated with the features.