# ![Bichon](<https://daemonless.io/images/logos/bichon.svg>) Bichon

[![Build Status](<https://img.shields.io/github/actions/workflow/status/daemonless/bichon/build.yaml?style=flat-square&amp;label=Build&amp;color=green>)](<https://github.com/daemonless/bichon/actions>) [![Last Commit](<https://img.shields.io/github/last-commit/daemonless/bichon?style=flat-square&amp;label=Last+Commit&amp;color=blue>)](<https://github.com/daemonless/bichon/commits>) [![OCI Pulls](<https://img.shields.io/docker/pulls/daemonless/bichon?style=flat-square&amp;label=OCI+Pulls&amp;color=blue>)](<https://hub.docker.com/r/daemonless/bichon>)

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

[[![Bichon screenshot 1](<https://daemonless.io/images/screenshots/bichon/515926976-96b0ebc2-4778-452b-891f-dc9acf8e381f_1.png>)](</images/screenshots/bichon/515926976-96b0ebc2-4778-452b-891f-dc9acf8e381f_1.png>)](</images/screenshots/bichon/515926976-96b0ebc2-4778-452b-891f-dc9acf8e381f_1.png>) [[![Bichon screenshot 2](<https://daemonless.io/images/screenshots/bichon/515928461-ab4bf6ae-faa6-4b49-ae39-705eb9d4487f_1.png>)](</images/screenshots/bichon/515928461-ab4bf6ae-faa6-4b49-ae39-705eb9d4487f_1.png>)](</images/screenshots/bichon/515928461-ab4bf6ae-faa6-4b49-ae39-705eb9d4487f_1.png>) [[![Bichon screenshot 3](<https://daemonless.io/images/screenshots/bichon/515930371-3a456999-e4eb-441e-9052-3a727dea66a0_1.png>)](</images/screenshots/bichon/515930371-3a456999-e4eb-441e-9052-3a727dea66a0_1.png>)](</images/screenshots/bichon/515930371-3a456999-e4eb-441e-9052-3a727dea66a0_1.png>) [[![Bichon screenshot 4](<https://daemonless.io/images/screenshots/bichon/515931129-95db0a05-4b55-4e18-b418-9d40361d6fea_1.png>)](</images/screenshots/bichon/515931129-95db0a05-4b55-4e18-b418-9d40361d6fea_1.png>)](</images/screenshots/bichon/515931129-95db0a05-4b55-4e18-b418-9d40361d6fea_1.png>) [[![Bichon screenshot 5](<https://daemonless.io/images/screenshots/bichon/515932783-6fd54cb0-c86f-4ceb-a955-c81107614fc4_1.png>)](</images/screenshots/bichon/515932783-6fd54cb0-c86f-4ceb-a955-c81107614fc4_1.png>)](</images/screenshots/bichon/515932783-6fd54cb0-c86f-4ceb-a955-c81107614fc4_1.png>) [[![Bichon screenshot 6](<https://daemonless.io/images/screenshots/bichon/518375417-6a079d98-ff6c-46f4-9ec6-e76d320bff5d_1.png>)](</images/screenshots/bichon/518375417-6a079d98-ff6c-46f4-9ec6-e76d320bff5d_1.png>)](</images/screenshots/bichon/518375417-6a079d98-ff6c-46f4-9ec6-e76d320bff5d_1.png>)

|  |  |
| --- | --- |
| **Port** | `15630` |
| **Registry** | [`ghcr.io/daemonless/bichon`](<https://github.com/daemonless/bichon/pkgs/container/bichon>) |
| **Daemonless** | [daemonless/bichon](<https://github.com/daemonless/bichon>) |
| **Source** | [rustmailer/bichon](<https://github.com/rustmailer/bichon>) |
| **Website** | [github.com/rustmailer/bichon](<https://github.com/rustmailer/bichon>) |

## Prerequisites

Before deploying, ensure your host environment is ready. See the [Quick Start Guide](<https://daemonless.io/guides/quick-start/index.md>) 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](<https://fjord.daemonless.io>):

```
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](<https://fjord.daemonless.io/install/>).

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

```
# .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'
```

```
# 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]
>
> **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. |

> [!NOTE]
>
> **Implementation Details**
>
> - **Architectures:** amd64
> - **User:** `bsd` (UID/GID set via [PUID/PGID](<https://daemonless.io/guides/permissions/index.md>)). Defaults to `1000:1000`.
> - **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD 15.1).

---

Need help? Join our [Discord](<https://discord.gg/Kb9tkhecZT>) community.
