sakkiii
4 years ago
commit
25e67b51d1
@ -0,0 +1,36 @@
|
|||||||
|
# Setting up Heisenbridge (optional)
|
||||||
|
|
||||||
|
**Note**: bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) can also happen via the [matrix-appservice-irc](configuring-playbook-bridge-appservice-irc.md) bridge supported by the playbook.
|
||||||
|
|
||||||
|
The playbook can install and configure [Heisenbridge](https://github.com/hifi/heisenbridge) - the bouncer-style [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) bridge for you.
|
||||||
|
|
||||||
|
See the project's [README](https://github.com/hifi/heisenbridge/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Below are the common configuration options that you may want to set, exhaustive list is in [the bridge's defaults var file](../roles/matrix-bridge-heisenbridge/defaults/main.yml).
|
||||||
|
|
||||||
|
At a minimum, you only need to enable the bridge to get it up and running (`inventory/host_vars/matrix.DOMAIN/vars.yml`):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
matrix_heisenbridge_enabled: true
|
||||||
|
|
||||||
|
# set owner (optional)
|
||||||
|
matrix_heisenbridge_owner: "@you:your-homeserver"
|
||||||
|
|
||||||
|
# to enable identd on host port 113/TCP (optional)
|
||||||
|
matrix_heisenbridge_identd_enabled: true
|
||||||
|
```
|
||||||
|
|
||||||
|
That's it! A registration file is automatically generated during the setup phase.
|
||||||
|
|
||||||
|
Setting the owner is optional as the first local user to DM `@heisenbridge:your-homeserver` will be made the owner.
|
||||||
|
If you are not using a local user you must set it as otherwise you can't DM it at all.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
After the bridge is successfully running just DM `@heisenbridge:your-homeserver` to start setting it up.
|
||||||
|
Help is available for all commands with the `-h` switch.
|
||||||
|
If the bridge ignores you and a DM is not accepted then the owner setting may be wrong.
|
||||||
|
|
||||||
|
If you encounter issues or feel lost you can join the project room at [#heisenbridge:vi.fi](https://matrix.to/#/#heisenbridge:vi.fi) for help.
|
||||||
@ -0,0 +1,21 @@
|
|||||||
|
# Configuring Hydrogen (optional)
|
||||||
|
|
||||||
|
This playbook can install the [Hydrogen](https://github.com/vector-im/hydrogen-web) Matrix web client for you.
|
||||||
|
Hydrogen is a lightweight web client that supports mobile and legacy web browsers.
|
||||||
|
Hydrogen can be installed alongside or instead of Element.
|
||||||
|
|
||||||
|
If you'd like Hydrogen to be installed, add the following to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
matrix_client_hydrogen_enabled: true
|
||||||
|
```
|
||||||
|
|
||||||
|
You will also need to add a DNS record so that Hydrogen can be accessed.
|
||||||
|
By default Hydrogen will use https://hydrogen.DOMAIN so you will need to create an CNAME record
|
||||||
|
for `hydrogen`. See [Configuring DNS](configuring-dns.md).
|
||||||
|
|
||||||
|
If you would like to use a different domain, add the following to your configuration file (changing it to use your preferred domain):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
matrix_server_fqn_hydrogen: "helium.{{ matrix_domain }}"
|
||||||
|
```
|
||||||
@ -0,0 +1,47 @@
|
|||||||
|
# heisenbridge is a bouncer-style Matrix IRC bridge
|
||||||
|
# See: https://github.com/hifi/heisenbridge
|
||||||
|
|
||||||
|
matrix_heisenbridge_enabled: true
|
||||||
|
|
||||||
|
matrix_heisenbridge_version: latest
|
||||||
|
matrix_heisenbridge_docker_image: "{{ matrix_container_global_registry_prefix }}hif1/heisenbridge:{{ matrix_heisenbridge_version }}"
|
||||||
|
matrix_heisenbridge_docker_image_force_pull: "{{ matrix_heisenbridge_docker_image.endswith(':latest') }}"
|
||||||
|
|
||||||
|
# Set this to your Matrix ID if you want to enforce the owner, otherwise first _local_ user becomes one
|
||||||
|
matrix_heisenbridge_owner: ""
|
||||||
|
|
||||||
|
# Enabling identd will bind to host port 113/TCP
|
||||||
|
matrix_heisenbridge_identd_enabled: false
|
||||||
|
|
||||||
|
matrix_heisenbridge_base_path: "{{ matrix_base_data_path }}/heisenbridge"
|
||||||
|
|
||||||
|
# A list of extra arguments to pass to the container
|
||||||
|
matrix_heisenbridge_container_extra_arguments: []
|
||||||
|
|
||||||
|
# List of systemd services that service depends on.
|
||||||
|
matrix_heisenbridge_systemd_required_services_list: ['docker.service']
|
||||||
|
|
||||||
|
# List of systemd services that service wants
|
||||||
|
matrix_heisenbridge_systemd_wanted_services_list: []
|
||||||
|
|
||||||
|
matrix_heisenbridge_homeserver_url: "{{ matrix_homeserver_container_url }}"
|
||||||
|
|
||||||
|
matrix_heisenbridge_appservice_token: ''
|
||||||
|
matrix_heisenbridge_homeserver_token: ''
|
||||||
|
|
||||||
|
# Default registration file
|
||||||
|
matrix_heisenbridge_registration_yaml:
|
||||||
|
id: heisenbridge
|
||||||
|
url: http://matrix-heisenbridge:9898
|
||||||
|
as_token: "{{ matrix_heisenbridge_appservice_token }}"
|
||||||
|
hs_token: "{{ matrix_heisenbridge_homeserver_token }}"
|
||||||
|
rate_limited: false
|
||||||
|
sender_localpart: heisenbridge
|
||||||
|
namespaces:
|
||||||
|
users:
|
||||||
|
- regex: '@hbirc_.*'
|
||||||
|
exclusive: true
|
||||||
|
aliases: []
|
||||||
|
rooms: []
|
||||||
|
|
||||||
|
matrix_heisenbridge_registration: "{{ matrix_heisenbridge_registration_yaml|from_yaml }}"
|
||||||
@ -0,0 +1,24 @@
|
|||||||
|
# If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist.
|
||||||
|
# We don't want to fail in such cases.
|
||||||
|
- name: Fail if matrix-synapse role already executed
|
||||||
|
fail:
|
||||||
|
msg: >-
|
||||||
|
The matrix-bridge-heisenbridge role needs to execute before the matrix-synapse role.
|
||||||
|
when: "matrix_heisenbridge_enabled and matrix_synapse_role_executed|default(False)"
|
||||||
|
|
||||||
|
- set_fact:
|
||||||
|
matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-heisenbridge.service'] }}"
|
||||||
|
when: matrix_heisenbridge_enabled|bool
|
||||||
|
|
||||||
|
# If the matrix-synapse role is not used, these variables may not exist.
|
||||||
|
- set_fact:
|
||||||
|
matrix_synapse_container_extra_arguments: >
|
||||||
|
{{ matrix_synapse_container_extra_arguments|default([]) }}
|
||||||
|
+
|
||||||
|
["--mount type=bind,src={{ matrix_heisenbridge_base_path }}/registration.yaml,dst=/heisenbridge-registration.yaml,ro"]
|
||||||
|
|
||||||
|
matrix_synapse_app_service_config_files: >
|
||||||
|
{{ matrix_synapse_app_service_config_files|default([]) }}
|
||||||
|
+
|
||||||
|
{{ ["/heisenbridge-registration.yaml"] }}
|
||||||
|
when: matrix_heisenbridge_enabled|bool
|
||||||
@ -0,0 +1,15 @@
|
|||||||
|
- import_tasks: "{{ role_path }}/tasks/init.yml"
|
||||||
|
tags:
|
||||||
|
- always
|
||||||
|
|
||||||
|
- import_tasks: "{{ role_path }}/tasks/setup_install.yml"
|
||||||
|
when: "run_setup|bool and matrix_heisenbridge_enabled|bool"
|
||||||
|
tags:
|
||||||
|
- setup-all
|
||||||
|
- setup-heisenbridge
|
||||||
|
|
||||||
|
- import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
|
||||||
|
when: "run_setup|bool and not matrix_heisenbridge_enabled|bool"
|
||||||
|
tags:
|
||||||
|
- setup-all
|
||||||
|
- setup-heisenbridge
|
||||||
@ -0,0 +1,38 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
- name: Ensure heisenbridge image is pulled
|
||||||
|
docker_image:
|
||||||
|
name: "{{ matrix_heisenbridge_docker_image }}"
|
||||||
|
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
|
||||||
|
force_source: "{{ matrix_heisenbridge_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_heisenbridge_docker_image_force_pull }}"
|
||||||
|
|
||||||
|
- name: Ensure heisenbridge paths exist
|
||||||
|
file:
|
||||||
|
path: "{{ item }}"
|
||||||
|
state: directory
|
||||||
|
mode: 0750
|
||||||
|
owner: "{{ matrix_user_username }}"
|
||||||
|
group: "{{ matrix_user_groupname }}"
|
||||||
|
with_items:
|
||||||
|
- "{{ matrix_heisenbridge_base_path }}"
|
||||||
|
|
||||||
|
- name: Ensure heisenbridge registration.yaml installed if provided
|
||||||
|
copy:
|
||||||
|
content: "{{ matrix_heisenbridge_registration|to_nice_yaml }}"
|
||||||
|
dest: "{{ matrix_heisenbridge_base_path }}/registration.yaml"
|
||||||
|
mode: 0644
|
||||||
|
owner: "{{ matrix_user_username }}"
|
||||||
|
group: "{{ matrix_user_groupname }}"
|
||||||
|
|
||||||
|
- name: Ensure matrix-heisenbridge.service installed
|
||||||
|
template:
|
||||||
|
src: "{{ role_path }}/templates/systemd/matrix-heisenbridge.service.j2"
|
||||||
|
dest: "{{ matrix_systemd_path }}/matrix-heisenbridge.service"
|
||||||
|
mode: 0644
|
||||||
|
register: matrix_heisenbridge_systemd_service_result
|
||||||
|
|
||||||
|
- name: Ensure systemd reloaded after matrix-heisenbridge.service installation
|
||||||
|
service:
|
||||||
|
daemon_reload: yes
|
||||||
|
when: matrix_heisenbridge_systemd_service_result.changed
|
||||||
@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
- name: Check existence of matrix-heisenbridge service
|
||||||
|
stat:
|
||||||
|
path: "{{ matrix_systemd_path }}/matrix-heisenbridge.service"
|
||||||
|
register: matrix_heisenbridge_service_stat
|
||||||
|
|
||||||
|
- name: Ensure matrix-heisenbridge is stopped
|
||||||
|
service:
|
||||||
|
name: heisenbridge
|
||||||
|
state: stopped
|
||||||
|
daemon_reload: yes
|
||||||
|
when: "matrix_heisenbridge_service_stat.stat.exists"
|
||||||
|
|
||||||
|
- name: Ensure matrix-heisenbridge.service doesn't exist
|
||||||
|
file:
|
||||||
|
path: "{{ matrix_systemd_path }}/matrix-heisenbridge.service"
|
||||||
|
state: absent
|
||||||
|
when: "matrix_heisenbridge_service_stat.stat.exists"
|
||||||
|
|
||||||
|
- name: Ensure systemd reloaded after matrix-heisenbridge.service removal
|
||||||
|
service:
|
||||||
|
daemon_reload: yes
|
||||||
|
when: "matrix_heisenbridge_service_stat.stat.exists"
|
||||||
@ -0,0 +1,50 @@
|
|||||||
|
#jinja2: lstrip_blocks: "True"
|
||||||
|
[Unit]
|
||||||
|
Description=a bouncer-style Matrix IRC bridge
|
||||||
|
{% for service in matrix_heisenbridge_systemd_required_services_list %}
|
||||||
|
Requires={{ service }}
|
||||||
|
After={{ service }}
|
||||||
|
{% endfor %}
|
||||||
|
{% for service in matrix_heisenbridge_systemd_wanted_services_list %}
|
||||||
|
Wants={{ service }}
|
||||||
|
{% endfor %}
|
||||||
|
DefaultDependencies=no
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
Environment="HOME={{ matrix_systemd_unit_home_path }}"
|
||||||
|
ExecStartPre=-{{ matrix_host_command_docker }} kill matrix-heisenbridge
|
||||||
|
ExecStartPre=-{{ matrix_host_command_docker }} rm matrix-heisenbridge
|
||||||
|
|
||||||
|
ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-heisenbridge \
|
||||||
|
--log-driver=none \
|
||||||
|
--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
|
||||||
|
--cap-drop=ALL \
|
||||||
|
--network={{ matrix_docker_network }} \
|
||||||
|
{% if matrix_heisenbridge_identd_enabled %}
|
||||||
|
-p 113:113 \
|
||||||
|
{% endif %}
|
||||||
|
-v {{ matrix_heisenbridge_base_path }}:/config:z \
|
||||||
|
{% for arg in matrix_heisenbridge_container_extra_arguments %}
|
||||||
|
{{ arg }} \
|
||||||
|
{% endfor %}
|
||||||
|
{{ matrix_heisenbridge_docker_image }} \
|
||||||
|
{% if matrix_heisenbridge_identd_enabled %}
|
||||||
|
--identd \
|
||||||
|
{% endif %}
|
||||||
|
{% if matrix_heisenbridge_owner %}
|
||||||
|
-o {{ matrix_heisenbridge_owner }} \
|
||||||
|
{% endif %}
|
||||||
|
--config /config/registration.yaml \
|
||||||
|
--listen-address 0.0.0.0 \
|
||||||
|
--listen-port 9898 \
|
||||||
|
{{ matrix_heisenbridge_homeserver_url }}
|
||||||
|
|
||||||
|
ExecStop=-{{ matrix_host_command_docker }} kill matrix-heisenbridge
|
||||||
|
ExecStop=-{{ matrix_host_command_docker }} rm matrix-heisenbridge
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
SyslogIdentifier=matrix-heisenbridge
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@ -0,0 +1,68 @@
|
|||||||
|
matrix_client_hydrogen_enabled: true
|
||||||
|
|
||||||
|
# Self building is used by default because the `config.json` file is only read at build time.
|
||||||
|
# The pre-built images also were not functional as of 2021-05-15.
|
||||||
|
matrix_client_hydrogen_container_image_self_build: true
|
||||||
|
matrix_client_hydrogen_container_image_self_build_repo: "https://github.com/vector-im/hydrogen-web.git"
|
||||||
|
|
||||||
|
matrix_client_hydrogen_version: v0.1.53
|
||||||
|
matrix_client_hydrogen_docker_image: "{{ matrix_client_hydrogen_docker_image_name_prefix }}vectorim/hydrogen-web:{{ matrix_client_hydrogen_version }}"
|
||||||
|
matrix_client_hydrogen_docker_image_name_prefix: "{{ 'localhost/' if matrix_client_hydrogen_container_image_self_build }}"
|
||||||
|
matrix_client_hydrogen_docker_image_force_pull: "{{ matrix_client_hydrogen_docker_image.endswith(':latest') }}"
|
||||||
|
|
||||||
|
matrix_client_hydrogen_data_path: "{{ matrix_base_data_path }}/client-hydrogen"
|
||||||
|
matrix_client_hydrogen_docker_src_files_path: "{{ matrix_client_hydrogen_data_path }}/docker-src"
|
||||||
|
|
||||||
|
# Controls whether the container exposes its HTTP port (tcp/8080 in the container).
|
||||||
|
#
|
||||||
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8768"), or empty string to not expose.
|
||||||
|
matrix_client_hydrogen_container_http_host_bind_port: ''
|
||||||
|
|
||||||
|
# A list of extra arguments to pass to the container
|
||||||
|
matrix_client_hydrogen_container_extra_arguments: []
|
||||||
|
|
||||||
|
# List of systemd services that matrix-client-hydrogen.service depends on
|
||||||
|
matrix_client_hydrogen_systemd_required_services_list: ['docker.service']
|
||||||
|
|
||||||
|
# Controls whether the self-check feature should validate SSL certificates.
|
||||||
|
matrix_client_hydrogen_self_check_validate_certificates: true
|
||||||
|
|
||||||
|
# config.json
|
||||||
|
matrix_client_hydrogen_default_hs_url: ""
|
||||||
|
|
||||||
|
# Default Hydrogen configuration template which covers the generic use case.
|
||||||
|
# You can customize it by controlling the various variables inside it.
|
||||||
|
#
|
||||||
|
# For a more advanced customization, you can extend the default (see `matrix_client_hydrogen_configuration_extension_json`)
|
||||||
|
# or completely replace this variable with your own template.
|
||||||
|
#
|
||||||
|
# The side-effect of this lookup is that Ansible would even parse the JSON for us, returning a dict.
|
||||||
|
# This is unlike what it does when looking up YAML template files (no automatic parsing there).
|
||||||
|
matrix_client_hydrogen_configuration_default: "{{ lookup('template', 'templates/config.json.j2') }}"
|
||||||
|
|
||||||
|
# Your custom JSON configuration for Hydrogen should go to `matrix_client_hydrogen_configuration_extension_json`.
|
||||||
|
# This configuration extends the default starting configuration (`matrix_client_hydrogen_configuration_default`).
|
||||||
|
#
|
||||||
|
# You can override individual variables from the default configuration, or introduce new ones.
|
||||||
|
#
|
||||||
|
# If you need something more special, you can take full control by
|
||||||
|
# completely redefining `matrix_client_hydrogen_configuration_default`.
|
||||||
|
#
|
||||||
|
# Example configuration extension follows:
|
||||||
|
#
|
||||||
|
# matrix_client_hydrogen_configuration_extension_json: |
|
||||||
|
# {
|
||||||
|
# "push": {
|
||||||
|
# "appId": "io.element.hydrogen.web",
|
||||||
|
# "gatewayUrl": "https://matrix.org",
|
||||||
|
# "applicationServerKey": "BC-gpSdVHEXhvHSHS0AzzWrQoukv2BE7KzpoPO_FfPacqOo3l1pdqz7rSgmB04pZCWaHPz7XRe6fjLaC-WPDopM"
|
||||||
|
# },
|
||||||
|
# "defaultHomeServer": "matrix.org"
|
||||||
|
# }
|
||||||
|
matrix_client_hydrogen_configuration_extension_json: '{}'
|
||||||
|
|
||||||
|
matrix_client_hydrogen_configuration_extension: "{{ matrix_client_hydrogen_configuration_extension_json|from_json if matrix_client_hydrogen_configuration_extension_json|from_json is mapping else {} }}"
|
||||||
|
|
||||||
|
# Holds the final Hydrogen configuration (a combination of the default and its extension).
|
||||||
|
# You most likely don't need to touch this variable. Instead, see `matrix_client_hydrogen_configuration_default`.
|
||||||
|
matrix_client_hydrogen_configuration: "{{ matrix_client_hydrogen_configuration_default|combine(matrix_client_hydrogen_configuration_extension, recursive=True) }}"
|
||||||
@ -0,0 +1,10 @@
|
|||||||
|
# See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1070
|
||||||
|
# and https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/1ab507349c752042d26def3e95884f6df8886b74#commitcomment-51108407
|
||||||
|
- name: Fail if trying to self-build on Ansible < 2.8
|
||||||
|
fail:
|
||||||
|
msg: "To self-build the Hydrogen image, you should use Ansible 2.8 or higher. See docs/ansible.md"
|
||||||
|
when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_client_hydrogen_container_image_self_build"
|
||||||
|
|
||||||
|
- set_fact:
|
||||||
|
matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-client-hydrogen.service'] }}"
|
||||||
|
when: matrix_client_hydrogen_enabled|bool
|
||||||
@ -0,0 +1,15 @@
|
|||||||
|
- import_tasks: "{{ role_path }}/tasks/init.yml"
|
||||||
|
tags:
|
||||||
|
- always
|
||||||
|
|
||||||
|
- import_tasks: "{{ role_path }}/tasks/validate_config.yml"
|
||||||
|
when: "run_setup|bool and matrix_client_hydrogen_enabled|bool"
|
||||||
|
tags:
|
||||||
|
- setup-all
|
||||||
|
- setup-client-hydrogen
|
||||||
|
|
||||||
|
- import_tasks: "{{ role_path }}/tasks/setup.yml"
|
||||||
|
when: run_setup|bool
|
||||||
|
tags:
|
||||||
|
- setup-all
|
||||||
|
- setup-client-hydrogen
|
||||||
@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
- set_fact:
|
||||||
|
matrix_client_hydrogen_url_endpoint_public: "https://{{ matrix_server_fqn_hydrogen }}"
|
||||||
|
|
||||||
|
- name: Check Hydrogen
|
||||||
|
uri:
|
||||||
|
url: "{{ matrix_client_hydrogen_url_endpoint_public }}"
|
||||||
|
follow_redirects: none
|
||||||
|
validate_certs: "{{ matrix_client_hydrogen_self_check_validate_certificates }}"
|
||||||
|
register: matrix_client_hydrogen_self_check_result
|
||||||
|
check_mode: no
|
||||||
|
ignore_errors: true
|
||||||
|
|
||||||
|
- name: Fail if Hydrogen not working
|
||||||
|
fail:
|
||||||
|
msg: "Failed checking Hydrogen is up at `{{ matrix_server_fqn_hydrogen }}` (checked endpoint: `{{ matrix_client_hydrogen_url_endpoint_public }}`). Is Hydrogen running? Is port 443 open in your firewall? Full error: {{ matrix_client_hydrogen_self_check_result }}"
|
||||||
|
when: "matrix_client_hydrogen_self_check_result.failed or 'json' not in matrix_client_hydrogen_self_check_result"
|
||||||
|
|
||||||
|
- name: Report working Hydrogen
|
||||||
|
debug:
|
||||||
|
msg: "Hydrogen at `{{ matrix_server_fqn_hydrogen }}` is working (checked endpoint: `{{ matrix_client_hydrogen_url_endpoint_public }}`)"
|
||||||
@ -0,0 +1,119 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
#
|
||||||
|
# Tasks related to setting up Hydrogen
|
||||||
|
#
|
||||||
|
|
||||||
|
- name: Ensure Hydrogen paths exists
|
||||||
|
file:
|
||||||
|
path: "{{ item.path }}"
|
||||||
|
state: directory
|
||||||
|
mode: 0750
|
||||||
|
owner: "{{ matrix_user_username }}"
|
||||||
|
group: "{{ matrix_user_groupname }}"
|
||||||
|
with_items:
|
||||||
|
- { path: "{{ matrix_client_hydrogen_data_path }}", when: true }
|
||||||
|
- { path: "{{ matrix_client_hydrogen_docker_src_files_path }}", when: "{{ matrix_client_hydrogen_container_image_self_build }}" }
|
||||||
|
when: matrix_client_hydrogen_enabled|bool and item.when
|
||||||
|
|
||||||
|
- name: Ensure Hydrogen Docker image is pulled
|
||||||
|
docker_image:
|
||||||
|
name: "{{ matrix_client_hydrogen_docker_image }}"
|
||||||
|
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
|
||||||
|
force_source: "{{ matrix_client_hydrogen_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_client_hydrogen_docker_image_force_pull }}"
|
||||||
|
when: matrix_client_hydrogen_enabled|bool and not matrix_client_hydrogen_container_image_self_build
|
||||||
|
|
||||||
|
- name: Ensure Hydrogen repository is present on self-build
|
||||||
|
git:
|
||||||
|
repo: "{{ matrix_client_hydrogen_container_image_self_build_repo }}"
|
||||||
|
dest: "{{ matrix_client_hydrogen_docker_src_files_path }}"
|
||||||
|
version: "{{ matrix_client_hydrogen_docker_image.split(':')[1] }}"
|
||||||
|
force: "yes"
|
||||||
|
register: matrix_client_hydrogen_git_pull_results
|
||||||
|
when: "matrix_client_hydrogen_enabled|bool and matrix_client_hydrogen_container_image_self_build|bool"
|
||||||
|
|
||||||
|
- name: Ensure Hydrogen configuration installed
|
||||||
|
copy:
|
||||||
|
content: "{{ matrix_client_hydrogen_configuration|to_nice_json }}"
|
||||||
|
dest: "{{ matrix_client_hydrogen_docker_src_files_path }}/assets/config.json"
|
||||||
|
mode: 0644
|
||||||
|
owner: "{{ matrix_user_username }}"
|
||||||
|
group: "{{ matrix_user_groupname }}"
|
||||||
|
when: "matrix_client_hydrogen_enabled|bool and matrix_client_hydrogen_container_image_self_build|bool"
|
||||||
|
|
||||||
|
- name: Ensure Hydrogen additional config files installed
|
||||||
|
template:
|
||||||
|
src: "{{ item.src }}"
|
||||||
|
dest: "{{ matrix_client_hydrogen_data_path }}/{{ item.name }}"
|
||||||
|
mode: 0644
|
||||||
|
owner: "{{ matrix_user_username }}"
|
||||||
|
group: "{{ matrix_user_groupname }}"
|
||||||
|
with_items:
|
||||||
|
- {src: "{{ role_path }}/templates/nginx.conf.j2", name: "nginx.conf"}
|
||||||
|
when: "matrix_client_hydrogen_enabled|bool and item.src is not none"
|
||||||
|
|
||||||
|
- name: Ensure Hydrogen Docker image is built
|
||||||
|
docker_image:
|
||||||
|
name: "{{ matrix_client_hydrogen_docker_image }}"
|
||||||
|
source: build
|
||||||
|
force_source: "{{ matrix_client_hydrogen_git_pull_results.changed }}"
|
||||||
|
build:
|
||||||
|
dockerfile: Dockerfile
|
||||||
|
path: "{{ matrix_client_hydrogen_docker_src_files_path }}"
|
||||||
|
pull: yes
|
||||||
|
when: "matrix_client_hydrogen_enabled|bool and matrix_client_hydrogen_container_image_self_build|bool"
|
||||||
|
|
||||||
|
- name: Ensure matrix-client-hydrogen.service installed
|
||||||
|
template:
|
||||||
|
src: "{{ role_path }}/templates/systemd/matrix-client-hydrogen.service.j2"
|
||||||
|
dest: "{{ matrix_systemd_path }}/matrix-client-hydrogen.service"
|
||||||
|
mode: 0644
|
||||||
|
register: matrix_client_hydrogen_systemd_service_result
|
||||||
|
when: matrix_client_hydrogen_enabled|bool
|
||||||
|
|
||||||
|
- name: Ensure systemd reloaded after matrix-client-hydrogen.service installation
|
||||||
|
service:
|
||||||
|
daemon_reload: yes
|
||||||
|
when: "matrix_client_hydrogen_enabled and matrix_client_hydrogen_systemd_service_result.changed"
|
||||||
|
|
||||||
|
#
|
||||||
|
# Tasks related to getting rid of Hydrogen (if it was previously enabled)
|
||||||
|
#
|
||||||
|
|
||||||
|
- name: Check existence of matrix-client-hydrogen.service
|
||||||
|
stat:
|
||||||
|
path: "{{ matrix_systemd_path }}/matrix-client-hydrogen.service"
|
||||||
|
register: matrix_client_hydrogen_service_stat
|
||||||
|
when: "not matrix_client_hydrogen_enabled|bool"
|
||||||
|
|
||||||
|
- name: Ensure matrix-client-hydrogen is stopped
|
||||||
|
service:
|
||||||
|
name: matrix-client-hydrogen
|
||||||
|
state: stopped
|
||||||
|
daemon_reload: yes
|
||||||
|
register: stopping_result
|
||||||
|
when: "not matrix_client_hydrogen_enabled|bool and matrix_client_hydrogen_service_stat.stat.exists"
|
||||||
|
|
||||||
|
- name: Ensure matrix-client-hydrogen.service doesn't exist
|
||||||
|
file:
|
||||||
|
path: "{{ matrix_systemd_path }}/matrix-client-hydrogen.service"
|
||||||
|
state: absent
|
||||||
|
when: "not matrix_client_hydrogen_enabled|bool and matrix_client_hydrogen_service_stat.stat.exists"
|
||||||
|
|
||||||
|
- name: Ensure systemd reloaded after matrix-client-hydrogen.service removal
|
||||||
|
service:
|
||||||
|
daemon_reload: yes
|
||||||
|
when: "not matrix_client_hydrogen_enabled|bool and matrix_client_hydrogen_service_stat.stat.exists"
|
||||||
|
|
||||||
|
- name: Ensure Hydrogen paths doesn't exist
|
||||||
|
file:
|
||||||
|
path: "{{ matrix_client_hydrogen_data_path }}"
|
||||||
|
state: absent
|
||||||
|
when: "not matrix_client_hydrogen_enabled|bool"
|
||||||
|
|
||||||
|
- name: Ensure Hydrogen Docker image doesn't exist
|
||||||
|
docker_image:
|
||||||
|
name: "{{ matrix_client_hydrogen_docker_image }}"
|
||||||
|
state: absent
|
||||||
|
when: "not matrix_client_hydrogen_enabled|bool"
|
||||||
@ -0,0 +1,9 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
- name: Fail if required Hydrogen settings not defined
|
||||||
|
fail:
|
||||||
|
msg: >
|
||||||
|
You need to define a required configuration setting (`{{ item }}`) to use Hydrogen.
|
||||||
|
when: "(vars[item] == '' or vars[item] is none) and matrix_client_hydrogen_container_image_self_build|bool"
|
||||||
|
with_items:
|
||||||
|
- "matrix_client_hydrogen_default_hs_url"
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"defaultHomeServer": {{ matrix_client_hydrogen_default_hs_url|string|to_json }}
|
||||||
|
}
|
||||||
@ -0,0 +1,66 @@
|
|||||||
|
#jinja2: lstrip_blocks: "True"
|
||||||
|
# This is a custom nginx configuration file that we use in the container (instead of the default one),
|
||||||
|
# because it allows us to run nginx with a non-root user.
|
||||||
|
#
|
||||||
|
# For this to work, the default vhost file (`/etc/nginx/conf.d/default.conf`) also needs to be removed.
|
||||||
|
# (mounting `/dev/null` over `/etc/nginx/conf.d/default.conf` works well)
|
||||||
|
#
|
||||||
|
# The following changes have been done compared to a default nginx configuration file:
|
||||||
|
# - default server port is changed (80 -> 8080), so that a non-root user can bind it
|
||||||
|
# - various temp paths are changed to `/tmp`, so that a non-root user can write to them
|
||||||
|
# - the `user` directive was removed, as we don't want nginx to switch users
|
||||||
|
|
||||||
|
worker_processes 1;
|
||||||
|
|
||||||
|
error_log /var/log/nginx/error.log warn;
|
||||||
|
pid /tmp/nginx.pid;
|
||||||
|
|
||||||
|
|
||||||
|
events {
|
||||||
|
worker_connections 1024;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
http {
|
||||||
|
proxy_temp_path /tmp/proxy_temp;
|
||||||
|
client_body_temp_path /tmp/client_temp;
|
||||||
|
fastcgi_temp_path /tmp/fastcgi_temp;
|
||||||
|
uwsgi_temp_path /tmp/uwsgi_temp;
|
||||||
|
scgi_temp_path /tmp/scgi_temp;
|
||||||
|
|
||||||
|
include /etc/nginx/mime.types;
|
||||||
|
default_type application/octet-stream;
|
||||||
|
|
||||||
|
log_format main '$remote_addr - $remote_user [$time_local] "$request" '
|
||||||
|
'$status $body_bytes_sent "$http_referer" '
|
||||||
|
'"$http_user_agent" "$http_x_forwarded_for"';
|
||||||
|
|
||||||
|
access_log /var/log/nginx/access.log main;
|
||||||
|
|
||||||
|
sendfile on;
|
||||||
|
#tcp_nopush on;
|
||||||
|
|
||||||
|
keepalive_timeout 65;
|
||||||
|
|
||||||
|
#gzip on;
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen 8080;
|
||||||
|
server_name localhost;
|
||||||
|
|
||||||
|
root /usr/share/nginx/html;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
index index.html index.htm;
|
||||||
|
}
|
||||||
|
|
||||||
|
location ~* ^/(config(.+)?\.json$|(.+)\.html$|i18n) {
|
||||||
|
expires -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
error_page 500 502 503 504 /50x.html;
|
||||||
|
location = /50x.html {
|
||||||
|
root /usr/share/nginx/html;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,39 @@
|
|||||||
|
#jinja2: lstrip_blocks: "True"
|
||||||
|
[Unit]
|
||||||
|
Description=Matrix Hydrogen Client
|
||||||
|
{% for service in matrix_client_hydrogen_systemd_required_services_list %}
|
||||||
|
Requires={{ service }}
|
||||||
|
After={{ service }}
|
||||||
|
{% endfor %}
|
||||||
|
DefaultDependencies=no
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
Environment="HOME={{ matrix_systemd_unit_home_path }}"
|
||||||
|
ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-client-hydrogen 2>/dev/null'
|
||||||
|
ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-client-hydrogen 2>/dev/null'
|
||||||
|
|
||||||
|
ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-client-hydrogen \
|
||||||
|
--log-driver=none \
|
||||||
|
--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
|
||||||
|
--cap-drop=ALL \
|
||||||
|
--read-only \
|
||||||
|
--network={{ matrix_docker_network }} \
|
||||||
|
{% if matrix_client_hydrogen_container_http_host_bind_port %}
|
||||||
|
-p {{ matrix_client_hydrogen_container_http_host_bind_port }}:8080 \
|
||||||
|
{% endif %}
|
||||||
|
--tmpfs=/tmp:rw,noexec,nosuid,size=10m \
|
||||||
|
--mount type=bind,src={{ matrix_client_hydrogen_data_path }}/nginx.conf,dst=/etc/nginx/nginx.conf,ro \
|
||||||
|
{% for arg in matrix_client_hydrogen_container_extra_arguments %}
|
||||||
|
{{ arg }} \
|
||||||
|
{% endfor %}
|
||||||
|
{{ matrix_client_hydrogen_docker_image }}
|
||||||
|
|
||||||
|
ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-client-hydrogen 2>/dev/null'
|
||||||
|
ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-client-hydrogen 2>/dev/null'
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
SyslogIdentifier=matrix-client-hydrogen
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@ -0,0 +1,16 @@
|
|||||||
|
# Specifies how long to wait between starting systemd services and checking if they're started.
|
||||||
|
#
|
||||||
|
# A too low value may lead to a failure, as services may not have enough time to start and potentially fail.
|
||||||
|
#
|
||||||
|
# A value higher than 30 seconds (or any multiple of that) may also not work well, because a failing systemd service
|
||||||
|
# auto-restarts after 30 seconds (`RestartSec=30` in systemd service files).
|
||||||
|
# Checking if a service is running right after it had potentially restarted in such a way will lead us to
|
||||||
|
# thinking it's running, while it's merely starting again (and likely to fail again, given that it already did once).
|
||||||
|
#
|
||||||
|
# All of the services we manage are also started sequentially, which in itself can take a long time.
|
||||||
|
# There may be a ~10 second (or even larger) interval between starting the first service and starting the last one.
|
||||||
|
# This makes it even harder to pick a correct value. Such a 10 second gap and a waiting time of 20 seconds will
|
||||||
|
# put us right at the "dangerous" 30-second mark.
|
||||||
|
#
|
||||||
|
# We can try to measure this gap and adjust our waiting time accordingly, but we currently don't.
|
||||||
|
matrix_common_after_systemd_service_start_wait_for_timeout_seconds: 15
|
||||||
@ -1,3 +1,10 @@
|
|||||||
|
# See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1070
|
||||||
|
# and https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/1ab507349c752042d26def3e95884f6df8886b74#commitcomment-51108407
|
||||||
|
- name: Fail if trying to self-build on Ansible < 2.8
|
||||||
|
fail:
|
||||||
|
msg: "To self-build the Element image, you should use Ansible 2.8 or higher. See docs/ansible.md"
|
||||||
|
when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_corporal_container_image_self_build"
|
||||||
|
|
||||||
- set_fact:
|
- set_fact:
|
||||||
matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-corporal.service'] }}"
|
matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-corporal.service'] }}"
|
||||||
when: matrix_corporal_enabled|bool
|
when: matrix_corporal_enabled|bool
|
||||||
|
|||||||
@ -1,3 +1,10 @@
|
|||||||
|
# See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1070
|
||||||
|
# and https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/1ab507349c752042d26def3e95884f6df8886b74#commitcomment-51108407
|
||||||
|
- name: Fail if trying to self-build on Ansible < 2.8
|
||||||
|
fail:
|
||||||
|
msg: "To self-build the Element image, you should use Ansible 2.8 or higher. See docs/ansible.md"
|
||||||
|
when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_dynamic_dns_container_image_self_build"
|
||||||
|
|
||||||
- set_fact:
|
- set_fact:
|
||||||
matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-dynamic-dns.service'] }}"
|
matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-dynamic-dns.service'] }}"
|
||||||
when: "matrix_dynamic_dns_enabled|bool"
|
when: "matrix_dynamic_dns_enabled|bool"
|
||||||
|
|||||||
@ -1,3 +1,10 @@
|
|||||||
|
# See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1070
|
||||||
|
# and https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/1ab507349c752042d26def3e95884f6df8886b74#commitcomment-51108407
|
||||||
|
- name: Fail if trying to self-build on Ansible < 2.8
|
||||||
|
fail:
|
||||||
|
msg: "To self-build the Element image, you should use Ansible 2.8 or higher. See docs/ansible.md"
|
||||||
|
when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_mailer_container_image_self_build"
|
||||||
|
|
||||||
- set_fact:
|
- set_fact:
|
||||||
matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mailer.service'] }}"
|
matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mailer.service'] }}"
|
||||||
when: matrix_mailer_enabled|bool
|
when: matrix_mailer_enabled|bool
|
||||||
|
|||||||
@ -0,0 +1,98 @@
|
|||||||
|
#jinja2: lstrip_blocks: "True"
|
||||||
|
|
||||||
|
{% macro render_vhost_directives() %}
|
||||||
|
gzip on;
|
||||||
|
gzip_types text/plain application/json application/javascript text/css image/x-icon font/ttf image/gif;
|
||||||
|
|
||||||
|
add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
|
||||||
|
add_header X-Content-Type-Options nosniff;
|
||||||
|
add_header X-Frame-Options SAMEORIGIN;
|
||||||
|
add_header X-XSS-Protection "1; mode=block";
|
||||||
|
add_header Content-Security-Policy "frame-ancestors 'none'";
|
||||||
|
{% if matrix_nginx_proxy_floc_optout_enabled %}
|
||||||
|
add_header Permissions-Policy interest-cohort=() always;
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% for configuration_block in matrix_nginx_proxy_proxy_hydrogen_additional_server_configuration_blocks %}
|
||||||
|
{{- configuration_block }}
|
||||||
|
{% endfor %}
|
||||||
|
|
||||||
|
location / {
|
||||||
|
{% if matrix_nginx_proxy_enabled %}
|
||||||
|
{# Use the embedded DNS resolver in Docker containers to discover the service #}
|
||||||
|
resolver 127.0.0.11 valid=5s;
|
||||||
|
set $backend "matrix-client-hydrogen:8080";
|
||||||
|
proxy_pass http://$backend;
|
||||||
|
{% else %}
|
||||||
|
{# Generic configuration for use outside of our container setup #}
|
||||||
|
proxy_pass http://127.0.0.1:8768;
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Forwarded-For $remote_addr;
|
||||||
|
}
|
||||||
|
{% endmacro %}
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen {{ 8080 if matrix_nginx_proxy_enabled else 80 }};
|
||||||
|
|
||||||
|
server_name {{ matrix_nginx_proxy_proxy_hydrogen_hostname }};
|
||||||
|
|
||||||
|
server_tokens off;
|
||||||
|
root /dev/null;
|
||||||
|
|
||||||
|
{% if matrix_nginx_proxy_https_enabled %}
|
||||||
|
location /.well-known/acme-challenge {
|
||||||
|
{% if matrix_nginx_proxy_enabled %}
|
||||||
|
{# Use the embedded DNS resolver in Docker containers to discover the service #}
|
||||||
|
resolver 127.0.0.11 valid=5s;
|
||||||
|
set $backend "matrix-certbot:8080";
|
||||||
|
proxy_pass http://$backend;
|
||||||
|
{% else %}
|
||||||
|
{# Generic configuration for use outside of our container setup #}
|
||||||
|
proxy_pass http://127.0.0.1:{{ matrix_ssl_lets_encrypt_certbot_standalone_http_port }};
|
||||||
|
{% endif %}
|
||||||
|
}
|
||||||
|
|
||||||
|
location / {
|
||||||
|
return 301 https://$http_host$request_uri;
|
||||||
|
}
|
||||||
|
{% else %}
|
||||||
|
{{ render_vhost_directives() }}
|
||||||
|
{% endif %}
|
||||||
|
}
|
||||||
|
|
||||||
|
{% if matrix_nginx_proxy_https_enabled %}
|
||||||
|
server {
|
||||||
|
listen {{ 8443 if matrix_nginx_proxy_enabled else 443 }} ssl http2;
|
||||||
|
listen [::]:{{ 8443 if matrix_nginx_proxy_enabled else 443 }} ssl http2;
|
||||||
|
|
||||||
|
server_name {{ matrix_nginx_proxy_proxy_hydrogen_hostname }};
|
||||||
|
|
||||||
|
server_tokens off;
|
||||||
|
root /dev/null;
|
||||||
|
|
||||||
|
ssl_certificate {{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_hydrogen_hostname }}/fullchain.pem;
|
||||||
|
ssl_certificate_key {{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_hydrogen_hostname }}/privkey.pem;
|
||||||
|
|
||||||
|
ssl_protocols {{ matrix_nginx_proxy_ssl_protocols }};
|
||||||
|
{% if matrix_nginx_proxy_ssl_ciphers != "" %}
|
||||||
|
ssl_ciphers {{ matrix_nginx_proxy_ssl_ciphers }};
|
||||||
|
{% endif %}
|
||||||
|
ssl_prefer_server_ciphers {{ matrix_nginx_proxy_ssl_prefer_server_ciphers }};
|
||||||
|
|
||||||
|
{% if matrix_nginx_proxy_ocsp_stapling_enabled %}
|
||||||
|
ssl_stapling on;
|
||||||
|
ssl_stapling_verify on;
|
||||||
|
ssl_trusted_certificate {{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_element_hostname }}/chain.pem;
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if matrix_nginx_proxy_ssl_session_tickets_off %}
|
||||||
|
ssl_session_tickets off;
|
||||||
|
{% endif %}
|
||||||
|
ssl_session_cache {{ matrix_nginx_proxy_ssl_session_cache }};
|
||||||
|
ssl_session_timeout {{ matrix_nginx_proxy_ssl_session_timeout }};
|
||||||
|
|
||||||
|
{{ render_vhost_directives() }}
|
||||||
|
}
|
||||||
|
{% endif %}
|
||||||
Loading…
Reference in new issue