All settings

Every documented yarilo.yaml setting, grouped by section. Each name links to its full description, and the type and default are repeated here for a quick scan.

Top level

hostname: string
chart_version: string

`general.ssl`

ssl_server_cert_file: string
ssl_server_key_file: string
ssl_server_alt_cert_file: string
ssl_server_alt_key_file: string
ssl_min_protocol: string, default TLS1.2
ssl_prefer_server_ciphers: boolean, default false

`general.haproxy`

timeout: integer, default 3
haproxy_trusted_networks: list, default 127.0.0.1/32, 10.0.0.0/8

`general.xclient`

trusted_nets: list, default []

`general.limits`

mail_max_userip_connections: integer, default 10

`general`

startup_dial_retries: integer, default 3

`login`

login_proxy_timeout: integer, default 30
transient_retries: integer, default 3
transient_relogin_cap: integer, default 3

`auth_service`

auth_startup_wait: integer, default 30

`locks_client`

locks_client_startup_wait: integer, default 30
mode: string
endpoints: list, default []
socket: string

`auth_client`

auth_client_pool_size: integer, default 4
auth_client_pool_idle_timeout: integer, default 300

`internal_tls`

session_cache_size: integer, default 64
session_cache_ttl: integer, default 0
enabled: boolean, default true
cert: string, default /etc/yarilo/tls/tls.crt
key: string, default /etc/yarilo/tls/tls.key
ca: string, default /etc/yarilo/tls/ca.crt
server_name: string

`director_service`

backend_expire: integer, default 30
assignment_policy: string, default hash
director_domain_expire: integer, default 900
director_domain_rebalance_percent: integer, default 0
director_domain_rebalance_interval: integer, default 60
director_domain_rebalance_cooldown: integer, default 600
user_expire: integer, default 900
user_kick_delay: integer, default 2
max_parallel_kicks: integer, default 100
max_parallel_moves: integer, default 5
listen: string, default :9102
ping_interval: integer, default 30
ping_timeout: integer, default 10
write_timeout: integer, default 10
peers: list, default []
backend_unreachable_reporters: integer, default 2
backend_unreachable_window: integer, default 5
join_allowed_nets: list, default []
anti_entropy_interval: integer, default 3
tombstone_ttl: integer, default 600
ring_tls_server_name: string
seed_poll_interval: integer, default 2
seed_poll_idle_interval: integer, default 2
min_members: integer, default 3
ring_secret: string

`backend_register`

director_addr: string
register_interval: integer, default 10
tag: string
vhosts: integer, default 100

`telemetry.liveness_watchdog`

liveness_watchdog_enabled: boolean, default false
liveness_watchdog_interval_seconds: integer, default 10
liveness_watchdog_timeout_seconds: integer, default 5
liveness_watchdog_failure_threshold: integer, default 3
liveness_watchdog_fault_injection_enabled: boolean, default false

`telemetry`

telemetry_pprof_enabled: boolean, default false
telemetry_block_profile_rate: integer, default 0
telemetry_mutex_profile_fraction: integer, default 0
listen: string, default :8080

`warden_service`

state_backend: string
redis_password: string

`auth.token`

redis_password: string

`locks_service`

redis_password: string
mode: string
listen: string
redis: string
socket: string

`auth.passdb[]`

driver: string
dsn: string
passwd_file_path: string
passdb_sql_query: string
userdb_sql_query: string
userdb_sql_iterate_query: string
passdb_default_password_scheme: string
skip_schema: boolean, default false
max_open_conns: integer
max_idle_conns: integer
conn_max_lifetime: integer
conn_max_idle_time: integer
username_filter: string
static_password: string
nopassword: boolean, default false
fields: map, default {}
userdb_static_allow_all_users: boolean, default false

`auth`

auth_max_attempts: integer, default 3
auth_failure_delay: integer, default 2
internal_failure_delay_ms: integer, default 2000

`auth.cache`

auth_cache_size: string
auth_cache_ttl: integer, default 1800
auth_cache_negative_ttl: integer, default 1800

`threading`

threading_enabled: boolean, default true
threading_cache_idle: integer, default 300

`sieve`

