barid-core

mail_runtime

Not complete Configuration

Readiness

Not complete

BARID_MAIL_HOSTNAME is required.
BARID_ADMIN_EMAIL is required.
BARID_POSTMASTER_EMAIL is required.
BARID_ABUSE_EMAIL is required.
BARID_TLS_EMAIL is required.
BARID_API_TOKEN is required.

Configuration Owner: Barid
Ownership Model: Domain-owned headless
Bawaba Actions: 1 total · 1 blocking
Policy: Barid UI owns desired mail domains and runtime mail configuration through Sup Barid; Tamkeen validates bootstrap transport values.

Back

Editable Configuration

72 fields

Parameter	Description	Valid Values	Current Value
BARID_MAIL_HOSTNAME type3_required_deployment BARID_MAIL_HOSTNAME is required.	Public mail host name, such as mail.example.com. Example: mail.example.com	hostname; required	-
BARID_ADMIN_EMAIL type3_required_deployment BARID_ADMIN_EMAIL is required.	Required email setting for barid admin email. Example: ops@example.com	email; required	-
BARID_POSTMASTER_EMAIL type3_required_deployment BARID_POSTMASTER_EMAIL is required.	Required email setting for barid postmaster email. Example: ops@example.com	email; required	-
BARID_ABUSE_EMAIL type3_required_deployment BARID_ABUSE_EMAIL is required.	Required email setting for barid abuse email. Example: ops@example.com	email; required	-
BARID_PUBLIC_BASE_URL type4_optional_deployment	Private admin/API base URL if exposed behind a reverse proxy. Example: standard	string; optional	-

Parameter	Description	Valid Values	Current Value
BARID_SMTP_RECEIVE_ENABLED type2_required_defaultable	Enable public SMTP receive for domains managed by Barid UI. Example: True	boolean; required	True
BARID_SMTP_RECEIVE_PORT type2_required_defaultable	Required integer setting for barid smtp receive port. Example: 25	integer; 1 to 65535; required	25
BARID_SMTP_RECEIVE_BIND_PORT type2_required_defaultable	Container bind port for SMTP receive. Production may set this to 25; local development uses 2525. Example: 2525	integer; 1 to 65535; required	2525
BARID_SMTP_RECEIVE_HOST_PORT type2_required_defaultable	Host port published by Docker for SMTP receive. Production mail servers should use 25. Example: 2525	integer; 1 to 65535; required	2525
BARID_SMTP_RECEIVE_HOST type2_required_defaultable	Required string setting for barid smtp receive host. Example: 0.0.0.0	string; required	0.0.0.0
BARID_SMTP_SUBMISSION_ENABLED type2_required_defaultable	Enable authenticated mail client submission. Example: True	boolean; required	True
BARID_SMTP_SUBMISSION_PORT type2_required_defaultable	Required integer setting for barid smtp submission port. Example: 465	integer; 1 to 65535; required	465
BARID_SMTP_SUBMISSION_BIND_PORT type2_required_defaultable	Container bind port for SMTP submission. Production may set this to 465; local development uses 2465. Example: 2465	integer; 1 to 65535; required	2465
BARID_SMTP_SUBMISSION_HOST_PORT type2_required_defaultable	Host port published by Docker for authenticated SMTP submission. Production mail servers should use 465. Example: 2465	integer; 1 to 65535; required	2465
BARID_SMTP_SUBMISSION_HOST type2_required_defaultable	Required string setting for barid smtp submission host. Example: 0.0.0.0	string; required	0.0.0.0
BARID_IMAPS_ENABLED type2_required_defaultable	Required boolean setting for barid imaps enabled. Example: True	boolean; required	True
BARID_IMAPS_PORT type2_required_defaultable	Advertised IMAPS port. Production should use 993. Example: 993	integer; 1 to 65535; required	993
BARID_IMAPS_BIND_PORT type2_required_defaultable	Container bind port for IMAPS. Production may set this to 993; local development uses 2993. Example: 2993	integer; 1 to 65535; required	2993
BARID_IMAPS_HOST_PORT type2_required_defaultable	Host port published by Docker for IMAPS. Production mail servers should use 993. Example: 2993	integer; 1 to 65535; required	2993
BARID_IMAPS_HOST type2_required_defaultable	Required string setting for barid imaps host. Example: 0.0.0.0	string; required	0.0.0.0
BARID_JMAP_ENABLED type2_required_defaultable	Required boolean setting for barid jmap enabled. Example: False	boolean; required	False
BARID_JMAP_PORT type2_required_defaultable	Required integer setting for barid jmap port. Example: 443	integer; 1 to 65535; required	443
BARID_OUTBOUND_ENABLED type2_required_defaultable	Required boolean setting for barid outbound enabled. Example: True	boolean; required	True
BARID_OUTBOUND_INTERVAL_SECONDS type2_required_defaultable	Required integer setting for barid outbound interval seconds. Example: 30	integer; 1 to 3600; required	30
BARID_OUTBOUND_BATCH_SIZE type2_required_defaultable	Required integer setting for barid outbound batch size. Example: 20	integer; 1 to 500; required	20

