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 |
| Tag | Description | Best For |
|---|---|---|
latest |
Upstream Binary. Built from official release. | Most users — recommended. |
Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.
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: alwaysSave as compose.yaml, then run podman-compose up -d.
.env:
# .env
DIRECTOR_PROJECT=bichon
PUID=1000
PGID=1000
TZ=UTC
BICHON_ENCRYPT_PASSWORD=changeme
appjail-director.yml:
# 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'Makejail:
# 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.
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.
To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.
Warning
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.
Access at: http://localhost:15630
| 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) |
| Path | Description |
|---|---|
/data |
Core data and search indices |
| 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.