Matrix Docker Ansible eploy
No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.
 
 

103 líneas
6.8 KiB

  1. # SPDX-FileCopyrightText: 2024 - 2025 Slavi Pantaleev
  2. # SPDX-FileCopyrightText: 2024 Michael Hollister
  3. # SPDX-FileCopyrightText: 2024 Suguru Hirahara
  4. #
  5. # SPDX-License-Identifier: AGPL-3.0-or-later
  6. ---
  7. # Synapse Usage Exporter
  8. # Project source code URL: https://github.com/loelkes/synapse-usage-exporter
  9. matrix_synapse_usage_exporter_enabled: false
  10. # Controls the hostname and path that this component exposes its web services on.
  11. # Only used if `matrix_synapse_usage_exporter_proxying_enabled` is true.
  12. matrix_synapse_usage_exporter_hostname: "{{ matrix_server_fqn_matrix }}"
  13. matrix_synapse_usage_exporter_path_prefix: /report-usage-stats/push
  14. # matrix_synapse_usage_exporter_identifier controls the identifier of this synapse-usage-exporter instance, which influences:
  15. # - the default storage path
  16. # - the names of systemd services and containers
  17. matrix_synapse_usage_exporter_identifier: matrix-synapse-usage-exporter
  18. matrix_synapse_usage_exporter_container_port: 5000
  19. # No docker images are currently hosted for the repo, so defaulting to true
  20. matrix_synapse_usage_exporter_container_image_self_build: true
  21. matrix_synapse_usage_exporter_container_image_self_build_repo: "https://github.com/loelkes/synapse-usage-exporter.git"
  22. matrix_synapse_usage_exporter_container_image_path: "loelkes/synapse-usage-exporter"
  23. matrix_synapse_usage_exporter_container_image: "{{ matrix_synapse_usage_exporter_container_image_registry_prefix }}{{ matrix_synapse_usage_exporter_container_image_path }}:{{ matrix_synapse_usage_exporter_container_image_tag }}"
  24. matrix_synapse_usage_exporter_container_image_registry_prefix: "{{ 'localhost/' if matrix_synapse_usage_exporter_container_image_self_build else matrix_synapse_usage_exporter_container_image_registry_prefix_upstream }}"
  25. matrix_synapse_usage_exporter_container_image_registry_prefix_upstream: "{{ matrix_synapse_usage_exporter_container_image_registry_prefix_upstream_default }}"
  26. matrix_synapse_usage_exporter_container_image_registry_prefix_upstream_default: "docker.io/"
  27. matrix_synapse_usage_exporter_container_image_tag: "{{ 'main' if matrix_synapse_usage_exporter_container_image_self_build else 'latest' }}"
  28. matrix_synapse_usage_exporter_container_image_force_pull: "{{ matrix_synapse_usage_exporter_container_image.endswith(':latest') }}"
  29. matrix_synapse_usage_exporter_base_path: "{{ matrix_base_data_path }}/{{ matrix_synapse_usage_exporter_identifier }}"
  30. matrix_synapse_usage_exporter_docker_src_files_path: "{{ matrix_synapse_usage_exporter_base_path }}/docker-src"
  31. # List of systemd services that synapse-usage-exporter.service depends on
  32. matrix_synapse_usage_exporter_systemd_required_services_list: "{{ matrix_synapse_usage_exporter_systemd_required_services_list_default + matrix_synapse_usage_exporter_systemd_required_services_list_auto + matrix_synapse_usage_exporter_systemd_required_services_list_custom }}"
  33. matrix_synapse_usage_exporter_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
  34. matrix_synapse_usage_exporter_systemd_required_services_list_auto: []
  35. matrix_synapse_usage_exporter_systemd_required_services_list_custom: []
  36. # List of systemd services that synapse-usage-exporter.service wants
  37. matrix_synapse_usage_exporter_systemd_wanted_services_list: []
  38. # The base container network. It will be auto-created by this role if it doesn't exist already.
  39. matrix_synapse_usage_exporter_container_network: "{{ matrix_synapse_usage_exporter_identifier }}"
  40. # A list of additional container networks that the container would be connected to.
  41. # The role does not create these networks, so make sure they already exist.
  42. # Use this to expose this container to another reverse proxy, which runs in a different container network.
  43. matrix_synapse_usage_exporter_container_additional_networks: []
  44. # Extra arguments for the Docker container
  45. matrix_synapse_usage_exporter_container_extra_arguments: []
  46. # Controls whether the synapse-usage-exporter's web services should be proxied (exposed publicly).
  47. #
  48. # Exposure happens on `matrix.example.com/report-usage-stats/push` by default.
  49. # See: `matrix_synapse_usage_exporter_hostname` and `matrix_synapse_usage_exporter_path_prefix`.
  50. matrix_synapse_usage_exporter_proxying_enabled: false
  51. # matrix_synapse_usage_exporter_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
  52. # See `../templates/labels.j2` for details.
  53. #
  54. # To inject your own other container labels, see `matrix_synapse_usage_exporter_container_labels_additional_labels`.
  55. matrix_synapse_usage_exporter_container_labels_traefik_enabled: "{{ matrix_synapse_usage_exporter_proxying_enabled }}"
  56. matrix_synapse_usage_exporter_container_labels_traefik_docker_network: "{{ matrix_synapse_usage_exporter_container_network }}"
  57. matrix_synapse_usage_exporter_container_labels_traefik_path_prefix: "{{ matrix_synapse_usage_exporter_path_prefix }}"
  58. matrix_synapse_usage_exporter_container_labels_traefik_rule: "Host(`{{ matrix_synapse_usage_exporter_hostname }}`) && PathPrefix(`{{ matrix_synapse_usage_exporter_container_labels_traefik_path_prefix }}`)"
  59. matrix_synapse_usage_exporter_container_labels_traefik_priority: 0
  60. matrix_synapse_usage_exporter_container_labels_traefik_entrypoints: "web-secure"
  61. matrix_synapse_usage_exporter_container_labels_traefik_tls: "{{ matrix_synapse_usage_exporter_container_labels_traefik_entrypoints != 'web' }}"
  62. matrix_synapse_usage_exporter_container_labels_traefik_tls_certResolver: default # noqa var-naming
  63. # matrix_synapse_usage_exporter_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
  64. # See `../templates/labels.j2` for details.
  65. #
  66. # Example:
  67. # matrix_synapse_usage_exporter_container_labels_additional_labels: |
  68. # my.label=1
  69. # another.label="here"
  70. matrix_synapse_usage_exporter_container_labels_additional_labels: ''
  71. # matrix_synapse_usage_exporter_dashboard_urls contains a list of URLs with Grafana dashboard definitions.
  72. # If the Grafana role is enabled, these dashboards will be downloaded.
  73. matrix_synapse_usage_exporter_dashboard_urls:
  74. - https://raw.githubusercontent.com/spantaleev/matrix-docker-ansible-deploy/master/roles/custom/matrix-synapse-usage-exporter/templates/grafana/synapse-usage-exporter.json
  75. # matrix_synapse_usage_exporter_restart_necessary controls whether the service
  76. # will be restarted (when true) or merely started (when false) by the
  77. # systemd service manager role (when conditional restart is enabled).
  78. #
  79. # This value is automatically computed during installation based on whether
  80. # any configuration files, the systemd service file, or the container image changed.
  81. # The default of `false` means "no restart needed" — appropriate when the role's
  82. # installation tasks haven't run (e.g., due to --tags skipping them).
  83. matrix_synapse_usage_exporter_restart_necessary: false