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
Page: Setting the Bichon Encryption Password
Pages
Bichon Data Migration: v0.3.7 → v1.0 Bichon v2.x Migration Guide Configuration Reference Custom Storage Configuration De‐duplication FAQ (Frequently Asked Questions) Home How to Select Folders to Sync Permissions and Multi‐User System Reset Admin Password (Offline Tool) SMTP Ingest Service Securing Credentials: Encrypting Passwords and OAuth Tokens Setting the Bichon Encryption Password Store External OAuth2 Token API Using Bichonctl For Email Import WebUI Authentication Token Expiration
Clone
1
Setting the Bichon Encryption Password
rustmailer edited this page 2025-12-29 12:14:38 +08:00
Unescape Escape
Table of Contents
This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

🔐 Setting the Bichon Encryption Password

Bichon uses an encryption password to protect sensitive data. You must set it before first use, when no data exists.

Once the password is set, it cannot be changed. Changing it later will make all encrypted data unreadable. To start over, you must reinitialize Bichon and delete all emails and metadata.

🆕 New in v0.2.0: Password File Support

Starting from v0.2.0, Bichon supports loading the encryption password from a file using the bichon_encrypt_password_file option (or its corresponding environment variable).

  • If bichon_encrypt_password_file is specified, Bichon will:

    • Read the file content
    • Use the file’s content (as-is) as the encryption password

  • If bichon_encrypt_password_file is NOT set, Bichon falls back to:

    • bichon-encrypt-password (CLI argument), or
    • BICHON_ENCRYPT_PASSWORD (environment variable)

How to Set the Password

You can set the password using one of the following methods.

📄 Password File (Recommended for Production)

Command-line:

bichon --bichon-encrypt-password-file /path/to/password.txt

Environment variable:

export BICHON_ENCRYPT_PASSWORD_FILE=/path/to/password.txt
bichon

The file should contain only the password string (no extra whitespace or newlines).

⌨️ Command-Line (Direct Password)

bichon --bichon-encrypt-password "your-strong-password"

🌱 Environment Variable

export BICHON_ENCRYPT_PASSWORD="your-strong-password"
bichon

Tip: Use a strong, securely stored password. Once set, it cannot be changed without wiping all encrypted data.