Merge pull request #2229 from etkecc/make-etherpad-great-again

standalone etherpad

roles/custom/matrix-base/defaults/main.yml

@@ -62,6 +62,9 @@ matrix_server_fqn_buscarron: "buscarron.{{ matrix_domain }}"
 # This is where you access the Dimension.
 matrix_server_fqn_dimension: "dimension.{{ matrix_domain }}"
 
+# This is where you access the etherpad (if enabled via matrix_etherpad_enabled; disabled by default).
+matrix_server_fqn_etherpad: "etherpad.{{ matrix_domain }}"
+
 # For use with Go-NEB! (github callback url for example)
 matrix_server_fqn_bot_go_neb: "goneb.{{ matrix_domain }}"
 

roles/custom/matrix-etherpad/defaults/main.yml

@@ -3,6 +3,10 @@
 
 matrix_etherpad_enabled: false
 
+# standalone = etherpad installed on subdomain (etherpad.DOMAIN) and can be used as-is
+# dimension = etherpad installed in subdir of dimension (dimension.DOMAIN/etherpad) and can be used with dimension
+matrix_etherpad_mode: standalone
+
 matrix_etherpad_base_path: "{{ matrix_base_data_path }}/etherpad"
 
 matrix_etherpad_version: 1.8.18
@@ -28,10 +32,11 @@ matrix_etherpad_container_http_host_bind_port: ''
 # A list of extra arguments to pass to the container
 matrix_etherpad_container_extra_arguments: []
 
+# Used only when `matrix_etherpad_mode: dimension`
 matrix_etherpad_public_endpoint: '/etherpad'
 
-# By default, the Etherpad app can be accessed within the Dimension domain
-matrix_etherpad_base_url: "https://{{ matrix_server_fqn_dimension }}{{ matrix_etherpad_public_endpoint }}"
+# By default, the Etherpad app can be accessed on etherpad subdomain
+matrix_etherpad_base_url: "https://{{ matrix_server_fqn_etherpad }}/"
 
 # Database-related configuration fields.
 #

roles/custom/matrix-etherpad/tasks/init.yml

@@ -4,7 +4,7 @@
     matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-etherpad.service'] }}"
   when: matrix_etherpad_enabled | bool
 
-- when: matrix_etherpad_enabled | bool
+- when: matrix_etherpad_enabled | bool and matrix_etherpad_mode == 'dimension'
   tags:
     - always
   block:
@@ -52,13 +52,3 @@
             +
             [matrix_etherpad_matrix_nginx_proxy_configuration]
           }}
-
-- name: Warn about reverse-proxying if matrix-nginx-proxy not used
-  ansible.builtin.debug:
-    msg: >-
-      NOTE: You've enabled the Etherpad tool but are not using the matrix-nginx-proxy
-      reverse proxy.
-      Please make sure that you're proxying the `{{ matrix_etherpad_public_endpoint }}`
-      URL endpoint to the matrix-etherpad container.
-      You can expose the container's port using the `matrix_etherpad_container_http_host_bind_port` variable.
-  when: "matrix_etherpad_enabled | bool and not matrix_nginx_proxy_enabled | default(False) | bool"

roles/custom/matrix-etherpad/tasks/main.yml

@@ -4,6 +4,12 @@
   tags:
     - always
 
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  when: run_setup | bool and matrix_etherpad_enabled | bool
+  tags:
+    - setup-all
+    - setup-etherpad
+
 - ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_install.yml"
   when: run_setup | bool and matrix_etherpad_enabled | bool
   tags:
@@ -15,9 +21,3 @@
   tags:
     - setup-all
     - setup-etherpad
-
-- ansible.builtin.import_tasks: "{{ role_path }}/tasks/validate_config.yml"
-  when: run_setup | bool and matrix_etherpad_enabled | bool
-  tags:
-    - setup-all
-    - setup-etherpad

roles/custom/matrix-etherpad/tasks/validate_config.yml

@@ -1,13 +1,13 @@
 ---
 
-- name: Fail if Etherpad is enabled without the Dimension integrations manager
-  ansible.builtin.fail:
-    msg: >-
-      To integrate Etherpad notes with Matrix rooms you need to set "matrix_dimension_enabled" to true
-  when: "not matrix_dimension_enabled | bool"
-
 - name: Fail if no database is configured for Etherpad
   ansible.builtin.fail:
     msg: >-
       Etherpad requires a dedicated Postgres database. Please enable the built in one, or configure an external DB by redefining "matrix_etherpad_database_hostname"
   when: matrix_etherpad_database_hostname == "matrix-postgres" and not matrix_postgres_enabled
+
+- name: Fail if wrong mode selected
+  ansible.builtin.fail:
+    msg: >-
+      You're using Etherpad in 'dimension' mode (`matrix_etherpad_serving_mode: dimension`), which tries to host Etherpad at the Dimension subdomain - `{{ matrix_server_fqn_dimension }}`. However, this isn't possible because Dimension is not enabled. To resolve the problem, either enable Dimension (`matrix_dimension_enabled: true`) or switch Etherpad to standalone mode (`matrix_etherpad_mode: standalone`) and have it served on its own domain (`{{ matrix_server_fqn_etherpad }}`).
+  when: matrix_etherpad_enabled | bool and matrix_etherpad_mode == 'dimension' and not matrix_dimension_enabled | default(False) | bool

