bichon

[!NOTE] Bichon is an archiver, not an email client. It does not send, compose, forward, or reply to emails. Its optional SMTP server is for receiving emails only.

Contents

• Features
• Quick Start
  • Docker (Recommended)
  • Docker Compose
  • Binary Installation
  • Build from Source
• Configuration Reference
  • Required Settings
  • Server & Networking
  • Logging
  • CORS
  • TLS & HTTPS
  • SMTP Server
  • Storage Paths
  • Performance Tuning
• Authentication & RBAC
• CLI Tools
• API Reference
• Import & Export
• Architecture
• Storage & Backup
• Internationalization
• Data Migration (v0.x → v1.0)
• FAQ
• Roadmap
• Contributing
• Tech Stack
• License

Features

• Multi-Account IMAP Download: Download multi-account concurrently. Supports password (PLAIN/LOGIN) and OAuth 2.0 (SASL XOAUTH2) with automatic token refresh and PKCE. SSL/TLS, STARTTLS, or plain connections with optional self-signed certificate acceptance.
• Incremental Download: UID-based delta fetching downloads only new messages after the initial download. UIDVALIDITY changes are detected and trigger automatic cache rebuilds.
• Fetch Scoping: Filter download by date range, mailbox folder limit, or specific folder names. Configurable per-account SOCKS5 proxy routing.
• Auto-Configuration: Discover IMAP server settings automatically from an email domain.
• Full-Text Search: Search across subject, body, sender, recipients, attachment properties, and more. Optimized for European languages.
• Advanced Filters: Date range, size range, attachment presence, file type, content category, and facet-based tag combinations.
• Thread Grouping: Reconstruct and view complete conversation threads across folders.
• Attachment Search: Browse and filter attachments by sender, file type, size, and other attachment properties.
• Faceted Tags: Add, remove, or overwrite tags on messages and attachments. Filter by tag combinations with real-time count updates.
• Contacts View: Extracted and deduplicated sender/recipient address book across all authorized accounts.
• Three-Layer Storage: Tantivy for full-text indexing (Zstd compression), Fjall with LZ4 for compressed blob storage, and memdb for relational metadata. All embedded — zero external dependencies.
• Content Deduplication: Identical email bodies and attachments stored once via BLAKE3 content hashing. Folder moves update metadata only.
• Dashboard Analytics: Email volume trends, top senders, storage usage breakdown, attachment statistics, and per-account activity. Scoped by user permissions.
• OpenAPI 3.0: Interactive API documentation at /api-docs (Swagger UI, ReDoc, Scalar). All endpoints documented with request/response schemas.
• Multi-User RBAC: 5 built-in roles (Admin, Manager, Member, AccountManager, AccountViewer) plus custom roles with 22 granular permissions.
• Account-Level Isolation: Grant users access to specific accounts with scoped roles. Permissions enforced at the API layer.
• CLI Import Tools: Import from EML directories, MBOX files (including Gmail variants), Thunderbird profiles, and Outlook PST files.

Quick Start

Docker (Recommended)

# Pull the image
docker pull rustmailer/bichon:latest

# Create data directory
mkdir -p ./bichon-data

# Run container
docker run -d \
  --name bichon \
  -p 15630:15630 \
  -v $(pwd)/bichon-data:/data \
  --user 1000:1000 \
  -e BICHON_ROOT_DIR=/data \
  -e BICHON_ENCRYPT_PASSWORD=your-secure-password-here \
  rustmailer/bichon:latest

Open http://localhost:15630 in your browser.

[!IMPORTANT] Default login: username admin, password admin@bichon. Change this immediately via Settings → Profile.

Docker Compose

services:
  bichon:
    image: rustmailer/bichon:latest
    container_name: bichon
    ports:
      - "15630:15630"
    volumes:
      - ./bichon-data:/data
    user: "1000:1000"
    environment:
      BICHON_ROOT_DIR: /data
      BICHON_ENCRYPT_PASSWORD: your-secure-password-here
      BICHON_LOG_LEVEL: info

