Bichon

A lightweight, high-performance Rust email archiver with WebUI.

Port	15630
Registry	ghcr.io/daemonless/bichon
Source	https://github.com/rustmailer/bichon
Website	https://github.com/rustmailer/bichon

Version Tags

Tag	Description	Best For
latest	Upstream Binary. Built from official release.	Most users — recommended.

Prerequisites

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

Deployment

Podman Compose

services:
  bichon:
    image: "ghcr.io/daemonless/bichon:latest"
    container_name: bichon
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - BICHON_ENCRYPT_PASSWORD=changeme  # Encryption password for core database
      - BICHON_HTTP_PORT=  # HTTP server port (default: 15630)
    volumes:
      - "/path/to/containers/bichon:/data"
    ports:
      - "15630:15630"
    healthcheck:
      test: ["CMD", "{'port': 15630, 'path': '/'}"]
    # 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.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=bichon
PUID=1000
PGID=1000
TZ=UTC
BICHON_ENCRYPT_PASSWORD=changeme
BICHON_HTTP_PORT=

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  bichon:
    name: bichon
    options:
      - container: 'boot args:--pull'
      - expose: '15630:15630 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - BICHON_ENCRYPT_PASSWORD: !ENV '${BICHON_ENCRYPT_PASSWORD}'
        - BICHON_HTTP_PORT: !ENV '${BICHON_HTTP_PORT}'
    volumes:
      - bichon: /data
volumes:
  bichon:
    device: '/path/to/containers/bichon'

Makejail:

# Makejail

ARG tag=latest

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

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

Note: 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 IPv4 address assigned by the virtual network.

Podman CLI

podman run -d --name bichon \
  -p 15630:15630 \
  --health-cmd {'port': 15630, 'path': '/'} \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e BICHON_ENCRYPT_PASSWORD=changeme \
  -e BICHON_HTTP_PORT= \
  -v /path/to/containers/bichon:/data \
  ghcr.io/daemonless/bichon:latest

Save as run.sh, then run sh run.sh.

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="15630:15630 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e BICHON_ENCRYPT_PASSWORD=changeme \
  -e BICHON_HTTP_PORT= \
  -o fstab="/path/to/containers/bichon /data <pseudofs>" \
  ghcr.io/daemonless/bichon:latest bichon

Save as run.sh, then run sh run.sh.

Note: 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 IPv4 address assigned by the virtual network.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah, shares the host network stack (inherit), and persists image-declared volumes under --data-path.

services:
  bichon:
    image: "ghcr.io/daemonless/bichon:latest"
    container_name: bichon
    network_mode: host  # jail shares host networking
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - BICHON_ENCRYPT_PASSWORD=changeme
      - BICHON_HTTP_PORT=

Save as podman-compose.yml, then run bastille up. Or via CLI:

bastille create -O \
  --env PUID=1000 \
  --env PGID=1000 \
  --env TZ=UTC \
  --env BICHON_ENCRYPT_PASSWORD=changeme \
  --env BICHON_HTTP_PORT= \
  --data-path /path/to/containers/bichon \
  bichon ghcr.io/daemonless/bichon:latest inherit

Ansible

- name: Deploy bichon
  containers.podman.podman_container:
    name: bichon
    image: "ghcr.io/daemonless/bichon:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
      BICHON_ENCRYPT_PASSWORD: "changeme"
      BICHON_HTTP_PORT: ""
    ports:
      - "15630:15630"
    volumes:
      - "/path/to/containers/bichon:/data"

Save as bichon-deploy.yaml, then run ansible-playbook bichon-deploy.yaml.

Access at: http://localhost:15630

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
BICHON_ENCRYPT_PASSWORD	changeme	Encryption password for core database
BICHON_HTTP_PORT	``	HTTP server port (default: 15630)

Volumes

Path	Description
/data	Core data and search indices

Ports

Port	Protocol	Description
15630	TCP	Web UI / API

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

---

Need help? Join our Discord community.