Skip to content

daemonless/bichon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bichon

Build Status Last Commit

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. Matches Linux Docker behavior.

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
      - PGID=1000
      - TZ=UTC
      - BICHON_ENCRYPT_PASSWORD=changeme
    volumes:
      - "/path/to/containers/bichon/data:/data"
    ports:
      - 15630:15630
    healthcheck:
      test: ["CMD", "{'port': 15630, 'path': '/'}"]
    restart: unless-stopped

AppJail Director

.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: 'boot args:--pull'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - BICHON_ENCRYPT_PASSWORD: !ENV '${BICHON_ENCRYPT_PASSWORD}'
    volumes:
      - bichon_data: /data
volumes:
  bichon_data:
    device: '/path/to/containers/bichon/data'

Makejail:

ARG tag=latest

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

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 \
  -v /path/to/containers/bichon/data:/data \
  ghcr.io/daemonless/bichon:latest

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"
    ports:
      - "15630:15630"
    volumes:
      - "/path/to/containers/bichon/data:/data"

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

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


Need help? Join our Discord community.

About

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

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors