8000 GitHub - rustmailer/bichon: Bichon – A lightweight, high-performance Rust email archiver with WebUI · GitHub
[go: up one dir, main page]

Skip to content
rustmailerPublic

About

Bichon – A lightweight, high-performance Rust email archiver with WebUI

Topics

Resources

Stars

2.1k stars

Watchers

6 watching

Forks

Repository files navigation

Bichon Logo

BICHON

GitHub Stars Docker Pulls Website User Survey

Release Docker License Discord Follow on X

A self-hosted email archiving server built in Rust. Download emails from IMAP accounts, builds a full-text search index, and serves a REST API with an embedded WebUI. Purpose-built for long-term preservation, unified cross-account search, and programmatic access to archived email.

Watch the demo
▶ Click to watch the demo

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.

Website · Documentation · Quick Start · API Reference

Features

  • IMAP archiving — multiple accounts with password or OAuth 2.0 (XOAUTH2) login, incremental UID sync, gap-fill repair, UIDVALIDITY rebuilds, per-account schedules, archive scoping and SOCKS5 routing.
  • Full-text search — search subject, body, senders, recipients and attachment metadata; filter by date, size, folder and tags; reconstruct threads; browse an aggregated contact list.
  • Attachment search — attachment metadata in the Community edition; full attachment content indexing on Pro.
  • Embedded storage — Tantivy for search, bichon-blob for content-addressed blobs and memdb for metadata. Zstd compression, BLAKE3 deduplication, zero external dependencies.
  • Import & export — EML, MBOX (including the Gmail variant), Thunderbird profiles and Outlook PST; MBOX export; WebUI upload; bulk restore back to the source IMAP server.
  • SMTP receiver — receive mail at delivery time into local accounts, including mail deleted from the source before the first sync. Tenant-wide journaling is Pro/Enterprise.
  • Message lifecycle — tags, remote-content blocking, message repair, source-mailbox cleanup, retention and background batch deletion.
  • Backup & restore — incremental, content-addressed backups to S3-compatible storage or a local directory, with per-restore-point manifests and retention.
  • Access control — RBAC with custom roles, account-level isolation, MFA/TOTP and scoped API tokens.
  • Compliance — audit trail, legal hold, retention locks, GDPR erasure and dual control (Pro/Enterprise).
  • Interfaces — WebUI in 19 languages, OpenAPI 3.0 at /api-docs, plus bichon-cli and bichon-admin.
  • Deployment — a single Rust binary or Docker image; no external database, search engine or message queue.

Community vs Pro/Enterprise: attachment content search, SSO, journaling, the built-in IMAP server, analytics and the compliance workflows are commercial features. See Editions for the full comparison.

Quick Start

docker pull rustmailer/bichon:latest

mkdir -p ./bichon-data

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.

Important

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

Docker Compose, binary installation, source builds and the full setup guide are in Quick Start.

Documentation

Full documentation lives at bichon.rustmailer.com/docs.

Topic Guides
Install & configure Quick Start · Configuration
Accounts & sync Account Setup · Accounts · Archive Filters · Source Cleanup
Search & messages Search · Batch Deletion · Message Repair
Users & security Authentication · Users & Access
Import, export & CLI Import & Export · CLI Tools · SMTP Receiver
Operations Storage & Backup · Monitoring · Migration · FAQ
Architecture & API Architecture · Content Deduplication · API Reference
Editions & licensing Editions · Licensing
Pro & Enterprise Analytics · SSO · Journaling · MCP · Legal Hold · Dual Control
Contributing Contributing

Tech Stack

Rust (Tokio, Poem, Tantivy, bichon-blob, memdb) on the backend; React, TypeScript and Vite in the WebUI. See Architecture for the design.

Roadmap

Planned work is tracked in GitHub Issues. Priorities come from the annual user survey.

Contributing

Contributions of all kinds are welcome. Read the Contributing guide first; by submitting a Pull Request you agree to the terms of the Contributor License Agreement.

  • Open an issue before starting a new feature or a large fix.
  • Keep each PR to one logical change, and include tests for new or fixed behavior.
  • Join the Discord for questions and design discussions.

License

Bichon is licensed under the GNU Affero General Public License v3.0. Copyright © 2025–2026 rustmailer.com

About

Bichon – A lightweight, high-performance Rust email archiver with WebUI

Topics

Resources

Stars

2.1k stars

Watchers

6 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages

0