Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

145 lines
8.1 KiB

  1. matrix_nginx_proxy_enabled: true
  2. matrix_nginx_proxy_nginx_status_enabled: false
  3. # We use an official nginx image, which we fix-up to run unprivileged.
  4. # An alternative would be an `nginxinc/nginx-unprivileged` image, but
  5. # those as more frequently out of date.
  6. matrix_nginx_proxy_docker_image: "nginx:1.15.10-alpine"
  7. matrix_nginx_proxy_base_path: "{{ matrix_base_data_path }}/nginx-proxy"
  8. matrix_nginx_proxy_data_path: "{{ matrix_nginx_proxy_base_path }}/data"
  9. matrix_nginx_proxy_confd_path: "{{ matrix_nginx_proxy_base_path }}/conf.d"
  10. # List of systemd services that matrix-nginx-proxy.service depends on
  11. matrix_nginx_proxy_systemd_required_services_list: ['docker.service']
  12. # List of systemd services that matrix-nginx-proxy.service wants
  13. matrix_nginx_proxy_systemd_wanted_services_list: []
  14. # A list of additional "volumes" to mount in the container.
  15. # This list gets populated dynamically at runtime. You can provide a different default value,
  16. # if you wish to mount your own files into the container.
  17. # Contains definition objects like this: `{"src": "/outside", "dst": "/inside", "options": "rw|ro|slave|.."}
  18. matrix_nginx_proxy_container_additional_volumes: []
  19. # Controls whether matrix-nginx-proxy should serve the base domain.
  20. #
  21. # This is useful for when you only have your Matrix server, but you need to serve
  22. # to serve `/.well-known/matrix/*` files from the base domain for the needs of
  23. # Server-Discovery (Federation) and for Client-Discovery.
  24. #
  25. # Besides serving these Matrix files, a homepage would be served with content
  26. # as specified in the `matrix_nginx_proxy_base_domain_homepage_template` variable.
  27. # You can also put additional files to use for this webpage
  28. # in the `{{ matrix_nginx_proxy_data_path }}/matrix-domain` (`/matrix/nginx-proxy/data/matrix-domain`) directory.
  29. matrix_nginx_proxy_base_domain_serving_enabled: false
  30. matrix_nginx_proxy_base_domain_hostname: "{{ matrix_domain }}"
  31. matrix_nginx_proxy_base_domain_homepage_template: |-
  32. <!doctype html>
  33. <meta charset="utf-8" />
  34. <html>
  35. <body>
  36. Hello from {{ matrix_domain }}!
  37. </body>
  38. </html>
  39. # Controls whether proxying the riot domain should be done.
  40. matrix_nginx_proxy_proxy_riot_enabled: false
  41. matrix_nginx_proxy_proxy_riot_hostname: "{{ matrix_server_fqn_riot }}"
  42. # Controls whether proxying the matrix domain should be done.
  43. matrix_nginx_proxy_proxy_matrix_enabled: false
  44. matrix_nginx_proxy_proxy_matrix_hostname: "{{ matrix_server_fqn_matrix }}"
  45. # Controls whether proxying the dimension domain should be done.
  46. matrix_nginx_proxy_proxy_dimension_enabled: false
  47. matrix_nginx_proxy_proxy_dimension_hostname: "{{ matrix_server_fqn_dimension }}"
  48. # Controls whether proxying for the matrix-corporal API (`/_matrix/corporal`) should be done (on the matrix domain)
  49. matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: false
  50. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
  51. matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
  52. # Controls whether proxying for the User Directory Search API (`/_matrix/client/r0/user_directory/search`) should be done (on the matrix domain).
  53. # This can be used to forward the API endpoint to another service, augmenting the functionality of Synapse's own User Directory Search.
  54. # To learn more, see: https://github.com/kamax-matrix/mxisd/blob/master/docs/features/directory.md
  55. matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: false
  56. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "matrix-mxisd:8090"
  57. matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "127.0.0.1:8090"
  58. # Controls whether proxying for the Identity API (`/_matrix/identity`) should be done (on the matrix domain)
  59. matrix_nginx_proxy_proxy_matrix_identity_api_enabled: false
  60. matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-mxisd:8090"
  61. matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:8090"
  62. # Controls whether proxying for metrics (`/_synapse/metrics`) should be done (on the matrix domain)
  63. matrix_nginx_proxy_proxy_synapse_metrics: false
  64. matrix_nginx_proxy_proxy_synapse_metrics_basic_auth_enabled: false
  65. matrix_nginx_proxy_proxy_synapse_metrics_basic_auth_key: ""
  66. # The addresses where the Matrix Client API is.
  67. # Certain extensions (like matrix-corporal) may override this in order to capture all traffic.
  68. matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "matrix-synapse:8008"
  69. matrix_nginx_proxy_proxy_matrix_client_api_addr_sans_container: "127.0.0.1:8008"
  70. # This needs to be equal or higher than the maximum upload size accepted by Synapse.
  71. matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: 25
  72. # Controls whether proxying for the Matrix Federation API should be done.
  73. matrix_nginx_proxy_proxy_matrix_federation_api_enabled: false
  74. matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-synapse:8048"
  75. matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "localhost:8048"
  76. matrix_nginx_proxy_proxy_matrix_federation_api_client_max_body_size_mb: "{{ matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb * 3 }}"
  77. matrix_nginx_proxy_proxy_matrix_federation_api_ssl_certificate: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_matrix_hostname }}/fullchain.pem"
  78. matrix_nginx_proxy_proxy_matrix_federation_api_ssl_certificate_key: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_nginx_proxy_proxy_matrix_hostname }}/privkey.pem"
  79. # The tmpfs at /tmp needs to be large enough to handle multiple concurrent file uploads.
  80. matrix_nginx_proxy_tmp_directory_size_mb: "{{ matrix_nginx_proxy_proxy_matrix_federation_api_client_max_body_size_mb * 50 }}"
  81. # A list of strings containing additional configuration blocks to add to the matrix domain's server configuration.
  82. matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks: []
  83. # Specifies when to reload the matrix-nginx-proxy service so that
  84. # a new SSL certificate could go into effect.
  85. matrix_nginx_proxy_reload_cron_time_definition: "20 4 */5 * *"
  86. # Specifies which SSL protocols to use when serving Riot and Synapse
  87. matrix_nginx_proxy_ssl_protocols: "TLSv1.1 TLSv1.2 TLSv1.3"
  88. # Controls whether the self-check feature should validate SSL certificates.
  89. matrix_nginx_proxy_self_check_validate_certificates: true
  90. # By default, this playbook automatically retrieves and auto-renews
  91. # free SSL certificates from Let's Encrypt.
  92. #
  93. # The following retrieval methods are supported:
  94. # - "lets-encrypt" - the playbook obtains free SSL certificates from Let's Encrypt
  95. # - "self-signed" - the playbook generates and self-signs certificates
  96. # - "manually-managed" - lets you manage certificates by yourself (manually; see below)
  97. # - "none" - like "manually-managed", but doesn't care if you don't drop certificates in the location it expects
  98. #
  99. # If you decide to manage certificates by yourself (`matrix_ssl_retrieval_method: manually-managed`),
  100. # you'd need to drop them into the directory specified by `matrix_ssl_config_dir_path`
  101. # obeying the following hierarchy:
  102. # - <matrix_ssl_config_dir_path>/live/<domain>/fullchain.pem
  103. # - <matrix_ssl_config_dir_path>/live/<domain>/privkey.pem
  104. # where <domain> refers to the domains that you need (usually `matrix_server_fqn_matrix` and `matrix_server_fqn_riot`).
  105. #
  106. # The "none" type (`matrix_ssl_retrieval_method: none`), simply means that no certificate retrieval will happen.
  107. # It's useful for when you've disabled the nginx proxy (`matrix_nginx_proxy_enabled: false`)
  108. # and you'll be using another reverse-proxy server (like Apache) with your own certificates, managed by yourself.
  109. matrix_ssl_retrieval_method: "lets-encrypt"
  110. # The list of domains that this role will obtain certificates for.
  111. matrix_ssl_domains_to_obtain_certificates_for: []
  112. # Controls whether to obtain production or staging certificates from Let's Encrypt.
  113. matrix_ssl_lets_encrypt_staging: false
  114. matrix_ssl_lets_encrypt_certbot_docker_image: "certbot/certbot:v0.33.1"
  115. matrix_ssl_lets_encrypt_certbot_standalone_http_port: 2402
  116. matrix_ssl_lets_encrypt_support_email: ~
  117. matrix_ssl_base_path: "{{ matrix_base_data_path }}/ssl"
  118. matrix_ssl_config_dir_path: "{{ matrix_ssl_base_path }}/config"
  119. matrix_ssl_log_dir_path: "{{ matrix_ssl_base_path }}/log"