sieve_enabled: boolean, default false
sieve_max_script_size: integer, default 65536
sieve_max_redirects: integer, default 32
sieve_max_num_scripts: integer, default 0
sieve_max_storage: integer, default 0
sieve_max_actions: integer, default 32
sieve_global: string
sieve_vacation_enabled: boolean, default true
sieve_vacation_min_period: integer, default 86400
sieve_vacation_max_period: integer, default 5184000
sieve_vacation_default_period: integer, default 604800
sieve_vacation_default_subject: string
sieve_vacation_default_subject_template: string
sieve_vacation_use_original_recipient: boolean, default false
sieve_vacation_check_recipient: boolean, default true
sieve_vacation_send_from_recipient: boolean, default false
sieve_vacation_to_header_ignore_envelope: boolean, default false
sieve_spamtest_status_header: string
sieve_spamtest_max_value: number, default 10
sieve_virustest_status_header: string
sieve_virustest_max_value: number, default 5
sieve_submission_host: string
sieve_submission_ssl: string, default no
sieve_submission_timeout: integer, default 30
sieve_submission_auth_secret: string
sieve_default_name: string, default yarilo
sieve_extensions: list, default []
sieve_global_extensions: list, default []
sieve_scripts_driver: string
sieve_scripts_dict: string
sieve_pipe_bin_dir: string, default /usr/lib/yarilo/sieve-pipe
sieve_pipe_socket_dir: string, default sieve-pipe
sieve_pipe_exec_timeout: integer, default 10
sieve_pipe_input_eol: string, default crlf
sieve_filter_bin_dir: string, default /usr/lib/yarilo/sieve-filter
sieve_filter_socket_dir: string, default sieve-filter
sieve_filter_exec_timeout: integer, default 10
sieve_filter_input_eol: string, default crlf
sieve_execute_bin_dir: string, default /usr/lib/yarilo/sieve-execute
sieve_execute_socket_dir: string, default sieve-execute
sieve_execute_exec_timeout: integer, default 10
sieve_execute_input_eol: string, default crlf
sieve_report_user_agent: string, default yarilo

`protocol.managesieve`

max_invalid_commands: integer, default 3
managesieve_max_line_length: integer, default 65536

`director_service.api`

listen: string, default :9103
allowed_nets: list, default []

`director_service.shutdown`

session_grace_period: integer, default 30

`director_service.mail_servers[]`

host: string
port: integer, default 0
tag: string
vhosts: integer

`auth.policy`

auth_policy_server_url: string
auth_policy_server_api_header: string
auth_policy_hash_mech: string, default sha256
auth_policy_hash_nonce: string
auth_policy_hash_truncate: integer, default 12
timeout_ms: integer, default 5000
auth_policy_reject_on_fail: boolean, default false
auth_policy_log_only: boolean, default false
auth_policy_check_before_auth: boolean, default true
auth_policy_check_after_auth: boolean, default true
auth_policy_report_after_auth: boolean, default true

`protocol.lmtp`

login_greeting: string, default Yarilo ready.
lmtp_add_received_header: boolean, default true
lmtp_add_message_id: boolean, default true
lmtp_save_to_detail_mailbox: boolean, default false
lda_mailbox_autocreate: boolean, default false
lda_mailbox_autosubscribe: boolean, default false
quota_full_tempfail: boolean, default false
lmtp_hdr_delivery_address: string, default final
lmtp_verbose_replies: boolean, default false
lmtp_user_concurrency_limit: integer, default 10
lmtp_max_recipients: integer, default 0
read_timeout: integer, default 300
write_timeout: integer, default 300
lmtp_client_workarounds: list, default []

`protocol.lmtp.rate_limit`

rate_limit_enabled: boolean, default true
rate_limit_per_recipient_burst: integer, default 100
rate_limit_per_recipient_window_seconds: integer, default 60

`protocol.lmtp.proxy`

lmtp_proxy_timeout: integer, default 125

`lmtp_login_service`

backend_addr: string
director_addr: string
director_tag: string
backend_port: integer, default 0

`protocol.submission`

hostname: string
submission_max_mail_size: string, default 40M
max_line_length: integer, default 4096
submission_max_recipients: integer, default 0
recipient_delimiter: string, default +
submission_client_workarounds: list, default []
submission_add_received_header: boolean, default true

`protocol.submission.relay`

submission_relay_host: string
submission_relay_port: integer, default 25
submission_relay_user: string
submission_relay_master_user: string
submission_relay_password: string
submission_relay_ssl: string, default no
submission_relay_ssl_verify: boolean, default true
submission_relay_ssl_ca: string
submission_relay_trusted: boolean, default false
submission_relay_connect_timeout: integer, default 30
submission_relay_command_timeout: integer, default 300

`protocol.imap`

imap_idle_notify_interval: integer, default 120
imap_max_line_length: integer, default 65536
imap_id_send: string, default name *
login_greeting: string
imap_logout_format: string
imap_quota: boolean, default true
imap_special_use_defaults: map, default Archive: \Archive, Drafts: \Drafts, Junk: \Junk, Sent: \Sent, Trash: \Trash
imap_client_workarounds: list, default []

`protocol.pop3`

pop3_no_flag_updates: boolean, default false
pop3_reuse_xuidl: boolean, default false
pop3_uidl_format: string, default %u.%v
pop3_uidl_duplicates: string, default rename
pop3_enable_last: boolean, default false
pop3_delete_type: string, default expunge
pop3_deleted_flag: string
pop3_save_uidl: boolean, default false
pop3_lock_session: boolean, default false

`protocol.jmap`

jmap_base_url: string
jmap_max_concurrent_requests: integer, default 10
jmap_max_calls_in_request: integer, default 16
jmap_max_objects_in_get: integer, default 500
jmap_max_objects_in_set: integer, default 500
jmap_max_size_upload: string, default 40M
jmap_max_size_request: string, default 10M
jmap_max_body_value_bytes: string, default 256K
jmap_query_max_limit: integer, default 256
jmap_max_query_folders: integer, default 64
jmap_snippet_max_chars: integer, default 256
jmap_upload_ttl: integer, default 3600
jmap_submission_ttl_seconds: integer, default 86400
jmap_push_poll: integer, default 60
jmap_cors_allow_origins: list, default []