Parameter	Description	Valid Values	Current Value
BARID_TLS_MODE type2_required_defaultable	How Barid obtains or receives TLS certificates. Example: acme	acme, external, manual	acme
BARID_TLS_RENEWAL_WARNING_DAYS type2_required_defaultable	Required integer setting for barid tls renewal warning days. Example: 21	integer; 1 to 365; required	21
BARID_DKIM_SELECTOR type2_required_defaultable	Required string setting for barid dkim selector. Example: barid	string; required	barid
BARID_DKIM_KEY_BITS type2_required_defaultable	Required integer setting for barid dkim key bits. Example: 2048	integer; 1024 to 4096; required	********48
BARID_DKIM_ROTATION_DAYS type2_required_defaultable	Required integer setting for barid dkim rotation days. Example: 365	integer; 30 to 3650; required	365
BARID_TLS_EMAIL type3_required_deployment BARID_TLS_EMAIL is required.	Address used for ACME/TLS certificate notices. Example: ops@example.com	email; required	-
BARID_TLS_CERT_PATH type4_optional_deployment	TLS certificate path when BARID_TLS_MODE is external or manual. Example: /var/lib/ai-operations/data	path; optional	-
BARID_TLS_KEY_PATH type4_optional_deployment	TLS private key path when BARID_TLS_MODE is external or manual. Example: /var/lib/ai-operations/data	path; optional	Not configured
BARID_DKIM_PRIVATE_KEYS type4_optional_deployment	Optional externally managed DKIM private key material. Example: ********en	secret; optional	Not configured

Parameter	Description	Valid Values	Current Value
BARID_MAILBOX_DEFAULT_QUOTA_MB type2_required_defaultable	Required integer setting for barid mailbox default quota mb. Example: 1024	integer; 1 to 1048576; required	1024
BARID_MESSAGE_MAX_BYTES type2_required_defaultable	Required integer setting for barid message max bytes. Example: 26214400	integer; 1024 to 104857600; required	26214400
BARID_MAX_RECIPIENTS_PER_MESSAGE type2_required_defaultable	Maximum recipients accepted for one inbound or submitted message. Example: 50	integer; 1 to 1000; required	50
BARID_RATE_LIMIT_PER_MAILBOX type2_required_defaultable	Maximum outbound messages per mailbox per rolling hour. Example: 120	integer; 1 to 100000; required	120
BARID_RATE_LIMIT_PER_DOMAIN type2_required_defaultable	Maximum outbound messages per domain per rolling hour. Example: 1000	integer; 1 to 1000000; required	1000
BARID_RATE_LIMIT_WINDOW_SECONDS type2_required_defaultable	Rolling window used for outbound mailbox and domain rate limits. Example: 3600	integer; 60 to 86400; required	3600
BARID_ACTIVE_QUEUE_LIMIT_PER_MAILBOX type2_required_defaultable	Maximum pending/deferred outbound queue items allowed for one sender mailbox. Example: 200	integer; 1 to 100000; required	200
BARID_INBOUND_CONNECTION_LIMIT_PER_IP type2_required_defaultable	Required integer setting for barid inbound connection limit per ip. Example: 60	integer; 1 to 100000; required	60

Parameter	Description	Valid Values	Current Value
BARID_BACKUP_ENABLED type2_required_defaultable	Required boolean setting for barid backup enabled. Example: True	boolean; required	True
BARID_BACKUP_INTERVAL_SECONDS type2_required_defaultable	Required integer setting for barid backup interval seconds. Example: 86400	integer; 300 to 604800; required	86400
BARID_BACKUP_RETENTION_DAYS type2_required_defaultable	Required integer setting for barid backup retention days. Example: 30	integer; 1 to 3650; required	30
BARID_BACKUP_PATH type4_optional_deployment	Host path for Barid backups when not using the default data/backups directory. Example: /var/lib/ai-operations/data	path; optional	-

Parameter	Description	Valid Values	Current Value
BARID_CLAMAV_ENABLED type2_required_defaultable	Required boolean setting for barid clamav enabled. Example: False	boolean; required	False
BARID_CLAMAV_AGENT_URL type2_required_defaultable	Required string setting for barid clamav agent url. Example: http://ai-clamav-scan-agent:9017	string; required	http://ai-clamav-scan-agent:9017
BARID_CLAMAV_REQUIRED_FOR_INBOUND type2_required_defaultable	Required boolean setting for barid clamav required for inbound. Example: False	boolean; required	False
BARID_CLAMAV_REQUIRED_FOR_ATTACHMENTS type2_required_defaultable	Required boolean setting for barid clamav required for attachments. Example: True	boolean; required	True
BARID_CLAMAV_FAIL_MODE type2_required_defaultable	Required enum setting for barid clamav fail mode. Example: quarantine	quarantine, reject, deliver	quarantine
BARID_CLAMAV_SCAN_TIMEOUT_SECONDS type2_required_defaultable	Required integer setting for barid clamav scan timeout seconds. Example: 60	integer; 1 to 3600; required	60
BARID_CLAMAV_SCAN_INTERVAL_SECONDS type2_required_defaultable	Required integer setting for barid clamav scan interval seconds. Example: 15	integer; 1 to 3600; required	15
BARID_CLAMAV_SCAN_BATCH_SIZE type2_required_defaultable	Required integer setting for barid clamav scan batch size. Example: 20	integer; 1 to 500; required	20
BARID_CLAMAV_AGENT_TOKEN type4_optional_deployment	Optional secret setting for barid clamav agent token. Example: ********en	secret; optional	Not configured

