matrix-docker-ansible-deploy/roles/custom/matrix-bot-postmoogle/defaults/main.yml

180 lines
7.3 KiB
YAML
Raw Normal View History

2022-08-22 17:10:35 +00:00
---
# postmoogle is an email to Matrix bot
# Project source code URL: https://github.com/etkecc/postmoogle
2022-08-22 17:10:35 +00:00
matrix_bot_postmoogle_enabled: true
matrix_bot_postmoogle_container_image_self_build: false
matrix_bot_postmoogle_docker_repo: "https://github.com/etkecc/postmoogle.git"
matrix_bot_postmoogle_docker_repo_version: "{{ 'main' if matrix_bot_postmoogle_version == 'latest' else matrix_bot_postmoogle_version }}"
2022-08-22 17:10:35 +00:00
matrix_bot_postmoogle_docker_src_files_path: "{{ matrix_base_data_path }}/postmoogle/docker-src"
# renovate: datasource=docker depName=ghcr.io/etkecc/postmoogle
matrix_bot_postmoogle_version: v0.9.21
matrix_bot_postmoogle_docker_image: "{{ matrix_bot_postmoogle_docker_image_name_prefix }}etkecc/postmoogle:{{ matrix_bot_postmoogle_version }}"
matrix_bot_postmoogle_docker_image_name_prefix: "{{ 'localhost/' if matrix_bot_postmoogle_container_image_self_build else 'ghcr.io/' }}"
2022-08-22 17:10:35 +00:00
matrix_bot_postmoogle_docker_image_force_pull: "{{ matrix_bot_postmoogle_docker_image.endswith(':latest') }}"
matrix_bot_postmoogle_base_path: "{{ matrix_base_data_path }}/postmoogle"
matrix_bot_postmoogle_config_path: "{{ matrix_bot_postmoogle_base_path }}/config"
matrix_bot_postmoogle_data_path: "{{ matrix_bot_postmoogle_base_path }}/data"
matrix_bot_postmoogle_container_network: ""
matrix_bot_postmoogle_container_additional_networks: "{{ matrix_bot_postmoogle_container_additional_networks_auto + matrix_bot_postmoogle_container_additional_networks_custom }}"
matrix_bot_postmoogle_container_additional_networks_auto: []
matrix_bot_postmoogle_container_additional_networks_custom: []
2022-08-22 17:10:35 +00:00
# A list of extra arguments to pass to the container
matrix_bot_postmoogle_container_extra_arguments: []
# List of systemd services that matrix-bot-postmoogle.service depends on
matrix_bot_postmoogle_systemd_required_services_list: "{{ matrix_bot_postmoogle_systemd_required_services_list_default + matrix_bot_postmoogle_systemd_required_services_list_auto + matrix_bot_postmoogle_systemd_required_services_list_custom }}"
matrix_bot_postmoogle_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
matrix_bot_postmoogle_systemd_required_services_list_auto: []
matrix_bot_postmoogle_systemd_required_services_list_custom: []
2022-08-22 17:10:35 +00:00
# List of systemd services that matrix-bot-postmoogle.service wants
matrix_bot_postmoogle_systemd_wanted_services_list: []
# Database-related configuration fields.
#
# To use SQLite, stick to these defaults.
#
# To use Postgres:
# - change the engine (`matrix_bot_postmoogle_database_engine: 'postgres'`)
# - adjust your database credentials via the `matrix_bot_postmoogle_database_*` variables
matrix_bot_postmoogle_database_engine: 'sqlite'
matrix_bot_postmoogle_sqlite_database_path_local: "{{ matrix_bot_postmoogle_data_path }}/bot.db"
matrix_bot_postmoogle_sqlite_database_path_in_container: "/data/bot.db"
matrix_bot_postmoogle_database_username: 'postmoogle'
matrix_bot_postmoogle_database_password: 'some-password'
matrix_bot_postmoogle_database_hostname: ''
2022-08-22 17:10:35 +00:00
matrix_bot_postmoogle_database_port: 5432
matrix_bot_postmoogle_database_name: 'postmoogle'
matrix_bot_postmoogle_database_sslmode: disable
2022-08-22 17:10:35 +00:00
matrix_bot_postmoogle_database_connection_string: 'postgres://{{ matrix_bot_postmoogle_database_username }}:{{ matrix_bot_postmoogle_database_password }}@{{ matrix_bot_postmoogle_database_hostname }}:{{ matrix_bot_postmoogle_database_port }}/{{ matrix_bot_postmoogle_database_name }}?sslmode={{ matrix_bot_postmoogle_database_sslmode }}'
2022-08-22 17:10:35 +00:00
matrix_bot_postmoogle_storage_database: "{{
{
'sqlite': matrix_bot_postmoogle_sqlite_database_path_in_container,
'postgres': matrix_bot_postmoogle_database_connection_string,
}[matrix_bot_postmoogle_database_engine]
}}"
matrix_bot_postmoogle_database_dialect: "{{
{
'sqlite': 'sqlite3',
'postgres': 'postgres',
}[matrix_bot_postmoogle_database_engine]
}}"
# The bot's username. This user needs to be created manually beforehand.
2023-09-22 17:10:51 +00:00
# Also see `matrix_bot_postmoogle_password` or `matrix_bot_postmoogle_sharedsecret`
2022-08-22 17:10:35 +00:00
matrix_bot_postmoogle_login: "postmoogle"
# The password that the bot uses to authenticate.
matrix_bot_postmoogle_password: ''
2023-09-22 17:10:51 +00:00
# Alternative to password - shared secret requires matrix_bot_postmoogle_login to be MXID
matrix_bot_postmoogle_sharedsecret: ''
matrix_bot_postmoogle_homeserver: ""
2022-08-22 17:10:35 +00:00
# Command prefix
2022-08-22 17:23:39 +00:00
matrix_bot_postmoogle_prefix: '!pm'
# Max email size in megabytes, including attachments
matrix_bot_postmoogle_maxsize: '1024'
2022-08-22 17:10:35 +00:00
2023-09-22 17:10:51 +00:00
# Optional SMTP relay mode
matrix_bot_postmoogle_relay_host: ''
matrix_bot_postmoogle_relay_port: ''
matrix_bot_postmoogle_relay_username: ''
matrix_bot_postmoogle_relay_password: ''
# A list of admins
# Example set of rules:
# matrix_bot_postmoogle_admins:
# - '@someone:example.com'
# - '@another:example.com'
# - '@bot.*:example.com'
# - '@*:example.net'
matrix_bot_postmoogle_admins: "{{ [matrix_admin] if matrix_admin else [] }}"
2022-12-06 20:51:17 +00:00
# Sentry DSN. Deprecated, use matrix_bot_postmoogle_monitoring_sentry_dsn
2022-08-22 17:10:35 +00:00
matrix_bot_postmoogle_sentry: ''
2022-12-06 20:51:17 +00:00
# Sentry integration
matrix_bot_postmoogle_monitoring_sentry_dsn: "{{ matrix_bot_postmoogle_sentry }}"
matrix_bot_postmoogle_monitoring_sentry_rate: 20
# healthchecks.io integration
matrix_bot_postmoogle_monitoring_healthchecks_uuid: ''
matrix_bot_postmoogle_monitoring_healthchecks_duration: 60
2022-08-22 17:10:35 +00:00
# Log level
2022-08-23 10:55:53 +00:00
matrix_bot_postmoogle_loglevel: 'INFO'
2022-08-22 17:10:35 +00:00
2022-11-18 22:55:03 +00:00
# deprecated, use matrix_bot_postmoogle_domains
2022-08-22 17:10:35 +00:00
matrix_bot_postmoogle_domain: "{{ matrix_server_fqn_matrix }}"
2022-11-18 22:55:03 +00:00
matrix_bot_postmoogle_domains:
2022-11-20 16:02:50 +00:00
- "{{ matrix_bot_postmoogle_domain }}" # backward compatibility
2022-11-18 22:55:03 +00:00
2022-10-06 20:08:58 +00:00
# Password (passphrase) to encrypt account data
matrix_bot_postmoogle_data_secret: ""
2022-09-09 07:47:00 +00:00
# in-container ports
2022-08-23 10:55:53 +00:00
matrix_bot_postmoogle_port: '2525'
2022-09-09 07:47:00 +00:00
matrix_bot_postmoogle_tls_port: '25587'
2022-08-23 10:55:53 +00:00
2022-09-09 07:47:00 +00:00
# on-host ports
2022-08-23 10:55:53 +00:00
matrix_bot_postmoogle_smtp_host_bind_port: '25'
2022-09-09 10:19:25 +00:00
matrix_bot_postmoogle_submission_host_bind_port: '587'
### SSL
## on-host SSL dir
matrix_bot_postmoogle_ssl_path: ""
## in-container SSL paths
2022-11-18 22:55:03 +00:00
# matrix_bot_postmoogle_tls_cert is the SSL certificates' certificates.
# This var is likely set via group_vars/matrix_servers, so you don't need to set certs manually.
2022-09-09 10:19:25 +00:00
# If you do need to set it manually, note that this is an in-container path.
# To mount a certificates volumes into the container, use matrix_bot_postmoogle_ssl_path
# Example value: /ssl/live/{{ matrix_bot_postmoogle_domain }}/fullchain.pem
matrix_bot_postmoogle_tls_cert: ""
2022-11-18 22:55:03 +00:00
# matrix_bot_postmoogle_tls_key is the SSL certificates' keys.
# This var is likely set via group_vars/matrix_servers, so you don't need to set keys manually.
2022-09-09 10:19:25 +00:00
# If you do need to set it manually, note that this is an in-container path.
# To mount a certificates volumes into the container, use matrix_bot_postmoogle_ssl_path
# Example value: /ssl/live/{{ matrix_bot_postmoogle_domain }}/privkey.pem
matrix_bot_postmoogle_tls_key: ""
2022-09-09 07:47:00 +00:00
2022-09-09 10:19:25 +00:00
# Mandatory TLS, even on plain SMTP port
matrix_bot_postmoogle_tls_required: false
2022-08-22 17:10:35 +00:00
2022-12-06 20:51:17 +00:00
# trusted proxies
matrix_bot_postmoogle_proxies: []
2023-09-22 17:10:51 +00:00
# known forwarders
matrix_bot_postmoogle_mailboxes_forwarded: []
2022-12-06 20:51:17 +00:00
# reserved mailboxes
matrix_bot_postmoogle_mailboxes_reserved: []
# mailbox activation flow
matrix_bot_postmoogle_mailboxes_activation: none
2022-08-22 17:10:35 +00:00
# Additional environment variables to pass to the postmoogle container
#
# Example:
# matrix_bot_postmoogle_environment_variables_extension: |
# postmoogle_TEXT_DONE=Done
matrix_bot_postmoogle_environment_variables_extension: ''