| @@ -24,6 +24,31 @@ ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.go-neb | |||||
| Once the user is created you can [obtain an access token](obtaining-access-tokens.md). | Once the user is created you can [obtain an access token](obtaining-access-tokens.md). | ||||
| ## Decide on a domain and path | |||||
| By default, Go-NEB is configured to use its own dedicated domain (`goneb.DOMAIN`) and requires you to [adjust your DNS records](#adjusting-dns-records). | |||||
| You can override the domain and path like this: | |||||
| ```yaml | |||||
| # Switch to the domain used for Matrix services (`matrix.DOMAIN`), | |||||
| # so we won't need to add additional DNS records for Go-NEB. | |||||
| matrix_bot_go_neb_hostname: "{{ matrix_server_fqn_matrix }}" | |||||
| # Expose under the /go-neb subpath | |||||
| matrix_bot_go_neb_path_prefix: /go-neb | |||||
| ``` | |||||
| **NOTE**: When using `matrix-nginx-proxy` instead of Traefik, you won't be able to override the path prefix. You can only override the domain, but that needs to happen using another variable: `matrix_server_fqn_go_neb` (e.g. `matrix_server_fqn_go_neb: "mybot.{{ matrix_domain }}"`). | |||||
| ## Adjusting DNS records | |||||
| Once you've decided on the domain and path, **you may need to adjust your DNS** records to point the Go-NEB domain to the Matrix server. | |||||
| If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration. | |||||
| ## Adjusting the playbook configuration | ## Adjusting the playbook configuration | ||||
| Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file (adapt to your needs): | Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file (adapt to your needs): | ||||
| @@ -193,9 +218,7 @@ matrix_bot_go_neb_services: | |||||
| ## Installing | ## Installing | ||||
| Don't forget to add `goneb.<your-domain>` to DNS as described in [Configuring DNS](configuring-dns.md) before running the playbook. | |||||
| After configuring the playbook, run the [installation](installing.md) command again: | |||||
| After potentially [adjusting DNS records](#adjusting-dns-records) and configuring the playbook, run the [installation](installing.md) command again: | |||||
| ``` | ``` | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | ||||
| @@ -1829,17 +1829,41 @@ matrix_bot_chatgpt_container_image_self_build: "{{ matrix_architecture not in [' | |||||
| # We don't enable bots by default. | # We don't enable bots by default. | ||||
| matrix_bot_go_neb_enabled: false | matrix_bot_go_neb_enabled: false | ||||
| matrix_bot_go_neb_scheme: "{{ 'https' if matrix_playbook_ssl_enabled else 'http' }}" | |||||
| matrix_bot_go_neb_hostname: "{{ matrix_server_fqn_bot_go_neb }}" | |||||
| matrix_bot_go_neb_container_network: "{{ matrix_nginx_proxy_container_network if matrix_playbook_reverse_proxy_type == 'playbook-managed-nginx' else 'matrix-bot-go-neb' }}" | |||||
| matrix_bot_go_neb_container_additional_networks: | | |||||
| {{ | |||||
| ( | |||||
| ([matrix_playbook_reverse_proxyable_services_additional_network] if matrix_playbook_reverse_proxyable_services_additional_network else []) | |||||
| + | |||||
| ([matrix_homeserver_container_network] if matrix_homeserver_container_network != matrix_bot_go_neb_container_network else []) | |||||
| + | |||||
| ([devture_postgres_container_network] if devture_postgres_enabled and devture_postgres_container_network != matrix_bot_go_neb_container_network else []) | |||||
| ) | unique | |||||
| }} | |||||
| matrix_bot_go_neb_container_http_host_bind_port: "{{ (matrix_playbook_service_host_bind_interface_prefix ~ '4050') if matrix_playbook_service_host_bind_interface_prefix else '' }}" | |||||
| matrix_bot_go_neb_container_labels_traefik_enabled: "{{ matrix_playbook_traefik_labels_enabled }}" | |||||
| matrix_bot_go_neb_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" | |||||
| matrix_bot_go_neb_container_labels_traefik_entrypoints: "{{ devture_traefik_entrypoint_primary }}" | |||||
| matrix_bot_go_neb_container_labels_traefik_tls_certResolver: "{{ devture_traefik_certResolver_primary }}" | |||||
| matrix_bot_go_neb_systemd_required_services_list: | | matrix_bot_go_neb_systemd_required_services_list: | | ||||
| {{ | {{ | ||||
| ['docker.service'] | ['docker.service'] | ||||
| + | + | ||||
| ['matrix-' + matrix_homeserver_implementation + '.service'] | ['matrix-' + matrix_homeserver_implementation + '.service'] | ||||
| + | + | ||||
| ([devture_postgres_identifier + '.service'] if devture_postgres_enabled else []) | |||||
| + | |||||
| (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else []) | (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else []) | ||||
| }} | }} | ||||
| matrix_bot_go_neb_container_http_host_bind_port: "{{ (matrix_playbook_service_host_bind_interface_prefix ~ '4050') if matrix_playbook_service_host_bind_interface_prefix else '' }}" | |||||
| ###################################################################### | ###################################################################### | ||||
| # | # | ||||
| # /matrix-bot-go-neb | # /matrix-bot-go-neb | ||||
| @@ -2497,7 +2521,7 @@ matrix_nginx_proxy_proxy_buscarron_enabled: "{{ matrix_bot_buscarron_enabled and | |||||
| matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | ||||
| matrix_nginx_proxy_proxy_rageshake_enabled: "{{ matrix_rageshake_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | matrix_nginx_proxy_proxy_rageshake_enabled: "{{ matrix_rageshake_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | ||||
| matrix_nginx_proxy_proxy_etherpad_enabled: "{{ etherpad_enabled and not etherpad_nginx_proxy_dimension_integration_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | matrix_nginx_proxy_proxy_etherpad_enabled: "{{ etherpad_enabled and not etherpad_nginx_proxy_dimension_integration_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | ||||
| matrix_nginx_proxy_proxy_bot_go_neb_enabled: "{{ matrix_bot_go_neb_enabled }}" | |||||
| matrix_nginx_proxy_proxy_bot_go_neb_enabled: "{{ matrix_bot_go_neb_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | |||||
| matrix_nginx_proxy_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}" | matrix_nginx_proxy_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}" | ||||
| matrix_nginx_proxy_proxy_jitsi_manage_wellknown: "{{ matrix_jitsi_require_well_known }}" | matrix_nginx_proxy_proxy_jitsi_manage_wellknown: "{{ matrix_jitsi_require_well_known }}" | ||||
| @@ -2512,7 +2536,6 @@ matrix_nginx_proxy_container_labels_traefik_entrypoints: "{{ devture_traefik_ent | |||||
| matrix_nginx_proxy_container_labels_traefik_tls_certResolver: "{{ devture_traefik_certResolver_primary }}" | matrix_nginx_proxy_container_labels_traefik_tls_certResolver: "{{ devture_traefik_certResolver_primary }}" | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_matrix_enabled: true | matrix_nginx_proxy_container_labels_traefik_proxy_matrix_enabled: true | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_bot_go_neb_enabled: "{{ matrix_bot_go_neb_enabled }}" | |||||
| matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}" | matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}" | ||||
| matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: "{{ matrix_corporal_enabled and matrix_corporal_http_api_enabled }}" | matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: "{{ matrix_corporal_enabled and matrix_corporal_http_api_enabled }}" | ||||
| @@ -1,11 +1,22 @@ | |||||
| --- | --- | ||||
| # Go-NEB is a Matrix bot written in Go. It is the successor to Matrix-NEB, the original Matrix bot written in Python. | # Go-NEB is a Matrix bot written in Go. It is the successor to Matrix-NEB, the original Matrix bot written in Python. | ||||
| # Project source code URL: https://github.com/matrix-org/go-neb | # Project source code URL: https://github.com/matrix-org/go-neb | ||||
| matrix_bot_go_neb_enabled: true | matrix_bot_go_neb_enabled: true | ||||
| matrix_bot_go_neb_version: latest | matrix_bot_go_neb_version: latest | ||||
| matrix_bot_go_neb_docker_image: "matrixdotorg/go-neb:{{ matrix_bot_go_neb_version }}" | |||||
| matrix_bot_go_neb_docker_image_force_pull: "{{ matrix_bot_go_neb_docker_image.endswith(':latest') }}" | |||||
| matrix_bot_go_neb_scheme: https | |||||
| # The hostname at which Go-NEB is served. | |||||
| matrix_bot_go_neb_hostname: '' | |||||
| # The path at which Go-NEB is exposed. | |||||
| # This value must either be `/` or not end with a slash (e.g. `/go-neb`). | |||||
| matrix_bot_go_neb_path_prefix: / | |||||
| matrix_bot_go_neb_base_url: "{{ matrix_bot_go_neb_scheme }}://{{ matrix_bot_go_neb_hostname }}{{ matrix_bot_go_neb_path_prefix }}{{ '' if matrix_bot_go_neb_path_prefix == '/' else '/' }}" | |||||
| matrix_bot_go_neb_base_path: "{{ matrix_base_data_path }}/go-neb" | matrix_bot_go_neb_base_path: "{{ matrix_base_data_path }}/go-neb" | ||||
| matrix_bot_go_neb_config_path: "{{ matrix_bot_go_neb_base_path }}/config" | matrix_bot_go_neb_config_path: "{{ matrix_bot_go_neb_base_path }}/config" | ||||
| @@ -13,11 +24,63 @@ matrix_bot_go_neb_config_path_in_container: "/config/config.yaml" | |||||
| matrix_bot_go_neb_data_path: "{{ matrix_bot_go_neb_base_path }}/data" | matrix_bot_go_neb_data_path: "{{ matrix_bot_go_neb_base_path }}/data" | ||||
| matrix_bot_go_neb_data_store_path: "{{ matrix_bot_go_neb_data_path }}/store" | matrix_bot_go_neb_data_store_path: "{{ matrix_bot_go_neb_data_path }}/store" | ||||
| matrix_bot_go_neb_container_image: "{{ matrix_bot_go_neb_container_image_registry_prefix }}matrixdotorg/go-neb:{{ matrix_bot_go_neb_container_image_tag }}" | |||||
| matrix_bot_go_neb_container_image_tag: "{{ matrix_bot_go_neb_version }}" | |||||
| matrix_bot_go_neb_container_image_force_pull: "{{ matrix_bot_go_neb_container_image.endswith(':latest') }}" | |||||
| matrix_bot_go_neb_container_image_registry_prefix: docker.io/ | |||||
| # The base container network. It will be auto-created by this role if it doesn't exist already. | |||||
| matrix_bot_go_neb_container_network: matrix-bot-go-neb | |||||
| # 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_go_neb_container_additional_networks: [] | |||||
| # Controls whether the matrix-bot-go-neb container exposes its HTTP port (tcp/4050 in the container). | # Controls whether the matrix-bot-go-neb container exposes its HTTP port (tcp/4050 in the container). | ||||
| # | # | ||||
| # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:4050"), or empty string to not expose. | # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:4050"), or empty string to not expose. | ||||
| matrix_bot_go_neb_container_http_host_bind_port: '' | matrix_bot_go_neb_container_http_host_bind_port: '' | ||||
| # matrix_bot_go_neb_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_go_neb_container_labels_additional_labels`. | |||||
| matrix_bot_go_neb_container_labels_traefik_enabled: true | |||||
| matrix_bot_go_neb_container_labels_traefik_docker_network: "{{ matrix_bot_go_neb_container_network }}" | |||||
| matrix_bot_go_neb_container_labels_traefik_hostname: "{{ matrix_bot_go_neb_hostname }}" | |||||
| # The path prefix must either be `/` or not end with a slash (e.g. `/go-neb`). | |||||
| matrix_bot_go_neb_container_labels_traefik_path_prefix: "{{ matrix_bot_go_neb_path_prefix }}" | |||||
| matrix_bot_go_neb_container_labels_traefik_rule: "Host(`{{ matrix_bot_go_neb_container_labels_traefik_hostname }}`){% if matrix_bot_go_neb_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_bot_go_neb_container_labels_traefik_path_prefix }}`){% endif %}" | |||||
| matrix_bot_go_neb_container_labels_traefik_priority: 0 | |||||
| matrix_bot_go_neb_container_labels_traefik_entrypoints: web-secure | |||||
| matrix_bot_go_neb_container_labels_traefik_tls: "{{ matrix_bot_go_neb_container_labels_traefik_entrypoints != 'web' }}" | |||||
| matrix_bot_go_neb_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_go_neb_container_labels_traefik_additional_response_headers_custom` | |||||
| matrix_bot_go_neb_container_labels_traefik_additional_response_headers: "{{ matrix_bot_go_neb_container_labels_traefik_additional_response_headers_auto | combine(matrix_bot_go_neb_container_labels_traefik_additional_response_headers_custom) }}" | |||||
| matrix_bot_go_neb_container_labels_traefik_additional_response_headers_auto: | | |||||
| {{ | |||||
| {} | |||||
| | combine ({'X-XSS-Protection': matrix_bot_go_neb_http_header_xss_protection} if matrix_bot_go_neb_http_header_xss_protection else {}) | |||||
| | combine ({'X-Frame-Options': matrix_bot_go_neb_http_header_frame_options} if matrix_bot_go_neb_http_header_frame_options else {}) | |||||
| | combine ({'X-Content-Type-Options': matrix_bot_go_neb_http_header_content_type_options} if matrix_bot_go_neb_http_header_content_type_options else {}) | |||||
| | combine ({'Content-Security-Policy': matrix_bot_go_neb_http_header_content_security_policy} if matrix_bot_go_neb_http_header_content_security_policy else {}) | |||||
| | combine ({'Permission-Policy': matrix_bot_go_neb_http_header_content_permission_policy} if matrix_bot_go_neb_http_header_content_permission_policy else {}) | |||||
| | combine ({'Strict-Transport-Security': matrix_bot_go_neb_http_header_strict_transport_security} if matrix_bot_go_neb_http_header_strict_transport_security and matrix_bot_go_neb_container_labels_traefik_tls else {}) | |||||
| }} | |||||
| matrix_bot_go_neb_container_labels_traefik_additional_response_headers_custom: {} | |||||
| # matrix_bot_go_neb_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_go_neb_container_labels_additional_labels: | | |||||
| # my.label=1 | |||||
| # another.label="here" | |||||
| matrix_bot_go_neb_container_labels_additional_labels: '' | |||||
| # A list of extra arguments to pass to the container | # A list of extra arguments to pass to the container | ||||
| matrix_bot_go_neb_container_extra_arguments: [] | matrix_bot_go_neb_container_extra_arguments: [] | ||||
| @@ -27,6 +90,57 @@ matrix_bot_go_neb_systemd_required_services_list: ['docker.service'] | |||||
| # List of systemd services that matrix-bot-go-neb.service wants | # List of systemd services that matrix-bot-go-neb.service wants | ||||
| matrix_bot_go_neb_systemd_wanted_services_list: [] | matrix_bot_go_neb_systemd_wanted_services_list: [] | ||||
| # Specifies the value of the `X-XSS-Protection` header | |||||
| # Stops pages from loading when they detect reflected cross-site scripting (XSS) attacks. | |||||
| # | |||||
| # Learn more about it is here: | |||||
| # - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection | |||||
| # - https://portswigger.net/web-security/cross-site-scripting/reflected | |||||
| matrix_bot_go_neb_http_header_xss_protection: "1; mode=block" | |||||
| # Specifies the value of the `X-Frame-Options` header which controls whether framing can happen. | |||||
| # See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options | |||||
| matrix_bot_go_neb_http_header_frame_options: SAMEORIGIN | |||||
| # Specifies the value of the `X-Content-Type-Options` header. | |||||
| # See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options | |||||
| matrix_bot_go_neb_http_header_content_type_options: nosniff | |||||
| # Specifies the value of the `Content-Security-Policy` header. | |||||
| # See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy | |||||
| matrix_bot_go_neb_http_header_content_security_policy: frame-ancestors 'self' | |||||
| # Specifies the value of the `Permission-Policy` header. | |||||
| # See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permission-Policy | |||||
| matrix_bot_go_neb_http_header_content_permission_policy: "{{ 'interest-cohort=()' if matrix_bot_go_neb_floc_optout_enabled else '' }}" | |||||
| # Specifies the value of the `Strict-Transport-Security` header. | |||||
| # See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security | |||||
| matrix_bot_go_neb_http_header_strict_transport_security: "max-age=31536000; includeSubDomains{{ '; preload' if matrix_bot_go_neb_hsts_preload_enabled else '' }}" | |||||
| # Controls whether to send a "Permissions-Policy interest-cohort=();" header along with all responses | |||||
| # | |||||
| # Learn more about what it is here: | |||||
| # - https://www.eff.org/deeplinks/2021/03/googles-floc-terrible-idea | |||||
| # - https://paramdeo.com/blog/opting-your-website-out-of-googles-floc-network | |||||
| # - https://amifloced.org/ | |||||
| # | |||||
| # Of course, a better solution is to just stop using browsers (like Chrome), which participate in such tracking practices. | |||||
| # See: `matrix_bot_go_neb_content_permission_policy` | |||||
| matrix_bot_go_neb_floc_optout_enabled: true | |||||
| # Controls if HSTS preloading is enabled | |||||
| # | |||||
| # In its strongest and recommended form, the [HSTS policy](https://www.chromium.org/hsts) includes all subdomains, and | |||||
| # indicates a willingness to be "preloaded" into browsers: | |||||
| # `Strict-Transport-Security: max-age=31536000; includeSubDomains; preload` | |||||
| # For more information visit: | |||||
| # - https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security | |||||
| # - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security | |||||
| # - https://hstspreload.org/#opt-in | |||||
| # See: `matrix_bot_go_neb_http_header_strict_transport_security` | |||||
| matrix_bot_go_neb_hsts_preload_enabled: false | |||||
| # Database-related configuration fields. | # Database-related configuration fields. | ||||
| # | # | ||||
| # MUST be "sqlite3". No other type is supported. | # MUST be "sqlite3". No other type is supported. | ||||
| @@ -1,8 +1,5 @@ | |||||
| --- | --- | ||||
| - ansible.builtin.set_fact: | |||||
| matrix_bot_go_neb_requires_restart: false | |||||
| - name: Ensure go-neb paths exist | - name: Ensure go-neb paths exist | ||||
| ansible.builtin.file: | ansible.builtin.file: | ||||
| path: "{{ item.path }}" | path: "{{ item.path }}" | ||||
| @@ -16,17 +13,6 @@ | |||||
| - {path: "{{ matrix_bot_go_neb_data_store_path }}", when: true} | - {path: "{{ matrix_bot_go_neb_data_store_path }}", when: true} | ||||
| when: "item.when | bool" | when: "item.when | bool" | ||||
| - name: Ensure go-neb image is pulled | |||||
| community.docker.docker_image: | |||||
| name: "{{ matrix_bot_go_neb_docker_image }}" | |||||
| source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | |||||
| force_source: "{{ matrix_bot_go_neb_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" | |||||
| force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_bot_go_neb_docker_image_force_pull }}" | |||||
| register: result | |||||
| retries: "{{ devture_playbook_help_container_retries_count }}" | |||||
| delay: "{{ devture_playbook_help_container_retries_delay }}" | |||||
| until: result is not failed | |||||
| - name: Ensure go-neb config installed | - name: Ensure go-neb config installed | ||||
| ansible.builtin.copy: | ansible.builtin.copy: | ||||
| content: "{{ matrix_bot_go_neb_configuration | to_nice_yaml(indent=2, width=999999) }}" | content: "{{ matrix_bot_go_neb_configuration | to_nice_yaml(indent=2, width=999999) }}" | ||||
| @@ -35,16 +21,35 @@ | |||||
| owner: "{{ matrix_user_username }}" | owner: "{{ matrix_user_username }}" | ||||
| group: "{{ matrix_user_groupname }}" | group: "{{ matrix_user_groupname }}" | ||||
| - name: Ensure go-neb support files installed | |||||
| ansible.builtin.template: | |||||
| src: "{{ role_path }}/templates/{{ item }}.j2" | |||||
| dest: "{{ matrix_bot_go_neb_base_path }}/{{ item }}" | |||||
| mode: 0640 | |||||
| owner: "{{ matrix_user_username }}" | |||||
| group: "{{ matrix_user_groupname }}" | |||||
| with_items: | |||||
| - env | |||||
| - labels | |||||
| - name: Ensure go-neb container network is created | |||||
| community.general.docker_network: | |||||
| name: "{{ matrix_bot_go_neb_container_network }}" | |||||
| driver: bridge | |||||
| - name: Ensure go-neb container image is pulled | |||||
| community.docker.docker_image: | |||||
| name: "{{ matrix_bot_go_neb_container_image }}" | |||||
| source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | |||||
| force_source: "{{ matrix_bot_go_neb_container_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" | |||||
| force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_bot_go_neb_container_image_force_pull }}" | |||||
| register: result | |||||
| retries: "{{ devture_playbook_help_container_retries_count }}" | |||||
| delay: "{{ devture_playbook_help_container_retries_delay }}" | |||||
| until: result is not failed | |||||
| - name: Ensure matrix-bot-go-neb.service installed | - name: Ensure matrix-bot-go-neb.service installed | ||||
| ansible.builtin.template: | ansible.builtin.template: | ||||
| src: "{{ role_path }}/templates/systemd/matrix-bot-go-neb.service.j2" | src: "{{ role_path }}/templates/systemd/matrix-bot-go-neb.service.j2" | ||||
| dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-go-neb.service" | dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-go-neb.service" | ||||
| mode: 0644 | mode: 0644 | ||||
| register: matrix_bot_go_neb_systemd_service_result | |||||
| - name: Ensure matrix-bot-go-neb.service restarted, if necessary | |||||
| ansible.builtin.service: | |||||
| name: "matrix-bot-go-neb.service" | |||||
| state: restarted | |||||
| daemon_reload: true | |||||
| when: "matrix_bot_go_neb_requires_restart | bool" | |||||
| @@ -4,7 +4,7 @@ | |||||
| - ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml" | - ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml" | ||||
| when: "run_setup | bool and matrix_bot_go_neb_enabled | bool" | when: "run_setup | bool and matrix_bot_go_neb_enabled | bool" | ||||
| - ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml" | |||||
| - ansible.builtin.include_tasks: "{{ role_path }}/tasks/install.yml" | |||||
| when: "run_setup | bool and matrix_bot_go_neb_enabled | bool" | when: "run_setup | bool and matrix_bot_go_neb_enabled | bool" | ||||
| tags: | tags: | ||||
| - setup-all | - setup-all | ||||
| @@ -13,7 +13,7 @@ | |||||
| - install-bot-go-neb | - install-bot-go-neb | ||||
| - block: | - block: | ||||
| - ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml" | |||||
| - ansible.builtin.include_tasks: "{{ role_path }}/tasks/uninstall.yml" | |||||
| when: "run_setup | bool and not matrix_bot_go_neb_enabled | bool" | when: "run_setup | bool and not matrix_bot_go_neb_enabled | bool" | ||||
| tags: | tags: | ||||
| - setup-all | - setup-all | ||||
| @@ -0,0 +1,8 @@ | |||||
| BIND_ADDRESS=:4050 | |||||
| DATABASE_TYPE={{ matrix_bot_go_neb_database_engine }} | |||||
| DATABASE_URL={{ matrix_bot_go_neb_storage_database }} | |||||
| BASE_URL={{ matrix_bot_go_neb_base_url }} | |||||
| CONFIG_FILE={{ matrix_bot_go_neb_config_path_in_container }} | |||||
| @@ -0,0 +1,45 @@ | |||||
| {% if matrix_bot_go_neb_container_labels_traefik_enabled %} | |||||
| traefik.enable=true | |||||
| {% if matrix_bot_go_neb_container_labels_traefik_docker_network %} | |||||
| traefik.docker.network={{ matrix_bot_go_neb_container_labels_traefik_docker_network }} | |||||
| {% endif %} | |||||
| {% set middlewares = [] %} | |||||
| {% if matrix_bot_go_neb_container_labels_traefik_path_prefix != '/' %} | |||||
| traefik.http.middlewares.{{ matrix_bot_go_neb_identifier }}-slashless-redirect.redirectregex.regex=({{ matrix_bot_go_neb_container_labels_traefik_path_prefix | quote }})$ | |||||
| traefik.http.middlewares.{{ matrix_bot_go_neb_identifier }}-slashless-redirect.redirectregex.replacement=${1}/ | |||||
| {% set middlewares = middlewares + [matrix_bot_go_neb_identifier + '-slashless-redirect'] %} | |||||
| {% endif %} | |||||
| {% if matrix_bot_go_neb_container_labels_traefik_path_prefix != '/' %} | |||||
| traefik.http.middlewares.{{ matrix_bot_go_neb_identifier }}-strip-prefix.stripprefix.prefixes={{ matrix_bot_go_neb_container_labels_traefik_path_prefix }} | |||||
| {% set middlewares = middlewares + [matrix_bot_go_neb_identifier + '-strip-prefix'] %} | |||||
| {% endif %} | |||||
| {% if matrix_bot_go_neb_container_labels_traefik_additional_response_headers.keys() | length > 0 %} | |||||
| {% for name, value in matrix_bot_go_neb_container_labels_traefik_additional_response_headers.items() %} | |||||
| traefik.http.middlewares.{{ matrix_bot_go_neb_identifier }}-add-headers.headers.customresponseheaders.{{ name }}={{ value }} | |||||
| {% endfor %} | |||||
| {% set middlewares = middlewares + [matrix_bot_go_neb_identifier + '-add-headers'] %} | |||||
| {% endif %} | |||||
| traefik.http.routers.{{ matrix_bot_go_neb_identifier }}.rule={{ matrix_bot_go_neb_container_labels_traefik_rule }} | |||||
| {% if matrix_bot_go_neb_container_labels_traefik_priority | int > 0 %} | |||||
| traefik.http.routers.{{ matrix_bot_go_neb_identifier }}.priority={{ matrix_bot_go_neb_container_labels_traefik_priority }} | |||||
| {% endif %} | |||||
| traefik.http.routers.{{ matrix_bot_go_neb_identifier }}.service={{ matrix_bot_go_neb_identifier }} | |||||
| {% if middlewares | length > 0 %} | |||||
| traefik.http.routers.{{ matrix_bot_go_neb_identifier }}.middlewares={{ middlewares | join(',') }} | |||||
| {% endif %} | |||||
| traefik.http.routers.{{ matrix_bot_go_neb_identifier }}.entrypoints={{ matrix_bot_go_neb_container_labels_traefik_entrypoints }} | |||||
| traefik.http.routers.{{ matrix_bot_go_neb_identifier }}.tls={{ matrix_bot_go_neb_container_labels_traefik_tls | to_json }} | |||||
| {% if matrix_bot_go_neb_container_labels_traefik_tls %} | |||||
| traefik.http.routers.{{ matrix_bot_go_neb_identifier }}.tls.certResolver={{ matrix_bot_go_neb_container_labels_traefik_tls_certResolver }} | |||||
| {% endif %} | |||||
| traefik.http.services.{{ matrix_bot_go_neb_identifier }}.loadbalancer.server.port=4050 | |||||
| {% endif %} | |||||
| {{ matrix_bot_go_neb_container_labels_additional_labels }} | |||||
| @@ -16,31 +16,37 @@ Environment="HOME={{ devture_systemd_docker_base_systemd_unit_home_path }}" | |||||
| ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} kill matrix-bot-go-neb 2>/dev/null || true' | ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} kill matrix-bot-go-neb 2>/dev/null || true' | ||||
| ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-bot-go-neb 2>/dev/null || true' | ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-bot-go-neb 2>/dev/null || true' | ||||
| ExecStart={{ devture_systemd_docker_base_host_command_docker }} run --rm --name matrix-bot-go-neb \ | |||||
| ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ | |||||
| --rm \ | |||||
| --name=matrix-bot-go-neb \ | |||||
| --log-driver=none \ | --log-driver=none \ | ||||
| --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ | --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ | ||||
| --cap-drop=ALL \ | --cap-drop=ALL \ | ||||
| --read-only \ | --read-only \ | ||||
| --network={{ matrix_docker_network }} \ | |||||
| --network={{ matrix_bot_go_neb_container_network }} \ | |||||
| {% if matrix_bot_go_neb_container_http_host_bind_port %} | {% if matrix_bot_go_neb_container_http_host_bind_port %} | ||||
| -p {{ matrix_bot_go_neb_container_http_host_bind_port }}:4050 \ | -p {{ matrix_bot_go_neb_container_http_host_bind_port }}:4050 \ | ||||
| {% endif %} | {% endif %} | ||||
| -e 'BIND_ADDRESS=:4050' \ | |||||
| -e 'DATABASE_TYPE={{ matrix_bot_go_neb_database_engine }}' \ | |||||
| -e 'BASE_URL=https://{{ matrix_server_fqn_bot_go_neb }}' \ | |||||
| -e 'CONFIG_FILE={{ matrix_bot_go_neb_config_path_in_container }}' \ | |||||
| -e 'DATABASE_URL={{ matrix_bot_go_neb_storage_database }}' \ | |||||
| --env-file={{ matrix_bot_go_neb_base_path }}/env \ | |||||
| --label-file={{ matrix_bot_go_neb_base_path }}/labels \ | |||||
| --mount type=bind,src={{ matrix_bot_go_neb_config_path }},dst=/config,ro \ | --mount type=bind,src={{ matrix_bot_go_neb_config_path }},dst=/config,ro \ | ||||
| --mount type=bind,src={{ matrix_bot_go_neb_data_path }},dst=/data \ | --mount type=bind,src={{ matrix_bot_go_neb_data_path }},dst=/data \ | ||||
| --entrypoint=/bin/sh \ | --entrypoint=/bin/sh \ | ||||
| {% for arg in matrix_bot_go_neb_container_extra_arguments %} | {% for arg in matrix_bot_go_neb_container_extra_arguments %} | ||||
| {{ arg }} \ | {{ arg }} \ | ||||
| {% endfor %} | {% endfor %} | ||||
| {{ matrix_bot_go_neb_docker_image }} \ | |||||
| {{ matrix_bot_go_neb_container_image }} \ | |||||
| -c "go-neb /config/config.yaml" | -c "go-neb /config/config.yaml" | ||||
| {% for network in matrix_bot_go_neb_container_additional_networks %} | |||||
| ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-bot-go-neb | |||||
| {% endfor %} | |||||
| ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-bot-go-neb | |||||
| ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} kill matrix-bot-go-neb 2>/dev/null || true' | ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} kill matrix-bot-go-neb 2>/dev/null || true' | ||||
| ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-bot-go-neb 2>/dev/null || true' | ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-bot-go-neb 2>/dev/null || true' | ||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-bot-go-neb | SyslogIdentifier=matrix-bot-go-neb | ||||
| @@ -63,11 +63,6 @@ matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_rule: "Host( | |||||
| matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoint: "{{ matrix_federation_traefik_entrypoint }}" | matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoint: "{{ matrix_federation_traefik_entrypoint }}" | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoints: "{{ matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoint }}" | matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoints: "{{ matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoint }}" | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_bot_go_neb_enabled: false | |||||
| matrix_nginx_proxy_container_labels_traefik_proxy_bot_go_neb_hostname: "{{ matrix_server_fqn_bot_go_neb }}" | |||||
| matrix_nginx_proxy_container_labels_traefik_proxy_bot_go_neb_tls: "{{ matrix_nginx_proxy_container_labels_traefik_entrypoints != 'web' }}" | |||||
| matrix_nginx_proxy_container_labels_traefik_proxy_bot_go_neb_rule: "Host(`{{ matrix_nginx_proxy_container_labels_traefik_proxy_bot_go_neb_hostname }}`)" | |||||
| matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_enabled: false | matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_enabled: false | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_hostname: "{{ matrix_server_fqn_jitsi }}" | matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_hostname: "{{ matrix_server_fqn_jitsi }}" | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_tls: "{{ matrix_nginx_proxy_container_labels_traefik_entrypoints != 'web' }}" | matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_tls: "{{ matrix_nginx_proxy_container_labels_traefik_entrypoints != 'web' }}" | ||||
| @@ -39,18 +39,6 @@ traefik.http.routers.matrix-nginx-proxy-matrix-federation.entrypoints={{ matrix_ | |||||
| {% endif %} | {% endif %} | ||||
| {% if matrix_nginx_proxy_container_labels_traefik_proxy_bot_go_neb_enabled %} | |||||
| # Go NEB bot | |||||
| traefik.http.routers.matrix-nginx-proxy-bot_go_neb.rule={{ matrix_nginx_proxy_container_labels_traefik_proxy_bot_go_neb_rule }} | |||||
| traefik.http.routers.matrix-nginx-proxy-bot_go_neb.service=matrix-nginx-proxy-web | |||||
| traefik.http.routers.matrix-nginx-proxy-bot_go_neb.tls={{ matrix_nginx_proxy_container_labels_traefik_proxy_bot_go_neb_tls | to_json }} | |||||
| {% if matrix_nginx_proxy_container_labels_traefik_proxy_bot_go_neb_tls %} | |||||
| traefik.http.routers.matrix-nginx-proxy-bot_go_neb.tls.certResolver={{ matrix_nginx_proxy_container_labels_traefik_tls_certResolver }} | |||||
| {% endif %} | |||||
| traefik.http.routers.matrix-nginx-proxy-bot_go_neb.entrypoints={{ matrix_nginx_proxy_container_labels_traefik_entrypoints }} | |||||
| {% endif %} | |||||
| {% if matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_enabled %} | {% if matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_enabled %} | ||||
| # Jitsi | # Jitsi | ||||
| traefik.http.routers.matrix-nginx-proxy-jitsi.rule={{ matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_rule }} | traefik.http.routers.matrix-nginx-proxy-jitsi.rule={{ matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_rule }} | ||||