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.
 
 

938 lines
53 KiB

  1. ---
  2. # matrix-media-repo is a highly customizable multi-domain media repository for Matrix.
  3. # Intended for medium to large environments consisting of several homeservers, this
  4. # media repo de-duplicates media (including remote media) while being fully compliant
  5. # with the specification.
  6. # See: https://github.com/turt2live/matrix-media-repo
  7. matrix_media_repo_enabled: false
  8. # matrix_media_repo_identifier controls the identifier of this media-repo instance, which influences:
  9. # - the default storage path
  10. # - the names of systemd services and containers
  11. matrix_media_repo_identifier: matrix-media-repo
  12. matrix_media_repo_container_image_self_build: false
  13. matrix_media_repo_container_image_self_build_repo: "https://github.com/turt2live/matrix-media-repo.git"
  14. matrix_media_repo_docker_image_path: "t2bot/matrix-media-repo"
  15. matrix_media_repo_docker_image: "{{ matrix_media_repo_docker_image_registry_prefix }}{{ matrix_media_repo_docker_image_path }}:{{ matrix_media_repo_docker_image_tag }}"
  16. matrix_media_repo_docker_image_registry_prefix: "{{ 'localhost/' if matrix_media_repo_container_image_self_build else matrix_media_repo_docker_image_registry_prefix_upstream }}"
  17. matrix_media_repo_docker_image_registry_prefix_upstream: "{{ matrix_media_repo_docker_image_registry_prefix_upstream_default }}"
  18. matrix_media_repo_docker_image_registry_prefix_upstream_default: "ghcr.io/"
  19. # renovate: datasource=docker depName=ghcr.io/t2bot/matrix-media-repo
  20. matrix_media_repo_docker_image_tag: "v1.3.8"
  21. matrix_media_repo_docker_image_force_pull: "{{ matrix_media_repo_docker_image.endswith(':latest') }}"
  22. matrix_media_repo_base_path: "{{ matrix_base_data_path }}/{{ matrix_media_repo_identifier }}"
  23. matrix_media_repo_config_path: "{{ matrix_media_repo_base_path }}/config"
  24. matrix_media_repo_data_path: "{{ matrix_media_repo_base_path }}/data"
  25. matrix_media_repo_docker_src_files_path: "{{ matrix_media_repo_base_path }}/docker-src"
  26. # List of systemd services that matrix-media-repo.service depends on
  27. matrix_media_repo_systemd_required_services_list: "{{ matrix_media_repo_systemd_required_services_list_default + matrix_media_repo_systemd_required_services_list_auto + matrix_media_repo_systemd_required_services_list_custom }}"
  28. matrix_media_repo_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
  29. matrix_media_repo_systemd_required_services_list_auto: []
  30. matrix_media_repo_systemd_required_services_list_custom: []
  31. # List of systemd services that matrix-media-repo.service wants
  32. matrix_media_repo_systemd_wanted_services_list: []
  33. # The base container network. It will be auto-created by this role if it doesn't exist already.
  34. matrix_media_repo_container_network: "{{ matrix_media_repo_identifier }}"
  35. # A list of additional container networks that the container would be connected to.
  36. # The role does not create these networks, so make sure they already exist.
  37. # Use this to expose this container to another reverse proxy, which runs in a different container network.
  38. matrix_media_repo_container_additional_networks: []
  39. # Controls whether media repo metrics should be proxied (exposed) on `matrix.example.com/metrics/matrix-media-repo`
  40. matrix_media_repo_metrics_proxying_enabled: false
  41. matrix_media_repo_metrics_proxying_hostname: ""
  42. matrix_media_repo_metrics_proxying_path: "/metrics/matrix-media-repo"
  43. # Controls whether the matrix-media-repo container exposes its HTTP port (tcp/8000 in the container).
  44. #
  45. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8000"), or empty string to not expose.
  46. matrix_media_repo_container_http_host_bind_port: ""
  47. # Controls whether the matrix-media-repo container exposes its metrics port (tcp/9000 in the container).
  48. #
  49. # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:9000"), or empty string to not expose.
  50. matrix_media_repo_container_metrics_host_bind_port: ""
  51. # Extra arguments for the Docker container
  52. matrix_media_repo_container_extra_arguments: []
  53. # matrix_media_repo_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
  54. # See `../templates/labels.j2` for details.
  55. #
  56. # To inject your own other container labels, see `matrix_media_repo_container_labels_additional_labels`.
  57. matrix_media_repo_container_labels_traefik_enabled: true
  58. matrix_media_repo_container_labels_traefik_docker_network: "{{ matrix_media_repo_container_network }}"
  59. matrix_media_repo_container_labels_traefik_entrypoints: web-secure
  60. # Traefik labels handling the old `/_matrix/media` endpoints on the Client-API (web-secure) entrypoint.
  61. # These are being superseded by `/_matrix/client/VERSION/media` endpoints - see `matrix_media_repo_container_labels_traefik_client_matrix_client_media_*`.
  62. matrix_media_repo_container_labels_traefik_media_enabled: true
  63. matrix_media_repo_container_labels_traefik_media_path_prefix: "/_matrix/media"
  64. matrix_media_repo_container_labels_traefik_media_rule: "Host(`{{ matrix_server_fqn_matrix }}`) && PathPrefix(`{{ matrix_media_repo_container_labels_traefik_media_path_prefix }}`)"
  65. matrix_media_repo_container_labels_traefik_media_priority: 0
  66. matrix_media_repo_container_labels_traefik_media_entrypoints: "{{ matrix_media_repo_container_labels_traefik_entrypoints }}"
  67. matrix_media_repo_container_labels_traefik_media_tls: "{{ matrix_media_repo_container_labels_traefik_media_entrypoints != 'web' }}"
  68. matrix_media_repo_container_labels_traefik_media_tls_certResolver: default # noqa var-naming
  69. # Traefik labels handling the new `/_matrix/client/VERSION/media` endpoints on the Client-API (web-secure) entrypoint.
  70. # See: https://github.com/matrix-org/matrix-spec-proposals/pull/3916
  71. matrix_media_repo_container_labels_traefik_client_matrix_client_media_enabled: true
  72. matrix_media_repo_container_labels_traefik_client_matrix_client_media_path_regexp: "/_matrix/client/(?P<version>(v1))/media"
  73. matrix_media_repo_container_labels_traefik_client_matrix_client_media_rule: "Host(`{{ matrix_server_fqn_matrix }}`) && PathRegexp(`{{ matrix_media_repo_container_labels_traefik_client_matrix_client_media_path_regexp }}`)"
  74. matrix_media_repo_container_labels_traefik_client_matrix_client_media_priority: 0
  75. matrix_media_repo_container_labels_traefik_client_matrix_client_media_entrypoints: "{{ matrix_media_repo_container_labels_traefik_entrypoints }}"
  76. matrix_media_repo_container_labels_traefik_client_matrix_client_media_tls: "{{ matrix_media_repo_container_labels_traefik_client_matrix_client_media_entrypoints != 'web' }}"
  77. matrix_media_repo_container_labels_traefik_client_matrix_client_media_tls_certResolver: default # noqa var-naming
  78. # Traefik labels handling the old `/_matrix/media` endpoints on the internal entrypoint.
  79. # This is like `matrix_media_repo_container_labels_traefik_media_*`, but on an internal Traefik entrypoint.
  80. # These are being superseded by `/_matrix/client/VERSION/media` endpoints - see `matrix_media_repo_container_labels_traefik_internal_matrix_client_media_*`.
  81. matrix_media_repo_container_labels_traefik_internal_media_enabled: false
  82. matrix_media_repo_container_labels_traefik_internal_media_path_prefix: "{{ matrix_media_repo_container_labels_traefik_media_path_prefix }}"
  83. matrix_media_repo_container_labels_traefik_internal_media_rule: "PathPrefix(`{{ matrix_media_repo_container_labels_traefik_internal_media_path_prefix }}`)"
  84. matrix_media_repo_container_labels_traefik_internal_media_priority: "{{ matrix_media_repo_container_labels_traefik_media_priority }}"
  85. matrix_media_repo_container_labels_traefik_internal_media_entrypoints: ""
  86. # Traefik labels handling the new `/_matrix/client/VERSION/media` endpoints on the internal entrypoint.
  87. # See: https://github.com/matrix-org/matrix-spec-proposals/pull/3916
  88. matrix_media_repo_container_labels_traefik_internal_matrix_client_media_enabled: false
  89. matrix_media_repo_container_labels_traefik_internal_matrix_client_media_path_regexp: "{{ matrix_media_repo_container_labels_traefik_client_matrix_client_media_path_regexp }}"
  90. matrix_media_repo_container_labels_traefik_internal_matrix_client_media_rule: "PathRegexp(`{{ matrix_media_repo_container_labels_traefik_internal_matrix_client_media_path_regexp }}`)"
  91. matrix_media_repo_container_labels_traefik_internal_matrix_client_media_priority: "{{ matrix_media_repo_container_labels_traefik_client_matrix_client_media_priority }}"
  92. matrix_media_repo_container_labels_traefik_internal_matrix_client_media_entrypoints: ""
  93. # Traefik labels handling some additional routes on the Client-API (web-secure) entrypoint:
  94. # - /_matrix/client/r0/logout
  95. # - /_matrix/client/r0/logout/all
  96. matrix_media_repo_container_labels_traefik_logout_enabled: true
  97. matrix_media_repo_container_labels_traefik_logout_path_regexp: "^/_matrix/client/(?P<version>r0|v1|v3|unstable)/(?P<endpoint>logout|logout/all)"
  98. matrix_media_repo_container_labels_traefik_logout_rule: "Host(`{{ matrix_server_fqn_matrix }}`) && PathRegexp(`{{ matrix_media_repo_container_labels_traefik_logout_path_regexp }}`)"
  99. matrix_media_repo_container_labels_traefik_logout_priority: 0
  100. matrix_media_repo_container_labels_traefik_logout_entrypoints: "{{ matrix_media_repo_container_labels_traefik_entrypoints }}"
  101. matrix_media_repo_container_labels_traefik_logout_tls: "{{ matrix_media_repo_container_labels_traefik_logout_entrypoints != 'web' }}"
  102. matrix_media_repo_container_labels_traefik_logout_tls_certResolver: default # noqa var-naming
  103. # Traefik labels handling some additional routes on the Client-API (web-secure) entrypoint:
  104. # - /_matrix/client/r0/admin/purge_media_cache
  105. # - /_matrix/client/r0/admin/quarantine_media/{roomId:[^/]+}
  106. matrix_media_repo_container_labels_traefik_admin_enabled: true
  107. matrix_media_repo_container_labels_traefik_admin_path_regexp: "^/_matrix/client/(?P<version>(r0|v1|v3|unstable))/admin/(?P<endpoint>(purge_media_cache|quarantine_media/.*))"
  108. matrix_media_repo_container_labels_traefik_admin_rule: "Host(`{{ matrix_server_fqn_matrix }}`) && PathRegexp(`{{ matrix_media_repo_container_labels_traefik_admin_path_regexp }}`)"
  109. matrix_media_repo_container_labels_traefik_admin_priority: 0
  110. matrix_media_repo_container_labels_traefik_admin_entrypoints: "{{ matrix_media_repo_container_labels_traefik_entrypoints }}"
  111. matrix_media_repo_container_labels_traefik_admin_tls: "{{ matrix_media_repo_container_labels_traefik_admin_entrypoints != 'web' }}"
  112. matrix_media_repo_container_labels_traefik_admin_tls_certResolver: default # noqa var-naming
  113. # Traefik labels handling some additional routes on the Client-API (web-secure) entrypoint:
  114. # - /_matrix/client/unstable/io.t2bot.media
  115. matrix_media_repo_container_labels_traefik_t2bot_enabled: true
  116. matrix_media_repo_container_labels_traefik_t2bot_path_prefix: "/_matrix/client/unstable/io.t2bot.media"
  117. matrix_media_repo_container_labels_traefik_t2bot_rule: "Host(`{{ matrix_server_fqn_matrix }}`) && PathPrefix(`{{ matrix_media_repo_container_labels_traefik_t2bot_path_prefix }}`)"
  118. matrix_media_repo_container_labels_traefik_t2bot_priority: 0
  119. matrix_media_repo_container_labels_traefik_t2bot_entrypoints: "{{ matrix_media_repo_container_labels_traefik_entrypoints }}"
  120. matrix_media_repo_container_labels_traefik_t2bot_tls: "{{ matrix_media_repo_container_labels_traefik_t2bot_entrypoints != 'web' }}"
  121. matrix_media_repo_container_labels_traefik_t2bot_tls_certResolver: default # noqa var-naming
  122. # Controls whether labels will be added that expose the media repo metrics endpoint
  123. matrix_media_repo_container_labels_traefik_metrics_enabled: "{{ matrix_media_repo_metrics_enabled and matrix_media_repo_metrics_proxying_enabled }}"
  124. matrix_media_repo_container_labels_traefik_metrics_rule: "Host(`{{ matrix_media_repo_metrics_proxying_hostname }}`) && PathPrefix(`{{ matrix_media_repo_metrics_proxying_path }}`)"
  125. matrix_media_repo_container_labels_traefik_metrics_priority: 0
  126. matrix_media_repo_container_labels_traefik_metrics_entrypoints: "{{ matrix_media_repo_container_labels_traefik_entrypoints }}"
  127. matrix_media_repo_container_labels_traefik_metrics_tls: "{{ matrix_media_repo_container_labels_traefik_t2bot_entrypoints != 'web' }}"
  128. matrix_media_repo_container_labels_traefik_metrics_tls_certResolver: default # noqa var-naming
  129. matrix_media_repo_container_labels_traefik_metrics_middleware_basic_auth_enabled: false
  130. # See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
  131. matrix_media_repo_container_labels_traefik_metrics_middleware_basic_auth_users: ''
  132. # Traefik labels handling the old `/_matrix/media` endpoints on the federation entrypint.
  133. # These are being superseded by `/_matrix/federation/VERSION/media` endpoints - see `matrix_media_repo_container_labels_traefik_federation_matrix_federation_media_*`.
  134. matrix_media_repo_container_labels_traefik_media_federation_enabled: true
  135. matrix_media_repo_container_labels_traefik_media_federation_path_prefix: "/_matrix/media"
  136. matrix_media_repo_container_labels_traefik_media_federation_rule: "Host(`{{ matrix_server_fqn_matrix }}`) && PathPrefix(`{{ matrix_media_repo_container_labels_traefik_media_path_prefix }}`)"
  137. matrix_media_repo_container_labels_traefik_media_federation_priority: 0
  138. matrix_media_repo_container_labels_traefik_media_federation_entrypoints: "{{ matrix_federation_traefik_entrypoint_name }}"
  139. matrix_media_repo_container_labels_traefik_media_federation_tls: "{{ matrix_media_repo_container_labels_traefik_media_entrypoints != 'web' }}"
  140. matrix_media_repo_container_labels_traefik_media_federation_tls_certResolver: default # noqa var-naming
  141. # Traefik labels handling the new `/_matrix/federation/VERSION/media` endpoints on the federation entrypint.
  142. # See: https://github.com/matrix-org/matrix-spec-proposals/pull/3916
  143. matrix_media_repo_container_labels_traefik_federation_matrix_federation_media_enabled: true
  144. matrix_media_repo_container_labels_traefik_federation_matrix_federation_media_path_regexp: "/_matrix/federation/(?P<version>(v1))/media"
  145. matrix_media_repo_container_labels_traefik_federation_matrix_federation_media_rule: "Host(`{{ matrix_server_fqn_matrix }}`) && PathRegexp(`{{ matrix_media_repo_container_labels_traefik_federation_matrix_federation_media_path_regexp }}`)"
  146. matrix_media_repo_container_labels_traefik_federation_matrix_federation_media_priority: 0
  147. matrix_media_repo_container_labels_traefik_federation_matrix_federation_media_entrypoints: "{{ matrix_federation_traefik_entrypoint_name }}"
  148. matrix_media_repo_container_labels_traefik_federation_matrix_federation_media_tls: "{{ matrix_media_repo_container_labels_traefik_federation_matrix_federation_media_entrypoints != 'web' }}"
  149. matrix_media_repo_container_labels_traefik_federation_matrix_federation_media_tls_certResolver: default # noqa var-naming
  150. # Traefik labels handling some additional routes on the federation entrypoint:
  151. # - /_matrix/client/r0/logout
  152. # - /_matrix/client/r0/logout/all
  153. matrix_media_repo_container_labels_traefik_logout_federation_enabled: true
  154. matrix_media_repo_container_labels_traefik_logout_federation_path_regexp: "{{ matrix_media_repo_container_labels_traefik_logout_path_regexp }}"
  155. matrix_media_repo_container_labels_traefik_logout_federation_rule: "Host(`{{ matrix_server_fqn_matrix }}`) && PathRegexp(`{{ matrix_media_repo_container_labels_traefik_logout_federation_path_regexp }}`)"
  156. matrix_media_repo_container_labels_traefik_logout_federation_priority: 0
  157. matrix_media_repo_container_labels_traefik_logout_federation_entrypoints: "{{ matrix_federation_traefik_entrypoint_name }}"
  158. matrix_media_repo_container_labels_traefik_logout_federation_tls: "{{ matrix_media_repo_container_labels_traefik_logout_entrypoints != 'web' }}"
  159. matrix_media_repo_container_labels_traefik_logout_federation_tls_certResolver: default # noqa var-naming
  160. # Traefik labels handling some additional routes on the federation entrypoint:
  161. # - /_matrix/client/r0/admin/purge_media_cache
  162. # - /_matrix/client/r0/admin/quarantine_media/{roomId:[^/]+}
  163. matrix_media_repo_container_labels_traefik_admin_federation_enabled: true
  164. matrix_media_repo_container_labels_traefik_admin_federation_path_regexp: "{{ matrix_media_repo_container_labels_traefik_admin_path_regexp }}"
  165. matrix_media_repo_container_labels_traefik_admin_federation_rule: "Host(`{{ matrix_server_fqn_matrix }}`) && PathRegexp(`{{ matrix_media_repo_container_labels_traefik_admin_federation_path_regexp }}`)"
  166. matrix_media_repo_container_labels_traefik_admin_federation_priority: 0
  167. matrix_media_repo_container_labels_traefik_admin_federation_entrypoints: "{{ matrix_federation_traefik_entrypoint_name }}"
  168. matrix_media_repo_container_labels_traefik_admin_federation_tls: "{{ matrix_media_repo_container_labels_traefik_admin_entrypoints != 'web' }}"
  169. matrix_media_repo_container_labels_traefik_admin_federation_tls_certResolver: default # noqa var-naming
  170. # Traefik labels handling some additional routes on the federation entrypoint:
  171. # - /_matrix/client/unstable/io.t2bot.media
  172. matrix_media_repo_container_labels_traefik_t2bot_federation_enabled: true
  173. matrix_media_repo_container_labels_traefik_t2bot_federation_path_prefix: "/_matrix/client/unstable/io.t2bot.media"
  174. matrix_media_repo_container_labels_traefik_t2bot_federation_rule: "Host(`{{ matrix_server_fqn_matrix }}`) && PathPrefix(`{{ matrix_media_repo_container_labels_traefik_t2bot_path_prefix }}`)"
  175. matrix_media_repo_container_labels_traefik_t2bot_federation_priority: 0
  176. matrix_media_repo_container_labels_traefik_t2bot_federation_entrypoints: "{{ matrix_federation_traefik_entrypoint_name }}"
  177. matrix_media_repo_container_labels_traefik_t2bot_federation_tls: "{{ matrix_media_repo_container_labels_traefik_t2bot_entrypoints != 'web' }}"
  178. matrix_media_repo_container_labels_traefik_t2bot_federation_tls_certResolver: default # noqa var-naming
  179. # Controls which additional headers to attach to all HTTP requests.
  180. # To add your own headers, use `matrix_media_repo_container_labels_traefik_additional_request_headers_custom`
  181. matrix_media_repo_container_labels_traefik_additional_request_headers: "{{ matrix_media_repo_container_labels_traefik_additional_request_headers_auto | combine(matrix_media_repo_container_labels_traefik_additional_request_headers_custom) }}"
  182. matrix_media_repo_container_labels_traefik_additional_request_headers_auto: |
  183. {{
  184. {}
  185. | combine ({'X-Forwarded-Host': matrix_domain} if matrix_domain else {})
  186. }}
  187. matrix_media_repo_container_labels_traefik_additional_request_headers_custom: {}
  188. # matrix_media_repo_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
  189. # See `../templates/labels.j2` for details.
  190. #
  191. # Example:
  192. # matrix_media_repo_container_labels_additional_labels: |
  193. # my.label=1
  194. # another.label="here"
  195. matrix_media_repo_container_labels_additional_labels: ''
  196. # matrix_media_repo_dashboard_urls contains a list of URLs with Grafana dashboard definitions.
  197. # If the Grafana role is enabled, these dashboards will be downloaded.
  198. matrix_media_repo_dashboard_urls:
  199. - https://raw.githubusercontent.com/spantaleev/matrix-docker-ansible-deploy/master/roles/custom/matrix-media-repo/templates/grafana/media-repo.json
  200. # *****************************************************************************
  201. # Configuration File Settings
  202. # *****************************************************************************
  203. # General repo configuration
  204. matrix_media_repo_bind_address: '0.0.0.0'
  205. matrix_media_repo_port: 8000
  206. # Where to store the logs, relative to where the repo is started from. Logs will be automatically
  207. # rotated every day and held for 14 days. To disable the repo logging to files, set this to
  208. # "-" (including quotation marks).
  209. #
  210. # Note: to change the log directory you'll have to restart the repository. This setting cannot be
  211. # live reloaded.
  212. matrix_media_repo_log_directory: "-"
  213. # Set to true to enable color coding in your logs. Note that this may cause escape sequences to
  214. # appear in logs which render them unreadable, which is why colors are disabled by default.
  215. matrix_media_repo_log_colors: false
  216. # Set to true to enable JSON logging for consumption by things like logstash. Note that this is
  217. # incompatible with the log color option and will always render without colors.
  218. matrix_media_repo_json_logs: false
  219. # The log level to log at. Note that this will need to be at least "info" to receive support.
  220. #
  221. # Values (in increasing spam): panic | fatal | error | warn | info | debug | trace
  222. matrix_media_repo_log_level: "info"
  223. # If true, the media repo will accept any X-Forwarded-For header without validation. In most cases
  224. # this option should be left as "false". Note that the media repo already expects an X-Forwarded-For
  225. # header, but validates it to ensure the IP being given makes sense.
  226. matrix_media_repo_trust_any_forwarded_address: false
  227. # If false, the media repo will not use the X-Forwarded-Host header commonly added by reverse proxies.
  228. # Typically this should remain as true, though in some circumstances it may need to be disabled.
  229. # See https://github.com/turt2live/matrix-media-repo/issues/202 for more information.
  230. matrix_media_repo_use_forwarded_host: true
  231. # Options for dealing with federation
  232. # On a per-host basis, the number of consecutive failures in calling the host before the
  233. # media repo will back off. This defaults to 20 if not given. Note that 404 errors from
  234. # the remote server do not count towards this.
  235. matrix_media_repo_federation_backoff_at: 20
  236. # The domains the media repo should never serve media for. Existing media already stored from
  237. # these domains will remain, however will not be downloadable without a data export. Media
  238. # repo administrators will bypass this check. Admin APIs will still work for media on these
  239. # domains.
  240. #
  241. # This will not prevent the listed domains from accessing media on this media repo - it only
  242. # stops users on *this* media repo from accessing media originally uploaded to the listed domains.
  243. #
  244. # Note: Adding domains controlled by the media repo itself to this list is not advisable.
  245. # matrix_media_repo_federation_ignored_hosts: [
  246. # "example.org"
  247. # ]
  248. matrix_media_repo_federation_ignored_hosts: []
  249. # The database configuration for the media repository
  250. # Do NOT put your homeserver's existing database credentials here. Create a new database and
  251. # user instead. Using the same server is fine, just not the same username and database.
  252. matrix_media_repo_database_username: "matrix_media_repo"
  253. matrix_media_repo_database_password: ""
  254. matrix_media_repo_database_hostname: ""
  255. matrix_media_repo_database_port: 5432
  256. matrix_media_repo_database_name: "matrix_media_repo"
  257. matrix_media_repo_database_sslmode: disable
  258. # Currently only "postgres" is supported.
  259. matrix_media_repo_database_postgres: "postgres://{{ matrix_media_repo_database_username }}:{{ matrix_media_repo_database_password }}@{{ matrix_media_repo_database_hostname }}:{{ matrix_media_repo_database_port }}/{{ matrix_media_repo_database_name }}?sslmode={{ matrix_media_repo_database_sslmode }}"
  260. # The database pooling options
  261. # The maximum number of connects to hold open. More of these allow for more concurrent
  262. # processes to happen.
  263. matrix_media_repo_database_max_connections: 25
  264. # The maximum number of connects to leave idle. More of these reduces the time it takes
  265. # to serve requests in low-traffic scenarios.
  266. matrix_media_repo_database_max_idle_connections: 5
  267. # The configuration for the homeservers this media repository is known to control. Servers
  268. # not listed here will not be able to upload media.
  269. matrix_media_repo_homeservers: "{{ matrix_media_repo_homeservers_auto + matrix_media_repo_homeservers_additional }}"
  270. # Auto configured server setup by the playbook
  271. matrix_media_repo_homeservers_auto: []
  272. # Additional servers to be managed by MMR
  273. matrix_media_repo_homeservers_additional: []
  274. # If true, the playbook will generate a signing key when the setup role is invoked.
  275. # This is adjusted in `group_vars/matrix_servers` depending on the homeserver implementation.
  276. matrix_media_repo_generate_signing_key: false
  277. # Path where the homeserver signing key is located. Set automatically in
  278. # `group_vars/matrix_servers` depending on which homeserver is being used.
  279. matrix_media_repo_homeserver_signing_key: ""
  280. # Options for controlling how access tokens work with the media repo. It is recommended that if
  281. # you are going to use these options that the `/logout` and `/logout/all` client-server endpoints
  282. # be proxied through this process. They will also be called on the homeserver, and the response
  283. # sent straight through the client - they are simply used to invalidate the cache faster for
  284. # a particular user. Without these, the access tokens might still work for a short period of time
  285. # after the user has already invalidated them.
  286. #
  287. # This will also cache errors from the homeserver.
  288. #
  289. # Note that when this config block is used outside of a per-domain config, all hosts will be
  290. # subject to the same cache. This also means that application services on limited homeservers
  291. # could be authorized on the wrong domain.
  292. #
  293. # ***************************************************************************
  294. # * IT IS HIGHLY RECOMMENDED TO USE PER-DOMAIN CONFIGS WITH THIS FEATURE. *
  295. # ***************************************************************************
  296. # The maximum time a cached access token will be considered valid. Set to zero (the default)
  297. # to disable the cache and constantly hit the homeserver. This is recommended to be set to
  298. # 43200 (12 hours) on servers with the logout endpoints proxied through the media repo, and
  299. # zero for servers who do not proxy the endpoints through.
  300. matrix_media_repo_access_tokens_max_cache_time_seconds: 43200
  301. # Whether or not to use the `appservices` config option below. If disabled (the default),
  302. # the regular access token cache will be used for each user, potentially leading to high
  303. # memory usage.
  304. matrix_media_repo_access_tokens_use_local_appservice_config: false
  305. # The application services (and their namespaces) registered on the homeserver. Only used
  306. # if `useLocalAppserviceConfig` is enabled (recommended).
  307. #
  308. # Usually the appservice will provide you with these config details - they'll just need
  309. # translating from the appservice registration to here. Note that this does not require
  310. # all options from the registration, and only requires the bare minimum required to run
  311. # the media repo.
  312. # matrix_media_repo_access_tokens_appservices: [
  313. # {
  314. # id: "Name_of_appservice_for_your_reference",
  315. # asToken: "Secret_token_for_appservices_to_use",
  316. # senderUserId: "@_example_bridge:example.com",
  317. # userNamespaces: [
  318. # regex: "@_example_bridge_.+:example.com"
  319. # # A note about regexes: it is best to suffix *all* namespaces with the homeserver
  320. # # domain users are valid for, as otherwise the appservice can use any user with
  321. # # any domain name it feels like, even if that domain is not configured with the
  322. # # media repo. This will lead to inaccurate reporting in the case of the media
  323. # # repo, and potentially leading to media being considered "remote".
  324. # ]
  325. # }
  326. # ]
  327. matrix_media_repo_access_tokens_appservices: []
  328. # These users have full access to the administrative functions of the media repository.
  329. # See docs/admin.md for information on what these people can do. They must belong to one of the
  330. # configured homeservers above.
  331. # matrix_media_repo_admins: [
  332. # "@alice:example.org"
  333. # ]
  334. matrix_media_repo_admins: []
  335. # Shared secret auth is useful for applications building on top of the media repository, such
  336. # as a management interface. The `token` provided here is treated as a repository administrator
  337. # when shared secret auth is enabled: if the `token` is used in place of an access token, the'
  338. # request will be authorized. This is not limited to any particular domain, giving applications
  339. # the ability to use it on any configured hostname.
  340. # Set this to true to enable shared secret auth.
  341. matrix_media_repo_shared_secret_auth_enabled: false
  342. # Use a secure value here to prevent unauthorized access to the media repository.
  343. matrix_media_repo_shared_secret_auth_token: "PutSomeRandomSecureValueHere"
  344. # Datastores are places where media should be persisted. This isn't dedicated for just uploads:
  345. # thumbnails and other misc data is also stored in these places. The media repo, when looking
  346. # for a datastore to use, will always use the smallest datastore first.
  347. # ID for the file datastore (cannot change). Alphanumeric recommended.
  348. matrix_media_repo_datastore_file_id: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'filestore.db', rounds=655555) | to_uuid }}"
  349. # Datastores can be split into many areas when handling uploads. Media is still de-duplicated
  350. # across all datastores (local content which duplicates remote content will re-use the remote
  351. # content's location). This option is useful if your datastore is becoming very large, or if
  352. # you want faster storage for a particular kind of media.
  353. #
  354. # To disable this datastore, making it readonly, specify `forKinds: []`.
  355. #
  356. # The kinds available are:
  357. # thumbnails - Used to store thumbnails of media (local and remote).
  358. # remote_media - Original copies of remote media (servers not configured by this repo).
  359. # local_media - Original uploads for local media.
  360. # archives - Archives of content (GDPR and similar requests).
  361. matrix_media_repo_datastore_file_for_kinds: ["thumbnails", "remote_media", "local_media", "archives"]
  362. # Path to datastore, relative to matrix-media-repo directory root
  363. matrix_media_repo_datastore_opts_path: "/data/media"
  364. # ID for the s3 datastore (cannot change). Alphanumeric recommended.
  365. matrix_media_repo_datastore_s3_id: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 's3store.db', rounds=655555) | to_uuid }}"
  366. # Datastores can be split into many areas when handling uploads. Media is still de-duplicated
  367. # across all datastores (local content which duplicates remote content will re-use the remote
  368. # content's location). This option is useful if your datastore is becoming very large, or if
  369. # you want faster storage for a particular kind of media.
  370. #
  371. # To disable this datastore, making it readonly, specify `forKinds: []`.
  372. #
  373. # The kinds available are:
  374. # thumbnails - Used to store thumbnails of media (local and remote).
  375. # remote_media - Original copies of remote media (servers not configured by this repo).
  376. # local_media - Original uploads for local media.
  377. # archives - Archives of content (GDPR and similar requests).
  378. matrix_media_repo_datastore_s3_for_kinds: []
  379. # The s3 uploader needs a temporary location to buffer files to reduce memory usage on
  380. # small file uploads. If the file size is unknown, the file is written to this location
  381. # before being uploaded to s3 (then the file is deleted). If you aren't concerned about
  382. # memory usage, set this to an empty string.
  383. matrix_media_repo_datastore_s3_opts_temp_path: ""
  384. matrix_media_repo_datastore_s3_opts_endpoint: "sfo2.digitaloceanspaces.com"
  385. matrix_media_repo_datastore_s3_opts_access_key_id: ""
  386. matrix_media_repo_datastore_s3_opts_access_secret: ""
  387. matrix_media_repo_datastore_s3_opts_ssl: true
  388. matrix_media_repo_datastore_s3_opts_bucket_name: "your-media-bucket"
  389. # An optional region for where this S3 endpoint is located. Typically not needed, though
  390. # some providers will need this (like Scaleway). Uncomment to use.
  391. # matrix_media_repo_datastore_s3_opts_region: "sfo2"
  392. # An optional storage class for tuning how the media is stored at s3.
  393. # See https://aws.amazon.com/s3/storage-classes/ for details; uncomment to use.
  394. # matrix_media_repo_datastore_s3_opts_storage_class: "STANDARD"
  395. # When set, if the requesting user/server supports being redirected, and MMR is capable
  396. # of performing that redirection, they will be redirected to the given object location.
  397. # The object ID used in S3 is assumed to be the file name, and will simply be appended.
  398. # It is therefore important to include any trailing slashes or path information. For
  399. # example, an object with ID "hello/world" will get converted to "https://mycdn.example.org/hello/world".
  400. # Note that MMR may not redirect in all cases, even if the client/server requests the
  401. # capability. MMR may still be responsible for bandwidth charges incurred from going to
  402. # the bucket directly.
  403. # matrix_media_repo_datastore_s3_opts_public_base_url: "https://mycdn.example.org/"
  404. # Set to `true` to bypass any local cache when `publicBaseUrl` is set. Has no effect
  405. # when `publicBaseUrl` is unset. Defaults to false (cached media will be served by MMR
  406. # before redirection if present).
  407. matrix_media_repo_datastore_s3_opts_redirect_when_cached: true
  408. # The size of the prefix (path component) to use when storing media in S3. This can
  409. # help improve download speeds in some S3 providers. Should not be set to higher than
  410. # 16 to avoid future incompatibilities with MMR. Defaults to zero (no prefix).
  411. matrix_media_repo_datastore_s3_opts_prefix_length: 0
  412. # Options for controlling archives. Archives are exports of a particular user's content for
  413. # the purpose of GDPR or moving media to a different server.
  414. # Whether archiving is enabled or not. Default enabled.
  415. matrix_media_repo_archiving_enabled: true
  416. # If true, users can request a copy of their own data. By default, only repository administrators
  417. # can request a copy.
  418. # This includes the ability for homeserver admins to request a copy of their own server's
  419. # data, as known to the repo.
  420. matrix_media_repo_archiving_self_service: false
  421. # The number of bytes to target per archive before breaking up the files. This is independent
  422. # of any file upload limits and will require a similar amount of memory when performing an export.
  423. # The file size is also a target, not a guarantee - it is possible to have files that are smaller
  424. # or larger than the target. This is recommended to be approximately double the size of your
  425. # file upload limit, provided there is enough memory available for the demand of exporting.
  426. matrix_media_repo_archiving_target_bytes_per_part: 209715200 # 200mb default
  427. # The file upload settings for the media repository
  428. # The maximum individual file size a user can upload.
  429. matrix_media_repo_max_bytes: 104857600 # 100MB default, 0 to disable
  430. # The minimum number of bytes to let people upload. This is recommended to be non-zero to
  431. # ensure that the "cost" of running the media repo is worthwhile - small file uploads tend
  432. # to waste more CPU and database resources than small files, thus a default of 100 bytes
  433. # is applied here as an approximate break-even point.
  434. matrix_media_repo_min_bytes: 100 # 100 bytes by default
  435. # The number of bytes to claim as the maximum size for uploads for the limits API. If this
  436. # is not provided then the maxBytes setting will be used instead. This is useful to provide
  437. # if the media repo's settings and the reverse proxy do not match for maximum request size.
  438. # This is purely for informational reasons and does not actually limit any functionality.
  439. # Set this to -1 to indicate that there is no limit. Zero will force the use of maxBytes.
  440. matrix_media_repo_reported_max_bytes: 0
  441. # The number of pending uploads a user is permitted to have at a given time. They must cancel,
  442. # complete, or otherwise let pending requests expire before uploading any more media. Set to
  443. # zero to disable.
  444. matrix_media_repo_max_pending: 5
  445. # The duration the server will wait to receive media that was asynchronously uploaded before
  446. # expiring it entirely. This should be set sufficiently high for a client on poor connectivity
  447. # to upload something. The Matrix specification recommends 24 hours (86400 seconds), however
  448. # this project recommends 30 minutes (1800 seconds).
  449. matrix_media_repo_max_age_seconds: 1800
  450. # Options for limiting how much content a user can upload. Quotas are applied to content
  451. # associated with a user regardless of de-duplication. Quotas which affect remote servers
  452. # or users will not take effect. When a user exceeds their quota they will be unable to
  453. # upload any more media.
  454. # Whether quotas are enabled/enforced. Note that even when disabled the media repo will
  455. # track how much media a user has uploaded. Quotas are disabled by default.
  456. matrix_media_repo_quotas_enabled: false
  457. # The upload quota rules which affect users. The first rule to match the user ID will take
  458. # effect. If a user does not match a rule, the defaults implied by the above config will
  459. # take effect instead. The user will not be permitted to upload anything above these quota
  460. # values, but can match them exactly.
  461. matrix_media_repo_quotas_users: "{{ matrix_media_repo_quotas_users_auto + matrix_media_repo_quotas_users_additional }}"
  462. matrix_media_repo_quotas_users_auto:
  463. - glob: "@*:*" # Affect all users. Use asterisks (*) to match any character.
  464. # The maximum number of TOTAL bytes a user can upload. Defaults to zero (no limit).
  465. maxBytes: 53687063712 # 50gb
  466. # The same as maxPending above - the number of uploads the user can have waiting to
  467. # complete before starting another one. Defaults to maxPending above. Set to 0 to
  468. # disable.
  469. maxPending: 5
  470. # The maximum number of uploaded files a user can have. Defaults to zero (no limit).
  471. # If both maxBytes and maxFiles are in use then the first condition a user triggers
  472. # will prevent upload. Note that a user can still have uploads contributing to maxPending,
  473. # but will not be able to complete them if they are at maxFiles.
  474. maxFiles: 0
  475. # Additional quota glob patterns
  476. matrix_media_repo_quotas_users_additional: []
  477. # Settings related to downloading files from the media repository
  478. # The maximum number of bytes to download from other servers
  479. matrix_media_repo_downloads_max_bytes: 104857600 # 100MB default, 0 to disable
  480. # The number of workers to use when downloading remote media. Raise this number if remote
  481. # media is downloading slowly or timing out.
  482. #
  483. # Maximum memory usage = numWorkers multiplied by the maximum download size
  484. # Average memory usage is dependent on how many concurrent downloads your users are doing.
  485. matrix_media_repo_downloads_num_workers: 10
  486. # How long, in minutes, to cache errors related to downloading remote media. Once this time
  487. # has passed, the media is able to be re-requested.
  488. matrix_media_repo_downloads_failure_cache_minutes: 5
  489. # How many days after a piece of remote content is downloaded before it expires. It can be
  490. # re-downloaded on demand, this just helps free up space in your datastore. Set to zero or
  491. # negative to disable. Defaults to disabled.
  492. matrix_media_repo_downloads_expire_after_days: 0
  493. # The default size, in bytes, to return for range requests on media. Range requests are used
  494. # by clients when they only need part of a file, such as a video or audio element. Note that
  495. # the entire file will still be cached (if enabled), but only part of it will be returned.
  496. # If the client requests a larger or smaller range, that will be honoured.
  497. matrix_media_repo_downloads_default_range_chunk_size_bytes: 10485760 # 10MB default
  498. # URL Preview settings
  499. # If enabled, the preview_url routes will be accessible
  500. matrix_media_repo_url_previews_enabled: true
  501. # 10MB default, 0 to disable
  502. matrix_media_repo_url_previews_max_page_size_bytes: 10485760
  503. # If true, the media repository will try to provide previews for URLs with invalid or unsafe
  504. # certificates. If false (the default), the media repo will fail requests to said URLs.
  505. matrix_media_repo_url_previews_preview_unsafe_certificates: false
  506. # Note: URL previews are limited to a given number of words, which are then limited to a number
  507. # of characters, taking off the last word if it needs to. This also applies for the title.
  508. # The number of words to include in a preview (maximum)
  509. matrix_media_repo_url_previews_num_words: 50
  510. # The maximum number of characters for a description
  511. matrix_media_repo_url_previews_max_length: 200
  512. # The maximum number of words to include in a preview's title
  513. matrix_media_repo_url_previews_num_title_words: 30
  514. # The maximum number of characters for a title
  515. matrix_media_repo_url_previews_max_title_length: 150
  516. # The mime types to preview when OpenGraph previews cannot be rendered. OpenGraph previews are
  517. # calculated on anything matching "text/*". To have a thumbnail in the preview the URL must be
  518. # an image and the image's type must be allowed by the thumbnailer.
  519. matrix_media_repo_url_previews_file_preview_types:
  520. - "image/*"
  521. # The number of workers to use when generating url previews. Raise this number if url
  522. # previews are slow or timing out.
  523. #
  524. # Maximum memory usage = numWorkers multiplied by the maximum page size
  525. # Average memory usage is dependent on how many concurrent urls your users are previewing.
  526. matrix_media_repo_url_previews_num_workers: 10
  527. # Either allowedNetworks or disallowedNetworks must be provided. If both are provided, they
  528. # will be merged. URL previews will be disabled if neither is supplied. Each entry must be
  529. # a CIDR range.
  530. matrix_media_repo_url_previews_disallowed_networks:
  531. - "127.0.0.1/8"
  532. - "10.0.0.0/8"
  533. - "172.16.0.0/12"
  534. - "192.168.0.0/16"
  535. - "100.64.0.0/10"
  536. - "169.254.0.0/16"
  537. - '::1/128'
  538. - 'fe80::/64'
  539. - 'fc00::/7'
  540. matrix_media_repo_url_previews_allowed_networks:
  541. # "Everything". The blacklist will help limit this.
  542. # This is the default value for this field.
  543. - "0.0.0.0/0"
  544. # How many days after a preview is generated before it expires and is deleted. The preview
  545. # can be regenerated safely - this just helps free up some space in your database. Set to
  546. # zero or negative to disable. Defaults to disabled.
  547. matrix_media_repo_url_previews_expire_after_days: 0
  548. # The default Accept-Language header to supply when generating URL previews when one isn't
  549. # supplied by the client.
  550. # Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language
  551. matrix_media_repo_url_previews_default_language: "en-US,en"
  552. # Set the User-Agent header to supply when generating URL previews
  553. matrix_media_repo_url_previews_user_agent: "matrix-media-repo"
  554. # When true, oEmbed previews will be enabled. Typically these kinds of previews are used for
  555. # sites that do not support OpenGraph or page scraping, such as Twitter. For information on
  556. # specifying providers for oEmbed, including your own, see the following documentation:
  557. # https://docs.t2bot.io/matrix-media-repo/url-previews/oembed.html
  558. # Defaults to disabled.
  559. matrix_media_repo_url_previews_o_embed: false
  560. # The thumbnail configuration for the media repository.
  561. # The maximum number of bytes an image can be before the thumbnailer refuses.
  562. matrix_media_repo_thumbnails_max_source_bytes: 10485760 # 10MB default, 0 to disable
  563. # The maximum number of pixels an image can have before the thumbnailer refuses. Note that
  564. # this only applies to image types: file types like audio and video are affected solely by
  565. # the maxSourceBytes.
  566. matrix_media_repo_thumbnails_max_pixels: 32000000 # 32M default
  567. # The number of workers to use when generating thumbnails. Raise this number if thumbnails
  568. # are slow to generate or timing out.
  569. #
  570. # Maximum memory usage = numWorkers multiplied by the maximum image source size
  571. # Average memory usage is dependent on how many thumbnails are being generated by your users
  572. matrix_media_repo_thumbnails_num_workers: 100
  573. # All thumbnails are generated into one of the sizes listed here. The first size is used as
  574. # the default for when no width or height is requested. The media repository will return
  575. # either an exact match or the next largest size of thumbnail.
  576. matrix_media_repo_thumbnails_sizes:
  577. - width: 32
  578. height: 32
  579. - width: 96
  580. height: 96
  581. - width: 320
  582. height: 240
  583. - width: 640
  584. height: 480
  585. - width: 768 # This size is primarily used for audio thumbnailing.
  586. height: 240
  587. - width: 800
  588. height: 600
  589. # To allow for thumbnails to be any size, not just in the sizes specified above, set this to
  590. # true (default false). When enabled, whatever size requested by the client will be generated
  591. # up to a maximum of the largest possible dimensions in the `sizes` list. For best results,
  592. # specify only one size in the `sizes` list when this option is enabled.
  593. matrix_media_repo_thumbnails_dynamic_sizing: false
  594. # The content types to thumbnail when requested. Types that are not supported by the media repo
  595. # will not be thumbnailed (adding application/json here won't work). Clients may still not request
  596. # thumbnails for these types - this won't make clients automatically thumbnail these file types.
  597. matrix_media_repo_thumbnails_types:
  598. - "image/jpeg"
  599. - "image/jpg"
  600. - "image/png"
  601. - "image/apng"
  602. - "image/gif"
  603. - "image/heif"
  604. - "image/heic"
  605. - "image/webp"
  606. - "image/bmp"
  607. - "image/tiff"
  608. # - "image/svg+xml" # Be sure to have ImageMagick installed to thumbnail SVG files
  609. - "audio/mpeg"
  610. - "audio/ogg"
  611. - "audio/wav"
  612. - "audio/flac"
  613. # - "video/mp4" # Be sure to have ffmpeg installed to thumbnail video files
  614. # Animated thumbnails can be CPU intensive to generate. To disable the generation of animated
  615. # thumbnails, set this to false. If disabled, regular thumbnails will be returned.
  616. matrix_media_repo_thumbnails_allow_animated: true
  617. # Default to animated thumbnails, if available
  618. matrix_media_repo_thumbnails_default_animated: false
  619. # The maximum file size to thumbnail when a capable animated thumbnail is requested. If the image
  620. # is larger than this, the thumbnail will be generated as a static image.
  621. matrix_media_repo_thumbnails_max_animate_size_bytes: 10485760 # 10MB default, 0 to disable
  622. # On a scale of 0 (start of animation) to 1 (end of animation), where should the thumbnailer try
  623. # and thumbnail animated content? Defaults to 0.5 (middle of animation).
  624. matrix_media_repo_thumbnails_still_frame: 0.5
  625. # How many days after a thumbnail is generated before it expires and is deleted. The thumbnail
  626. # can be regenerated safely - this just helps free up some space in your datastores. Set to
  627. # zero or negative to disable. Defaults to disabled.
  628. matrix_media_repo_thumbnails_expire_after_days: 0
  629. # Controls for the rate limit functionality
  630. # Set this to false if rate limiting is handled at a higher level or you don't want it enabled.
  631. matrix_media_repo_rate_limit_enabled: true
  632. # The number of requests per second before an IP will be rate limited. Must be a whole number.
  633. matrix_media_repo_rate_limit_requests_per_second: 1
  634. # The number of requests an IP can send at once before the rate limit is actually considered.
  635. matrix_media_repo_rate_limit_burst: 10
  636. # The 'leaky bucket' configurations for MMR. Leaky buckets are limited in size and have a slow
  637. # drain rate, minimizing the ability for a user to consume large amounts of resources.
  638. #
  639. # Buckets are checked and applied after the requests per second configuration above. Buckets are
  640. # disabled when rate limiting is disabled.
  641. #
  642. # Note: buckets are *not* shared across processes. If download requests could end up at two different
  643. # processes, two different buckets may be filled. This behaviour may change in the future.
  644. # The download bucket applies to both download requests and thumbnail requests. Each anonymous
  645. # user is assigned a single bucket from their IP address. Authenticated requests (when supported)
  646. # will use the authenticated entity as the subject - either a user or remote server.
  647. # The maximum size of each bucket.
  648. matrix_media_repo_rate_limit_buckets_download_capacity_bytes: 524288000 # 500mb default
  649. # The number of bytes to "drain" from the bucket every minute.
  650. matrix_media_repo_rate_limit_buckets_download_drain_bytes_per_minute: 5242880 # 5mb default
  651. # The number of bytes a requester can go over the capacity, once. This is used to give some
  652. # buffer to allow a single file to be downloaded when the caller is near the limit. This
  653. # should be set to either your max remote download size or 30% of the capacityBytes, whichever
  654. # is smaller.
  655. matrix_media_repo_rate_limit_buckets_download_overflow_limit_bytes: 104857600 # 100mb default (the same as the default remote download maxBytes)
  656. # Identicons are generated avatars for a given username. Some clients use these to give users a
  657. # default avatar after signing up. Identicons are not part of the official Matrix spec, therefore
  658. # this feature is completely optional.
  659. matrix_media_repo_identicons_enabled: true
  660. # The quarantine media settings.
  661. # If true, when a thumbnail of quarantined media is requested an image will be returned. If no
  662. # image is given in the thumbnailPath below then a generated image will be provided. This does
  663. # not affect regular downloads of files.
  664. matrix_media_repo_quarantine_replace_thumbnails: true
  665. # If true, when media which has been quarantined is requested an image will be returned. If
  666. # no image is given in the thumbnailPath below then a generated image will be provided. This
  667. # will replace media which is not an image (ie: quarantining a PDF will replace the PDF with
  668. # an image).
  669. matrix_media_repo_quarantine_replace_downloads: false
  670. # If provided, the given image will be returned as a thumbnail for media that is quarantined.
  671. matrix_media_repo_quarantine_thumbnail_path: ""
  672. # If true, administrators of the configured homeservers may quarantine media for their server
  673. # only. Global administrators can quarantine any media (local or remote) regardless of this
  674. # flag.
  675. matrix_media_repo_quarantine_allow_local_admins: true
  676. # The various timeouts that the media repo will use.
  677. # The maximum amount of time the media repo should spend trying to fetch a resource that is
  678. # being previewed.
  679. matrix_media_repo_timeouts_url_preview_timeout_seconds: 10
  680. # The maximum amount of time the media repo will spend making remote requests to other repos
  681. # or homeservers. This is primarily used to download media.
  682. matrix_media_repo_timeouts_federation_timeout_seconds: 120
  683. # The maximum amount of time the media repo will spend talking to your configured homeservers.
  684. # This is usually used to verify a user's identity.
  685. matrix_media_repo_timeouts_client_server_timeout_seconds: 30
  686. # Prometheus metrics configuration
  687. # For an example Grafana dashboard, import the following JSON:
  688. # https://github.com/turt2live/matrix-media-repo/blob/master/docs/grafana.json
  689. # If true, the bindAddress and port below will serve GET /metrics for Prometheus to scrape.
  690. matrix_media_repo_metrics_enabled: false
  691. # The address to listen on. Typically "127.0.0.1" or "0.0.0.0" for all interfaces.
  692. matrix_media_repo_metrics_bind_address: "0.0.0.0"
  693. # The port to listen on. Cannot be the same as the general web server port.
  694. matrix_media_repo_metrics_port: 9000
  695. # Plugins are optional pieces of the media repo used to extend the functionality offered.
  696. # Currently there are only antispam plugins, but in future there should be more options.
  697. # Plugins are not supported on per-domain paths and are instead repo-wide. For more
  698. # information on writing plugins, please visit #matrix-media-repo:t2bot.io on Matrix.
  699. matrix_media_repo_plugins:
  700. plugins: []
  701. # An example OCR plugin to block images with certain text. Note that the Docker image
  702. # for the media repo automatically ships this at /plugins/plugin_antispam_ocr
  703. # - exec: /plugins/plugin_antispam_ocr
  704. # config:
  705. # # The URL to your OCR server (https://github.com/otiai10/ocrserver)
  706. # ocrServer: "http://localhost:8080"
  707. # # The keywords to scan for. The image must contain at least one of the keywords
  708. # # from each list to qualify for spam.
  709. # keywordGroups:
  710. # - - elon
  711. # - musk
  712. # - elonmusk
  713. # - - bitcoin
  714. # # The minimum (and maximum) sizes of images to process.
  715. # minSizeBytes: 20000
  716. # maxSizeBytes: 200000
  717. # # The types of files to process
  718. # types: ["image/png", "image/jpeg", "image/jpg"]
  719. # # The user ID regex to check against
  720. # userIds: "@telegram_.*"
  721. # # How much of the image's height, starting from the top, to consider before
  722. # # discarding the rest. Set to 1.0 to consider the whole image.
  723. # percentageOfHeight: 0.35
  724. # Options for controlling various MSCs/unstable features of the media repo
  725. # Sections of this config might disappear or be added over time. By default all
  726. # features are disabled in here and must be explicitly enabled to be used.
  727. # featureSupport:
  728. # No unstable features are currently supported.
  729. # Support for redis as a cache mechanism
  730. #
  731. # Note: Enabling Redis support will mean that the existing cache mechanism will do nothing.
  732. # It can be safely disabled once Redis support is enabled.
  733. #
  734. # See docs/redis.md for more information on how this works and how to set it up.
  735. # Whether or not use Redis instead of in-process caching.
  736. matrix_media_repo_redis_enabled: false
  737. # The database number to use. Leave at zero if using a dedicated Redis instance.
  738. matrix_media_repo_redis_database_number: 0
  739. # The Redis shards that should be used by the media repo in the ring. The names of the
  740. # shards are for your reference and have no bearing on the connection, but must be unique.
  741. matrix_media_repo_redis_shards:
  742. - name: "server1"
  743. addr: ":7000"
  744. - name: "server2"
  745. addr: ":7001"
  746. - name: "server3"
  747. addr: ":7002"
  748. # Optional sentry (https://sentry.io/) configuration for the media repo
  749. # Whether or not to set up error reporting. Defaults to off.
  750. matrix_media_repo_sentry_enabled: false
  751. # Get this value from the setup instructions in Sentry
  752. matrix_media_repo_sentry_dsn: "https://examplePublicKey@ingest.sentry.io/0"
  753. # Optional environment flag. Defaults to an empty string.
  754. matrix_media_repo_sentry_environment: ""
  755. # Whether or not to turn on sentry's built in debugging. This will increase log output.
  756. matrix_media_repo_sentry_debug: false
  757. # Configuration for the internal tasks engine in the media repo. Note that this only applies
  758. # to the media repo process with machine ID zero (the default in single-instance mode).
  759. #
  760. # Tasks include things like data imports/exports.
  761. # The number of workers to have available for tasks. Defaults to 5.
  762. matrix_media_repo_tasks_num_workers: 5
  763. # Options for collecting PGO-compatible CPU profiles and submitting them to a hosted pgo-fleet
  764. # server. See https://github.com/t2bot/pgo-fleet for collection/more detail.
  765. #
  766. # If you process more than 1Hz of requests or have more than a dozen media repos deployed, please
  767. # get in contact with `@travis:t2l.io` to submit profiles directly to MMR. Submitted profiles are
  768. # used to improve the build speed for everyone.
  769. # Whether collection is enabled. Defaults to false.
  770. matrix_media_repo_pgo_enabled: false
  771. # The pgo-fleet submit URL.
  772. matrix_media_repo_pgo_submit_url: "https://pgo-mmr.t2host.io/v1/submit"
  773. # The pgo-fleet submit key.
  774. matrix_media_repo_pgo_submit_key: "INSERT_VALUE_HERE"
  775. # Specifies whether the homeserver supports federation
  776. matrix_media_repo_homeserver_federation_enabled: true