# ![Zensical](<https://daemonless.io/images/logos/zensical.svg>) Zensical

[![Build Status](<https://img.shields.io/github/actions/workflow/status/daemonless/zensical/build.yaml?style=flat-square&amp;label=Build&amp;color=green>)](<https://github.com/daemonless/zensical/actions>) [![Last Commit](<https://img.shields.io/github/last-commit/daemonless/zensical?style=flat-square&amp;label=Last+Commit&amp;color=blue>)](<https://github.com/daemonless/zensical/commits>) [![OCI Pulls](<https://img.shields.io/docker/pulls/daemonless/zensical?style=flat-square&amp;label=OCI+Pulls&amp;color=blue>)](<https://hub.docker.com/r/daemonless/zensical>)

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.

[[![Zensical screenshot 1](<https://daemonless.io/images/screenshots/zensical/screenshot-dark.png>)](</images/screenshots/zensical/screenshot-dark.png>)](</images/screenshots/zensical/screenshot-dark.png>)

|  |  |
| --- | --- |
| **Port** | `8000` |
| **Registry** | [`ghcr.io/daemonless/zensical`](<https://github.com/daemonless/zensical/pkgs/container/zensical>) |
| **Daemonless** | [daemonless/zensical](<https://github.com/daemonless/zensical>) |
| **Source** | [zensical.org](<https://zensical.org>) |
| **Website** | [zensical.org](<https://zensical.org>) |

## Prerequisites

Before deploying, ensure your host environment is ready. See the [Quick Start Guide](<https://daemonless.io/guides/quick-start/index.md>) for host setup instructions, including the security model for host vs. container privileges.

## Deployment

**Customize Paths, UID &amp; Ports**

Install and manage **Zensical** on FreeBSD with [fjord](<https://fjord.daemonless.io>):

```
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](<https://fjord.daemonless.io/install/>).

```
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.

```
# .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'
```

```
# 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`.

> [!WARNING]
>
> **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. |

> [!NOTE]
>
> **Implementation Details**
>
> - **Architectures:** amd64, aarch64
> - **User:** `bsd` (UID/GID set via [PUID/PGID](<https://daemonless.io/guides/permissions/index.md>)). Defaults to `1000:1000`.
> - **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD 15.1).

---

Need help? Join our [Discord](<https://discord.gg/Kb9tkhecZT>) community.