Binary Installation

Download from the Releases page:

Platform	Archive
Linux (GNU)	bichon-x.x.x-x86_64-unknown-linux-gnu.tar.gz
Linux (MUSL)	bichon-x.x.x-x86_64-unknown-linux-musl.tar.gz
macOS	bichon-x.x.x-x86_64-apple-darwin.tar.gz
Windows	bichon-x.x.x-x86_64-pc-windows-msvc.zip

# Linux / macOS
./bichon --bichon-root-dir /path/to/data --bichon-encrypt-password your-password

# Windows
.\bichon.exe --bichon-root-dir E:\bichon-data --bichon-encrypt-password your-password

--bichon-root-dir must be an absolute path. All Bichon data lives under this directory.

Build from Source

Prerequisites: Rust (latest stable), Node.js 20+, pnpm

git clone https://github.com/rustmailer/bichon.git
cd bichon

# Build the WebUI (required before building the server)
cd web && pnpm install && pnpm run build && cd ..

# Build and run
export BICHON_ENCRYPT_PASSWORD=dev-password
cargo run -- --bichon-root-dir /tmp/bichon-data

For frontend development:

cd web && pnpm run dev   # Vite dev server with API proxy to Rust backend

[!TIP] The WebUI must be built at least once (pnpm run build) for the server to serve the frontend. In dev mode (pnpm run dev), Vite proxies API calls to the Rust server automatically.

Configuration Reference

All settings accept both CLI flags (--bichon-http-port) and environment variables (BICHON_HTTP_PORT). CLI flags take precedence over environment variables.

Required Settings

Variable	CLI Flag	Description
BICHON_ROOT_DIR	--bichon-root-dir	Required. Absolute path for all persistent data
BICHON_ENCRYPT_PASSWORD	--bichon-encrypt-password	Password used to encrypt stored credentials (IMAP passwords, OAuth tokens)
BICHON_ENCRYPT_PASSWORD_FILE	--bichon-encrypt-password-file	Alternative: read the encryption password from a file

[!NOTE] If both password options are set, the direct value takes precedence over the file.

Server & Networking

Variable	Default	Description
BICHON_HTTP_PORT	15630	HTTP server port
BICHON_BIND_IP	0.0.0.0	IP address to bind to (IPv4 or IPv6)
BICHON_PUBLIC_URL	http://localhost:15630	Public-facing URL used in OAuth redirects and docs
BICHON_BASE_URL	/	Base path for WebUI when behind a reverse proxy (e.g. /bichon)
BICHON_WEBUI_TOKEN_EXPIRATION_HOURS	168	Access token lifetime in hours (default 7 days)
BICHON_HTTP_COMPRESSION_ENABLED	true	Enable gzip/brotli/zstd response compression

Logging

Variable	Default	Description
BICHON_LOG_LEVEL	info	Log level: trace, debug, info, warn, error
BICHON_ANSI_LOGS	true	Colorized terminal output
BICHON_JSON_LOGS	false	JSON-formatted logs for log aggregators
BICHON_LOG_TO_FILE	false	Persist logs to files under root dir
BICHON_MAX_SERVER_LOG_FILES	5	Max log files to retain

CORS

Variable	Default	Description
BICHON_CORS_ORIGINS	(allow all)	Comma-separated list of allowed origins: http://192.168.1.16:15630,http://myserver.local:15630
BICHON_CORS_MAX_AGE	86400	Cache duration for CORS preflight in seconds

[!WARNING] If BICHON_CORS_ORIGINS is not set, all origins are allowed. If you set it, only exact matches pass. Wildcards (*) are not supported. Do not add trailing slashes. When using Docker, avoid wrapping the value in quotes.

TLS & HTTPS

Variable	Default	Description
BICHON_ENABLE_REST_HTTPS	false	Serve the API over HTTPS (requires valid certificat