Skip to content

Bichon Bichon

Build Status Last Commit OCI Pulls

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

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

Customize Paths, UID & Ports

Install and manage Bichon on FreeBSD with fjord:

fjord install bichon

Or open the App Store in the fjord web UI and install Bichon from the wizard. New to fjord? See the Install Guide.

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:
      - "/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.

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.

1
2
3
4
5
6
7
# .env

DIRECTOR_PROJECT=bichon
PUID=1000
PGID=1000
TZ=UTC
BICHON_ENCRYPT_PASSWORD=changeme
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  bichon:
    name: bichon
    options:
      - container: '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}'
    volumes:
      - bichon: /data
volumes:
  bichon:
    device: '/containers/bichon'
1
2
3
4
5
6
7
# Makejail

ARG tag=latest

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

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

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:
  bichon:
    name: bichon
    image: "ghcr.io/daemonless/bichon:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - BICHON_ENCRYPT_PASSWORD=changeme
    volumes:
      - "/containers/bichon:/data"

Save as bastille-compose.yml, then run bastille up.

Open http://<server>:15630 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
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

Version Tags

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

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.