Parameter	Description	Valid Values	Current Value
BARID_RELAY_SMARTHOST type4_optional_deployment	Optional outbound relay/smarthost for deployments that cannot send directly. Example: c1.acer.local	hostname; optional	-
BARID_RELAY_PORT type4_optional_deployment	Optional integer setting for barid relay port. Example: 1	integer; 1 to 65535; optional	-
BARID_RELAY_SECURITY type4_optional_deployment	Optional enum setting for barid relay security. Example: starttls	starttls, none	-
BARID_RELAY_USERNAME type4_optional_deployment	Optional string setting for barid relay username. Example: standard	string; optional	-
BARID_RELAY_PASSWORD type4_optional_deployment	Optional secret setting for barid relay password. Example: ********en	secret; optional	Not configured

Parameter	Description	Valid Values	Current Value	Change Value
BARID_API_TOKEN type3_required_deployment BARID_API_TOKEN is required.	Required secret setting for barid api token. Example: ********en	secret; required	Not configured

Parameter	Description	Valid Values	Current Value	Change Value
BARID_DATA_PATH type4_optional_deployment	Host data path override for Barid message and database storage. Example: /var/lib/ai-operations/data	path; optional	-

Parameter	Description	Valid Values	Current Value
REQUEST_TIMEOUT_SECONDS type2_required_defaultable	Required integer setting for request timeout seconds. Example: 20	integer; 1 to 500; required	20
MAX_REPORT_FILES type2_required_defaultable	Required integer setting for max report files. Example: 100	integer; 1 to 10000; required	100
BARID_TEST_TOOLS_ENABLED type2_required_defaultable	Enable Barid simulation test tools. Keep disabled outside controlled testing. Example: False	boolean; required	False
BARID_BU_ANALYTICS_PUBLISH_ENABLED type2_required_defaultable	Enable Barid-owned periodic publishing of mailserver BU analytics events to Rasail. Example: True	boolean; required	True
BARID_BU_ANALYTICS_PUBLISH_INTERVAL_SECONDS type2_required_defaultable	Cadence for publishing Barid BU analytics summaries to Rasail. Example: 900	integer; 60 to 86400; required	900
BARID_BU_ANALYTICS_WINDOW_SECONDS type2_required_defaultable	Lookback window used for each Barid BU analytics summary event set. Example: 3600	integer; 60 to 7776000; required	3600
RASAIL_EVENTS_URL type2_required_defaultable	Rasail zone-event intake endpoint used by Barid BU analytics publishing. Example: http://rasail:8000/api/v1/events	string; required	http://rasail:8000/api/v1/events
BARID_ENVIRONMENT type2_required_defaultable	Runtime environment used by Barid transport, TLS, and deployment preflight checks. Example: development	string; required	development
BARID_OUTBOUND_SMTP_TIMEOUT_SECONDS type2_required_defaultable	Per-remote SMTP connection timeout used for relay and direct MX delivery. Example: 8	integer; 1 to 120; required	8
BARID_OUTBOUND_DIRECT_MX_MAX_ATTEMPTS type2_required_defaultable	Maximum MX hosts to try per queued destination when delivering directly without a smarthost. Example: 3	integer; 1 to 10; required	3

Locked Platform Parameters

9 fields

Parameter	Description	Valid Values	Current Value
AGENT_ID type1_system_locked	Required string setting for agent id. Example: standard	string; required	-
AGENT_PORT type1_system_locked	Required integer setting for agent port. Example: 1	integer; 1 to 65535; required	-
AGENT_API_TOKEN type1_system_locked	Required secret setting for agent api token. Example: ********en	secret; required	Not configured
ZONE_ID type1_system_locked	Required string setting for zone id. Example: standard	string; required	-
ZONE_ACTOR type1_system_locked	Required string setting for zone actor. Example: standard	string; required	-
AGENT_DATA_HOST_DIR type1_system_locked	Required path setting for agent data host dir. Example: /var/lib/ai-operations/data	path; required	-
AGENT_ID type1_system_locked	Optional value setting for agent id. Example: barid-core	string; optional	barid-core
AGENT_PORT type1_system_locked	Optional value setting for agent port. Example: 9145	string; optional	9145
BARID_DB_PATH type1_system_locked	Optional path setting for barid db path. Example: /home/abdullah/ai-operations/agents/barid-core/data/db/barid.sqlite3	path; optional	/home/abdullah/ai-operations/agents/barid-core/data/db/barid.sqlite3

Runtime State

DATA_DIR: writable_directory
BARID_DATA_DIR: writable_directory
BARID_SQLITE_STORE: sqlite_quick_check