--- # buscarron is a Web forms (HTTP POST) to Matrix service. # Project source code URL: https://gitlab.com/etke.cc/buscarron matrix_bot_buscarron_enabled: true # renovate: datasource=docker depName=registry.gitlab.com/etke.cc/buscarron matrix_bot_buscarron_version: v1.4.1 # The hostname at which Buscarron is served. matrix_bot_buscarron_hostname: '' # The path at which Buscarron is exposed. # This value must either be `/` or not end with a slash (e.g. `/buscarron`). matrix_bot_buscarron_path_prefix: / # The path at which Buscarron will expose metrics # This value must either be `/` or not end with a slash (e.g. `/metrics`). matrix_bot_buscarron_metrics_path: /metrics matrix_bot_buscarron_base_path: "{{ matrix_base_data_path }}/buscarron" matrix_bot_buscarron_config_path: "{{ matrix_bot_buscarron_base_path }}/config" matrix_bot_buscarron_data_path: "{{ matrix_bot_buscarron_base_path }}/data" matrix_bot_buscarron_data_store_path: "{{ matrix_bot_buscarron_data_path }}/store" matrix_bot_buscarron_container_image_self_build: false matrix_bot_buscarron_docker_repo: "https://gitlab.com/etke.cc/buscarron.git" matrix_bot_buscarron_docker_repo_version: "{{ matrix_bot_buscarron_version }}" matrix_bot_buscarron_docker_src_files_path: "{{ matrix_base_data_path }}/buscarron/docker-src" matrix_bot_buscarron_docker_image: "{{ matrix_bot_buscarron_docker_image_name_prefix }}etke.cc/buscarron:{{ matrix_bot_buscarron_version }}" matrix_bot_buscarron_docker_image_name_prefix: "{{ 'localhost/' if matrix_bot_buscarron_container_image_self_build else 'registry.gitlab.com/' }}" matrix_bot_buscarron_docker_image_force_pull: "{{ matrix_bot_buscarron_docker_image.endswith(':latest') }}" # The base container network. It will be auto-created by this role if it doesn't exist already. matrix_bot_buscarron_container_network: matrix-bot-buscarron # A list of additional container networks that the container would be connected to. # The role does not create these networks, so make sure they already exist. # Use this to expose this container to another reverse proxy, which runs in a different container network. matrix_bot_buscarron_container_additional_networks: "{{ matrix_bot_buscarron_container_additional_networks_auto + matrix_bot_buscarron_container_additional_networks_custom }}" matrix_bot_buscarron_container_additional_networks_auto: [] matrix_bot_buscarron_container_additional_networks_custom: [] # /metrics login matrix_bot_buscarron_metrics_login: '' # /metrics password matrix_bot_buscarron_metrics_password: '' # /metrics allowed ips matrix_bot_buscarron_metrics_ips: [] # matrix_bot_buscarron_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container. # See `../templates/labels.j2` for details. # # To inject your own other container labels, see `matrix_bot_buscarron_container_labels_additional_labels`. matrix_bot_buscarron_container_labels_traefik_enabled: true matrix_bot_buscarron_container_labels_traefik_docker_network: "{{ matrix_bot_buscarron_container_network }}" matrix_bot_buscarron_container_labels_traefik_hostname: "{{ matrix_bot_buscarron_hostname }}" # The path prefix must either be `/` or not end with a slash (e.g. `/buscarron`). matrix_bot_buscarron_container_labels_traefik_path_prefix: "{{ matrix_bot_buscarron_path_prefix }}" matrix_bot_buscarron_container_labels_traefik_rule: "Host(`{{ matrix_bot_buscarron_container_labels_traefik_hostname }}`){% if matrix_bot_buscarron_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_bot_buscarron_container_labels_traefik_path_prefix }}`){% endif %}" matrix_bot_buscarron_container_labels_traefik_metrics_path: "{{ matrix_bot_buscarron_metrics_path }}" matrix_bot_buscarron_container_labels_traefik_metrics_rule: "Host(`{{ matrix_bot_buscarron_container_labels_traefik_hostname }}`) && Path(`{{ matrix_bot_buscarron_container_labels_traefik_metrics_path }}`)" matrix_bot_buscarron_container_labels_traefik_priority: 0 matrix_bot_buscarron_container_labels_traefik_entrypoints: web-secure matrix_bot_buscarron_container_labels_traefik_tls: "{{ matrix_bot_buscarron_container_labels_traefik_entrypoints != 'web' }}" matrix_bot_buscarron_container_labels_traefik_tls_certResolver: default # noqa var-naming # Controls which additional headers to attach to all HTTP responses. # To add your own headers, use `matrix_bot_buscarron_container_labels_traefik_additional_response_headers_custom` matrix_bot_buscarron_container_labels_traefik_additional_response_headers: "{{ matrix_bot_buscarron_container_labels_traefik_additional_response_headers_auto | combine(matrix_bot_buscarron_container_labels_traefik_additional_response_headers_custom) }}" matrix_bot_buscarron_container_labels_traefik_additional_response_headers_auto: {} matrix_bot_buscarron_container_labels_traefik_additional_response_headers_custom: {} # matrix_bot_buscarron_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file. # See `../templates/labels.j2` for details. # # Example: # matrix_bot_buscarron_container_labels_additional_labels: | # my.label=1 # another.label="here" matrix_bot_buscarron_container_labels_additional_labels: '' # A list of extra arguments to pass to the container matrix_bot_buscarron_container_extra_arguments: [] # List of systemd services that matrix-bot-buscarron.service depends on matrix_bot_buscarron_systemd_required_services_list: "{{ matrix_bot_buscarron_systemd_required_services_list_default + matrix_bot_buscarron_systemd_required_services_list_auto + matrix_bot_buscarron_systemd_required_services_list_custom }}" matrix_bot_buscarron_systemd_required_services_list_default: ['docker.service'] matrix_bot_buscarron_systemd_required_services_list_auto: [] matrix_bot_buscarron_systemd_required_services_list_custom: [] # List of systemd services that matrix-bot-buscarron.service wants matrix_bot_buscarron_systemd_wanted_services_list: [] # Database-related configuration fields. # # To use SQLite, stick to these defaults. # # To use Postgres: # - change the engine (`matrix_bot_buscarron_database_engine: 'postgres'`) # - adjust your database credentials via the `matrix_bot_buscarron_database_*` variables matrix_bot_buscarron_database_engine: 'sqlite' matrix_bot_buscarron_sqlite_database_path_local: "{{ matrix_bot_buscarron_data_path }}/bot.db" matrix_bot_buscarron_sqlite_database_path_in_container: "/data/bot.db" matrix_bot_buscarron_database_username: 'buscarron' matrix_bot_buscarron_database_password: 'some-password' matrix_bot_buscarron_database_hostname: '' matrix_bot_buscarron_database_port: 5432 matrix_bot_buscarron_database_name: 'buscarron' matrix_bot_buscarron_database_sslmode: disable matrix_bot_buscarron_database_connection_string: 'postgres://{{ matrix_bot_buscarron_database_username }}:{{ matrix_bot_buscarron_database_password }}@{{ matrix_bot_buscarron_database_hostname }}:{{ matrix_bot_buscarron_database_port }}/{{ matrix_bot_buscarron_database_name }}?sslmode={{ matrix_bot_buscarron_database_sslmode }}' matrix_bot_buscarron_storage_database: "{{ { 'sqlite': matrix_bot_buscarron_sqlite_database_path_in_container, 'postgres': matrix_bot_buscarron_database_connection_string, }[matrix_bot_buscarron_database_engine] }}" matrix_bot_buscarron_database_dialect: "{{ { 'sqlite': 'sqlite3', 'postgres': 'postgres', }[matrix_bot_buscarron_database_engine] }}" # The bot's username. This user needs to be created manually beforehand. # Also see `matrix_bot_buscarron_password`. matrix_bot_buscarron_login: "bot.buscarron" # The password that the bot uses to authenticate. matrix_bot_buscarron_password: '' # the homeserver URL, uses internal synapse container address by default matrix_bot_buscarron_homeserver: "" # forms configuration matrix_bot_buscarron_forms: [] # Sentry DSN matrix_bot_buscarron_sentry: '' # Log level matrix_bot_buscarron_loglevel: INFO # list of spammers with wildcards support, eg: *@spam.com spam@*, spam@spam.com matrix_bot_buscarron_spamlist: [] # Banlist size matrix_bot_buscarron_ban_size: 10000 # Permanent banlist matrix_bot_buscarron_ban_list: [] # Postmark token (confirmation emails) matrix_bot_buscarron_pm_token: '' # Postmark sender signature matrix_bot_buscarron_pm_from: '' # Postmark confirmation email's reply-to matrix_bot_buscarron_pm_replyto: '' # email address (from) for SMTP validation. Must be valid email on valid SMTP server, otherwise it will be rejected by other servers matrix_bot_buscarron_smtp_from: '' # enforce SMTP validation matrix_bot_buscarron_smtp_validation: false # Additional environment variables to pass to the buscarron container # # Example: # matrix_bot_buscarron_environment_variables_extension: | # BUSCARRON_LOGLEVEL=DEBUG matrix_bot_buscarron_environment_variables_extension: ''