2022-02-06 04:32:54 +08:00
|
|
|
---
|
2020-07-22 13:10:26 +08:00
|
|
|
# matrix-synapse-admin is a web UI for mananging the Synapse Matrix server
|
2022-07-17 04:59:21 +08:00
|
|
|
# Project source code URL: https://github.com/Awesome-Technologies/synapse-admin
|
2020-07-22 13:10:26 +08:00
|
|
|
|
|
|
|
|
matrix_synapse_admin_enabled: true
|
|
|
|
|
|
2023-02-13 21:08:42 +08:00
|
|
|
# A path on host where all related files will be saved
|
|
|
|
|
matrix_synapse_admin_base_path: "{{ matrix_base_data_path }}/synapse-admin"
|
|
|
|
|
matrix_synapse_admin_docker_src_files_path: "{{ matrix_synapse_admin_base_path }}/docker-src"
|
|
|
|
|
|
|
|
|
|
# Specifies whether this role will integrate with the matrix-nginx-proxy role
|
|
|
|
|
matrix_synapse_admin_nginx_proxy_integration_enabled: false
|
|
|
|
|
|
2022-01-07 18:18:45 +08:00
|
|
|
matrix_synapse_admin_container_image_self_build: false
|
|
|
|
|
matrix_synapse_admin_container_image_self_build_repo: "https://github.com/Awesome-Technologies/synapse-admin.git"
|
2020-11-29 03:34:14 +08:00
|
|
|
|
2023-02-07 16:45:19 +08:00
|
|
|
matrix_synapse_admin_version: 0.8.7
|
2021-02-21 01:08:28 +08:00
|
|
|
matrix_synapse_admin_docker_image: "{{ matrix_synapse_admin_docker_image_name_prefix }}awesometechnologies/synapse-admin:{{ matrix_synapse_admin_version }}"
|
2022-01-07 18:18:45 +08:00
|
|
|
matrix_synapse_admin_docker_image_name_prefix: "{{ 'localhost/' if matrix_synapse_admin_container_image_self_build else matrix_container_global_registry_prefix }}"
|
2020-07-22 13:10:26 +08:00
|
|
|
matrix_synapse_admin_docker_image_force_pull: "{{ matrix_synapse_admin_docker_image.endswith(':latest') }}"
|
|
|
|
|
|
2023-02-13 21:08:42 +08:00
|
|
|
# The base container network
|
|
|
|
|
matrix_synapse_admin_container_network: matrix-synapse-admin
|
|
|
|
|
|
|
|
|
|
# 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.
|
2023-02-14 00:33:06 +08:00
|
|
|
# Use this to expose this container to a reverse proxy, which runs in a different container network.
|
2023-02-13 21:08:42 +08:00
|
|
|
matrix_synapse_admin_container_additional_networks: []
|
|
|
|
|
|
2020-07-22 13:10:26 +08:00
|
|
|
# A list of extra arguments to pass to the container
|
|
|
|
|
matrix_synapse_admin_container_extra_arguments: []
|
|
|
|
|
|
2023-02-13 21:08:42 +08:00
|
|
|
# matrix_synapse_admin_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_synapse_admin_container_labels_additional_labels`.
|
|
|
|
|
matrix_synapse_admin_container_labels_traefik_enabled: true
|
|
|
|
|
matrix_synapse_admin_container_labels_traefik_docker_network: "{{ matrix_synapse_admin_container_network }}"
|
|
|
|
|
matrix_synapse_admin_container_labels_traefik_hostname: "{{ matrix_server_fqn_matrix }}"
|
2023-02-14 14:42:50 +08:00
|
|
|
# The path prefix must either be `/` or not end with a slash (e.g. `/synapse-admin`).
|
2023-02-13 21:08:42 +08:00
|
|
|
matrix_synapse_admin_container_labels_traefik_path_prefix: /synapse-admin
|
2023-02-14 14:42:50 +08:00
|
|
|
matrix_synapse_admin_container_labels_traefik_rule: "Host(`{{ matrix_synapse_admin_container_labels_traefik_hostname }}`){% if matrix_synapse_admin_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_synapse_admin_container_labels_traefik_path_prefix | quote }}`){% endif %}"
|
2023-02-13 21:08:42 +08:00
|
|
|
matrix_synapse_admin_container_labels_traefik_entrypoints: web-secure
|
|
|
|
|
matrix_synapse_admin_container_labels_traefik_tls: "{{ matrix_synapse_admin_container_labels_traefik_entrypoints != 'web' }}"
|
|
|
|
|
matrix_synapse_admin_container_labels_traefik_tls_certResolver: default # noqa var-naming
|
|
|
|
|
|
|
|
|
|
# matrix_synapse_admin_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_synapse_admin_container_labels_additional_labels: |
|
|
|
|
|
# my.label=1
|
|
|
|
|
# another.label="here"
|
|
|
|
|
matrix_synapse_admin_container_labels_additional_labels: ''
|
|
|
|
|
|
2020-07-22 13:10:26 +08:00
|
|
|
# List of systemd services that matrix-synapse-admin.service depends on
|
|
|
|
|
matrix_synapse_admin_systemd_required_services_list: ['docker.service']
|
|
|
|
|
|
|
|
|
|
# List of systemd services that matrix-synapse-admin.service wants
|
|
|
|
|
matrix_synapse_admin_systemd_wanted_services_list: []
|
|
|
|
|
|
|
|
|
|
# Controls whether the matrix-synapse-admin container exposes its HTTP port (tcp/80 in the container).
|
|
|
|
|
#
|
|
|
|
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8766"), or empty string to not expose.
|
|
|
|
|
matrix_synapse_admin_container_http_host_bind_port: ''
|
|
|
|
|
|
|
|
|
|
# The path at which Synapse Admin will be exposed on `matrix.DOMAIN`
|
|
|
|
|
# (only applies when matrix-nginx-proxy is used).
|
|
|
|
|
matrix_synapse_admin_public_endpoint: /synapse-admin
|
