Skip to content

daemonless/zensical

Repository files navigation

Zensical

Build Status Last Commit

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
Source https://zensical.org
Website https://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.

Prerequisites

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

Deployment

Podman Compose

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

AppJail Director

.env:

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

appjail-director.yml:

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
volumes:
  zensical:
    device: '/path/to/containers/zensical'

Makejail:

ARG tag=pkg

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

Podman CLI

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

Ansible

- 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

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

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.0


Need help? Join our Discord community.

About

Native FreeBSD OCI container for Zensical — modern documentation site generator built by the creators of Material for MkDocs

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors