Hearth/hearth.yml.example
ilia b0db0a26e3 Scrub personal addresses from examples, tests, and intro email docs.
Real participants stay in gitignored hearth.yml/.env on the deploy host only.
2026-07-09 20:44:29 -04:00

56 lines
2.0 KiB
Plaintext

# Hearth participant allow-list — copy to hearth.yml and fill in real values.
# NEVER commit hearth.yml with real addresses/creds (it's gitignored).
#
# This file is the ONLY place recipients come from. Hearth has no code path
# that discovers, scrapes, or composes an address that isn't listed here.
#
# Optional: restrict which of the participants below are actually live right
# now, without deleting the rest — handy for testing with just one or two
# pairs before turning on the full pool. Omit `active` entirely (default) to
# make everyone below active.
#
# active: [mailbox_a, personal_inbox]
#
# tier: full_duplex
# Your own mailboxes. Hearth logs in via IMAP+SMTP, sends new threads,
# and auto-replies to incoming pool mail. Needs imap_host/smtp_host/
# username + a HEARTH_PASSWORD_<KEY> env var (see env.example).
#
# tier: send_only
# A friend/coworker who explicitly agreed to help warm up the domain.
# Hearth only ever sends TO this address from one of your full_duplex
# mailboxes — it never has credentials for this inbox, and never logs
# into it. The participant replies/marks-not-spam manually, whenever
# they feel like it, from their own mail client.
participants:
mailbox_a:
tier: full_duplex
email: mailbox-a@example.com
display_name: "You"
imap_host: mail.example.com
imap_port: 993
smtp_host: mail.example.com
smtp_port: 587
username: mailbox-a@example.com
password_env: HEARTH_PASSWORD_MAILBOX_A
personal_inbox:
tier: full_duplex
email: you@example.com
display_name: "You"
imap_host: imap.example.com
imap_port: 993
smtp_host: smtp.example.com
smtp_port: 587
username: you@example.com
password_env: HEARTH_PASSWORD_PERSONAL_INBOX
# Example consenting third party — replace with a real person who has
# actually agreed to this. Delete this entry if you only want to warm up
# between your own mailboxes for now.
friend_example:
tier: send_only
email: friend@example.com
display_name: "Friend"