Skip to content

Zensical Zensical

Build Status Last Commit OCI Pulls

Zensical is a modern static site generator designed to simplify building and maintaining project documentation. It's built by the creators of Material for MkDocs and shares the same core design principles and philosophy - batteries included, easy to use, with powerful customization options.

Port 8000
Registry ghcr.io/daemonless/zensical
Daemonless daemonless/zensical
Source zensical.org
Website zensical.org

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

Customize Paths, UID & Ports

Install and manage Zensical on FreeBSD with fjord:

fjord install zensical

Or open the App Store in the fjord web UI and install Zensical from the wizard. New to fjord? See the Install Guide.

services:
  zensical:
    image: "ghcr.io/daemonless/zensical:latest"
    container_name: zensical
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
    volumes:
      - "/containers/zensical:/config"
    ports:
      - "8000:8000"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

1
2
3
4
5
6
# .env

DIRECTOR_PROJECT=zensical
PUID=1000
PGID=1000
TZ=UTC
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  zensical:
    name: zensical
    options:
      - container: 'args:--pull'
      - expose: '8000:8000 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - zensical: /config
volumes:
  zensical:
    device: '/containers/zensical'
1
2
3
4
5
6
7
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/zensical:${tag}

Save the files above, then run appjail-director up.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  zensical:
    name: zensical
    image: "ghcr.io/daemonless/zensical:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/containers/zensical:/config"

Save as bastille-compose.yml, then run bastille up.

Open http://<server>:8000 from another machine (the server's own browser can't use a published port).

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container

Volumes

Path Description
/config Configuration directory

Ports

Port Protocol Description
8000 TCP Web UI

Version Tags

Multi-arch manifests — resolve automatically to the right image for your platform.

Tag Description Best For
latest Upstream Binary. Built from official release. Most users — recommended.
pkg FreeBSD Quarterly. Uses stable, tested packages. Production stability.
pkg-latest FreeBSD Latest. Rolling package updates. Staying current.
Tag Description Best For
latest-amd64 Upstream Binary. Built from official release. Most users — recommended.
pkg-amd64 FreeBSD Quarterly. Uses stable, tested packages. Production stability.
pkg-latest-amd64 FreeBSD Latest. Rolling package updates. Staying current.
Tag Description Best For
latest-aarch64 Upstream Binary. Built from official release. Most users — recommended.
pkg-aarch64 FreeBSD Quarterly. Uses stable, tested packages. Production stability.
pkg-latest-aarch64 FreeBSD Latest. Rolling package updates. Staying current.

Implementation Details

  • Architectures: amd64, aarch64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).

Need help? Join our Discord community.