Zensical

Description / name	Input element
Container Registry
Container Configuration Root Path
Timezone
User ID
Group ID
Zensical Host Port
Zensical /config Path

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

Version Tags

Tag	Description	Best For
`pkg`	FreeBSD Quarterly. Uses stable, tested packages.	Production stability.
`pkg-latest`	FreeBSD Latest. Rolling package updates.	Newest FreeBSD packages.

Root Privileges Required

Podman on FreeBSD currently requires root. All commands must be run as root (or via doas/sudo).

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose AppJail Director Podman CLI Ansible

services:
  zensical:
    image: ghcr.io/daemonless/zensical:latest
    container_name: zensical
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/path/to/containers/zensical:/config"
    ports:
      - 8000:8000
    restart: unless-stopped

DIRECTOR_PROJECT=zensical
PUID=1000
PGID=1000
TZ=UTC

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  zensical:
    name: zensical
    options:
      - container: 'boot args:--pull'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - ZENSICAL_CONFIG_PATH: /config
volumes:
  ZENSICAL_CONFIG_PATH:
    device: '/path/to/containers/zensical'

ARG tag=pkg

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

podman run -d --name zensical \
  -p 8000:8000 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -v /path/to/containers/zensical:/config \
  ghcr.io/daemonless/zensical:latest

- name: Deploy zensical
  containers.podman.podman_container:
    name: zensical
    image: ghcr.io/daemonless/zensical:latest
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
    ports:
      - "8000:8000"
    volumes:
      - "/path/to/containers/zensical:/config"

Access at: http://localhost:8000

Interactive Configuration

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

Implementation Details

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

Need help? Join our Discord community.