`storage`

mdbox_rotate_size: string, default 10M
mdbox_rotate_interval: string
mdbox_preallocate_space: boolean, default false
mdbox_map_format: string
mail_index_log_rotate_min_size: string, default 32k
mail_index_log_rotate_min_age: integer, default 60
mail_index_log_rotate_max_size: string, default 1M
storage_lock_method: string
storage_lock_stale_timeout: integer, default 180
mail_cache_purge_delete_percentage: integer, default 20
mail_cache_purge_continued_percentage: integer, default 200
mail_cache_purge_min_size: string
max_concurrent_writes: integer, default 0
mailbox_list_validate_fs_names: boolean, default true
mailbox_list_reserved_segments: list, default cur, new, tmp, dbox-Mails, fts-flatcurve
mailbox_list_refuse_layout_separator: boolean, default false
mailbox_list_storage_escape_char: string
mailbox_list_normalize_names_to_nfc: boolean, default true
mailbox_list_utf8: boolean, default true

`dict_service`

dict_listen: string
dict_addr: string
dict_max_conns: integer, default 8

`quota`

quota_storage_percentage: integer, default 100
quota_message_percentage: integer, default 100
quota_storage_extra: string
quota_storage_grace: string, default 10M
quota_ignore_unlimited: boolean, default false
quota_mailbox_count: integer, default 0
quota_mailbox_message_count: integer, default 0
quota_hidden: boolean, default false

`quota_status`

listen: string, default :12340
recipient_delimiter: string, default +
default_quota_rules: list, default []
alias_dict: string
alias_max_hops: integer, default 5
quota_status_success: string, default OK
quota_status_overquota: string, default 554 5.2.2 %{error}
quota_status_toolarge: string
quota_status_nouser: string, default REJECT Unknown user

`namespaces[].mailboxes.*`

auto: string
special_use: string

Helm values: `redis`

passwordSecret: map, default name: , key: password

Helm values: `internalTLS.ca`

secretName: string

Helm values: `internalTLS`

certGeneration: integer, default 0

Helm values: `internalTLS.certManager`

enabled: boolean, default false
issuerRef: map, default kind: Issuer, name:

Helm values: `networkPolicy`

enabled: boolean, default true
adminFrom: list, default []
mtaFrom: list, default []
telemetryFrom: list, default []

Helm values: `sieve`

sieve_global_scripts: map, default {}

Helm values: `components.auth.policy`

api_header_secret_ref: map, default name: , key: api_header
hash_nonce_secret_ref: map, default name: , key: hash_nonce

All settings ​

Top level ​

general.ssl ​

general.haproxy ​

general.xclient ​

general.limits ​

general ​

login ​

auth_service ​

locks_client ​

auth_client ​

internal_tls ​

director_service ​

backend_register ​

telemetry.liveness_watchdog ​

telemetry ​

warden_service ​

auth.token ​

locks_service ​

auth.passdb[] ​

auth ​

auth.cache ​

threading ​

sieve ​

protocol.managesieve ​

director_service.api ​

director_service.shutdown ​

director_service.mail_servers[] ​

auth.policy ​

protocol.lmtp ​

protocol.lmtp.rate_limit ​

protocol.lmtp.proxy ​

lmtp_login_service ​

protocol.submission ​

protocol.submission.relay ​

protocol.imap ​

protocol.pop3 ​

protocol.jmap ​

storage ​

dict_service ​

quota ​

quota_status ​

namespaces[].mailboxes.* ​

Helm values: redis ​

Helm values: internalTLS.ca ​

Helm values: internalTLS ​

Helm values: internalTLS.certManager ​

Helm values: networkPolicy ​

Helm values: sieve ​

Helm values: components.auth.policy ​

All settings

Top level

`general.ssl`

`general.haproxy`

`general.xclient`

`general.limits`

`general`

`login`

`auth_service`

`locks_client`

`auth_client`

`internal_tls`

`director_service`

`backend_register`

`telemetry.liveness_watchdog`

`telemetry`

`warden_service`

`auth.token`

`locks_service`

`auth.passdb[]`

`auth`

`auth.cache`

`threading`

`sieve`

`protocol.managesieve`

`director_service.api`

`director_service.shutdown`

`director_service.mail_servers[]`

`auth.policy`

`protocol.lmtp`

`protocol.lmtp.rate_limit`

`protocol.lmtp.proxy`

`lmtp_login_service`

`protocol.submission`

`protocol.submission.relay`

`protocol.imap`

`protocol.pop3`

`protocol.jmap`

`storage`

`dict_service`

`quota`

`quota_status`

`namespaces[].mailboxes.*`

Helm values: `redis`

Helm values: `internalTLS.ca`

Helm values: `internalTLS`

Helm values: `internalTLS.certManager`

Helm values: `networkPolicy`

Helm values: `sieve`

Helm values: `components.auth.policy`