roles/custom/matrix-nginx-proxy/defaults/main.yml

@@ -192,6 +192,10 @@ matrix_nginx_proxy_proxy_matrix_federation_port: 8448
 matrix_nginx_proxy_proxy_dimension_enabled: false
 matrix_nginx_proxy_proxy_dimension_hostname: "{{ matrix_server_fqn_dimension }}"
 
+# Controls whether proxying the etherpad domain should be done.
+matrix_nginx_proxy_proxy_etherpad_enabled: false
+matrix_nginx_proxy_proxy_etherpad_hostname: "{{ matrix_server_fqn_etherpad }}"
+
 # Controls whether proxying the goneb domain should be done.
 matrix_nginx_proxy_proxy_bot_go_neb_enabled: false
 matrix_nginx_proxy_proxy_bot_go_neb_hostname: "{{ matrix_server_fqn_bot_go_neb }}"
@@ -373,6 +377,9 @@ matrix_nginx_proxy_proxy_buscarron_additional_server_configuration_blocks: []
 # A list of strings containing additional configuration blocks to add to Dimension's server configuration (matrix-dimension.conf).
 matrix_nginx_proxy_proxy_dimension_additional_server_configuration_blocks: []
 
+# A list of strings containing additional configuration blocks to add to etherpad's server configuration (matrix-etherpad.conf).
+matrix_nginx_proxy_proxy_etherpad_additional_server_configuration_blocks: []
+
 # A list of strings containing additional configuration blocks to add to GoNEB's server configuration (matrix-bot-go-neb.conf).
 matrix_nginx_proxy_proxy_bot_go_neb_additional_server_configuration_blocks: []
 

roles/custom/matrix-nginx-proxy/tasks/setup_nginx_proxy.yml

@@ -123,6 +123,13 @@
     mode: 0644
   when: matrix_nginx_proxy_proxy_dimension_enabled | bool
 
+- name: Ensure Matrix nginx-proxy configuration for etherpad domain exists
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/nginx/conf.d/matrix-etherpad.conf.j2"
+    dest: "{{ matrix_nginx_proxy_confd_path }}/matrix-etherpad.conf"
+    mode: 0644
+  when: matrix_nginx_proxy_proxy_etherpad_enabled | bool
+
 - name: Ensure Matrix nginx-proxy configuration for goneb domain exists
   ansible.builtin.template:
     src: "{{ role_path }}/templates/nginx/conf.d/matrix-bot-go-neb.conf.j2"

roles/custom/matrix-nginx-proxy/templates/nginx/conf.d/matrix-etherpad.conf.j2

@@ -0,0 +1,108 @@
+#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;
+	{% if matrix_nginx_proxy_hsts_preload_enabled %}
+		add_header Strict-Transport-Security "max-age=31536000; includeSubDomains; preload" always;
+	{% else %}
+		add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
+	{% endif %}
+	add_header X-XSS-Protection "{{ matrix_nginx_proxy_xss_protection }}";
+	add_header X-Content-Type-Options nosniff;
+	{% if matrix_nginx_proxy_floc_optout_enabled %}
+		add_header Permissions-Policy interest-cohort=() always;
+	{% endif %}
+
+{% for configuration_block in matrix_nginx_proxy_proxy_etherpad_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 {{ matrix_nginx_proxy_http_level_resolver }} valid=5s;
+			set $backend "matrix-etherpad:9001";
+			proxy_pass http://$backend;
+			{# These are proxy directives needed specifically by Etherpad #}
+			proxy_buffering off;
+			proxy_http_version 1.1;  {# recommended with keepalive connections #}
+			proxy_pass_header Server;
+			proxy_set_header Host $host;
+			proxy_set_header X-Forwarded-Proto {{ matrix_nginx_proxy_x_forwarded_proto_value }}; {# for EP to set secure cookie flag when https is used #}
+			{# WebSocket proxying - from http://nginx.org/en/docs/http/websocket.html #}
+			proxy_set_header Upgrade $http_upgrade;
+			proxy_set_header Connection $connection_upgrade;
+		{% else %}
+			{# Generic configuration for use outside of our container setup #}
+			# A good guide for setting up your Etherpad behind nginx:
+			# https://docs.gandi.net/en/cloud/tutorials/etherpad_lite.html
+			proxy_pass http://127.0.0.1:9001/;
+		{% endif %}
+	}
+{% endmacro %}
+
+server {
+	listen {{ 8080 if matrix_nginx_proxy_enabled else 80 }};
+	listen [::]:{{ 8080 if matrix_nginx_proxy_enabled else 80 }};
+
+	server_name {{ matrix_nginx_proxy_proxy_etherpad_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 {{ matrix_nginx_proxy_http_level_resolver }} 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_etherpad_hostname }};
+
+	server_tokens off;
+	root /dev/null;
+
+	ssl_certificate {{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_etherpad_hostname }}/fullchain.pem;
+	ssl_certificate_key {{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_etherpad_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_etherpad_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 %}