External/bichon
1
0
Fork 0
mirror of https://github.com/rustmailer/bichon.git synced 2026-08-03 07:48:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Configuration Reference (markdown)

rustmailer
2026-01-20 09:54:24 +08:00
parent 78b99ce603
commit 44569d0672
1 changed files with 16 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Configuration-Reference.md
+16 -2
@@ -34,13 +34,27 @@ Each setting can be specified as a **command-line argument** (`--option-name`) o
| Option | CLI / Env | Default | Description |
|--------|-----------|---------|-------------|
| `bichon_root_dir` | `--bichon-root-dir` / `BICHON_ROOT_DIR` | *none* | Absolute path for Bichon data directory. Must exist. |
| `bichon_root_dir` | `--bichon-root-dir` / `BICHON_ROOT_DIR` | *none* | Absolute path for Bichon core data. Contains encrypted account info. |
| `bichon_index_dir` | `--bichon-index-dir` / `BICHON_INDEX_DIR` | `${bichon_root_dir}/envelope` | Path for the metadata Tantivy index. Stores envelopes and server sync info. |
| `bichon_data_dir` | `--bichon-data-dir` / `BICHON_DATA_DIR` | `${bichon_root_dir}/eml` | Path for the data Tantivy index. Stores raw email content (unencrypted). |
| `bichon_metadata_cache_size` | `--bichon-metadata-cache-size` / `BICHON_METADATA_CACHE_SIZE` | `134_217_728` | Cache size (bytes) for metadata database. |
| `bichon_envelope_cache_size` | `--bichon-envelope-cache-size` / `BICHON_ENVELOPE_CACHE_SIZE` | `1_073_741_824` | Cache size (bytes) for envelope database. |
| `bichon_encrypt_password` | `--bichon-encrypt-password` / `BICHON_ENCRYPT_PASSWORD` | `"change-this-default-password-now"` | Encryption password for database/files. ⚠️ Change in production. |
| `bichon_encrypt_password` | `--bichon-encrypt-password` / `BICHON_ENCRYPT_PASSWORD` | `"change-this-default-password-now"` | Encryption password for core database/files. ⚠️ Change in production. |
---
### Storage Customization (v0.3.2+)
Starting from version 0.3.2, you can decouple the search index and data storage from the root directory. This is useful for moving large datasets to different drives.
* **BICHON_INDEX_DIR (Metadata Index):** A standalone Tantivy index instance. It stores metadata extracted from emails and other information retrieved from mail servers.
* **BICHON_DATA_DIR (Data Index):** A standalone Tantivy index instance. It contains the primary email message data. While it functions as an index, you can think of it as the storage for your entire collection of emails.
**Migration & Backup:**
* **Migration:** You can manually move the existing `envelope` and `eml` directories from your root folder to new locations, then update these parameters accordingly. Renaming the directories after moving is also supported.
* **Security:** These two directories are **not encrypted**. They are designed for high-performance indexing and search.
* **Backup:** A complete backup requires all three locations: `bichon_root_dir` (encrypted settings), `bichon_index_dir` (metadata), and `bichon_data_dir` (email content).
## 4. Email Synchronization
| Option | CLI / Env | Default | Description |