Skip to content

Bichon Bichon

Description / nameInput element
Container Registry
Container Configuration Root Path
Timezone
User ID
Group ID
Bichon Host Port
Bichon /data Path

Build Status Last Commit

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

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

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users. Matches Linux Docker behavior.

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

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:/data"
    ports:
      - "15630:15630"
    healthcheck:
      test: ["CMD", "{'port': 15630, 'path': '/'}"]
    restart: unless-stopped
1
2
3
4
5
6
7
8
# .env

DIRECTOR_PROJECT=bichon
PUID=1000
PGID=1000
TZ=UTC
BICHON_ENCRYPT_PASSWORD=changeme
BICHON_HTTP_PORT=
# 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_PATH: /data
volumes:
  BICHON_DATA_PATH:
    device: '/path/to/containers/bichon/data'
1
2
3
4
5
6
# Makejail

ARG tag=latest

OPTION overwrite=force
OPTION from=ghcr.io/daemonless/bichon:${tag}
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:/data \
  ghcr.io/daemonless/bichon:latest
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 /data <pseudofs>" \
  ghcr.io/daemonless/bichon:latest bichon
- 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:/data"

Access at: http://localhost:15630

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

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.1).

Need help? Join our Discord community.