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.
 
 
 

633 line
35 KiB

  1. # General repo configuration
  2. repo:
  3. bindAddress: {{ matrix_media_repo_bind_address | to_json }}
  4. port: {{ matrix_media_repo_port | to_json }}
  5. # Where to store the logs, relative to where the repo is started from. Logs will be automatically
  6. # rotated every day and held for 14 days. To disable the repo logging to files, set this to
  7. # "-" (including quotation marks).
  8. #
  9. # Note: to change the log directory you'll have to restart the repository. This setting cannot be
  10. # live reloaded.
  11. logDirectory: {{ matrix_media_repo_log_directory | to_json }}
  12. # Set to true to enable color coding in your logs. Note that this may cause escape sequences to
  13. # appear in logs which render them unreadable, which is why colors are disabled by default.
  14. logColors: {{ matrix_media_repo_log_colors | to_json }}
  15. # Set to true to enable JSON logging for consumption by things like logstash. Note that this is
  16. # incompatible with the log color option and will always render without colors.
  17. jsonLogs: {{ matrix_media_repo_json_logs | to_json }}
  18. # The log level to log at. Note that this will need to be at least "info" to receive support.
  19. #
  20. # Values (in increasing spam): panic | fatal | error | warn | info | debug | trace
  21. logLevel: {{ matrix_media_repo_log_level | to_json }}
  22. # If true, the media repo will accept any X-Forwarded-For header without validation. In most cases
  23. # this option should be left as "false". Note that the media repo already expects an X-Forwarded-For
  24. # header, but validates it to ensure the IP being given makes sense.
  25. trustAnyForwardedAddress: {{ matrix_media_repo_trust_any_forwarded_address | to_json }}
  26. # If false, the media repo will not use the X-Forwarded-Host header commonly added by reverse proxies.
  27. # Typically this should remain as true, though in some circumstances it may need to be disabled.
  28. # See https://github.com/turt2live/matrix-media-repo/issues/202 for more information.
  29. useForwardedHost: {{ matrix_media_repo_use_forwarded_host | to_json }}
  30. # Options for dealing with federation
  31. federation:
  32. # On a per-host basis, the number of consecutive failures in calling the host before the
  33. # media repo will back off. This defaults to 20 if not given. Note that 404 errors from
  34. # the remote server do not count towards this.
  35. backoffAt: {{ matrix_media_repo_federation_backoff_at | to_json }}
  36. # The domains the media repo should never serve media for. Existing media already stored from
  37. # these domains will remain, however will not be downloadable without a data export. Media
  38. # repo administrators will bypass this check. Admin APIs will still work for media on these
  39. # domains.
  40. #
  41. # This will not prevent the listed domains from accessing media on this media repo - it only
  42. # stops users on *this* media repo from accessing media originally uploaded to the listed domains.
  43. #
  44. # Note: Adding domains controlled by the media repo itself to this list is not advisable.
  45. {% if (matrix_media_repo_federation_ignored_hosts | length) > 0 %}
  46. ignoredHosts:
  47. {{ matrix_media_repo_federation_ignored_hosts | to_json | from_json
  48. | to_nice_yaml(indent=2, width=999999, sort_keys=false) | indent(width=4, first=true) }}
  49. {% else %}
  50. # ignoredHosts:
  51. # - example.org
  52. {% endif %}
  53. # The database configuration for the media repository
  54. # Do NOT put your homeserver's existing database credentials here. Create a new database and
  55. # user instead. Using the same server is fine, just not the same username and database.
  56. database:
  57. # Currently only "postgres" is supported.
  58. postgres: {{ matrix_media_repo_database_postgres | to_json }}
  59. # The database pooling options
  60. pool:
  61. # The maximum number of connects to hold open. More of these allow for more concurrent
  62. # processes to happen.
  63. maxConnections: {{ matrix_media_repo_database_max_connections | to_json }}
  64. # The maximum number of connects to leave idle. More of these reduces the time it takes
  65. # to serve requests in low-traffic scenarios.
  66. maxIdleConnections: {{ matrix_media_repo_database_max_idle_connections | to_json }}
  67. # The configuration for the homeservers this media repository is known to control. Servers
  68. # not listed here will not be able to upload media.
  69. #homeservers:
  70. # - # Keep the dash from this line.
  71. #
  72. # # This should match the server_name of your homeserver, and the Host header
  73. # # provided to the media repo.
  74. # name: example.org
  75. #
  76. # # The base URL to where the homeserver can actually be reached by MMR.
  77. # csApi: "https://example.org/"
  78. #
  79. # # The number of consecutive failures in calling this homeserver before the
  80. # # media repository will start backing off. This defaults to 10 if not given.
  81. # backoffAt: 10
  82. #
  83. # # The admin API interface supported by the homeserver. MMR uses a subset of the admin API
  84. # # during certain operations, like attempting to purge media from a room or validating server
  85. # # admin status. This should be set to one of "synapse", "dendrite", or "matrix". When set
  86. # # to "matrix", most functionality requiring the admin API will not work.
  87. # adminApiKind: "synapse"
  88. homeservers:
  89. {{ matrix_media_repo_homeservers | to_json | from_json
  90. | to_nice_yaml(indent=2, width=999999, sort_keys=false) | indent(width=2, first=true) }}
  91. # Options for controlling how access tokens work with the media repo. It is recommended that if
  92. # you are going to use these options that the `/logout` and `/logout/all` client-server endpoints
  93. # be proxied through this process. They will also be called on the homeserver, and the response
  94. # sent straight through the client - they are simply used to invalidate the cache faster for
  95. # a particular user. Without these, the access tokens might still work for a short period of time
  96. # after the user has already invalidated them.
  97. #
  98. # This will also cache errors from the homeserver.
  99. #
  100. # Note that when this config block is used outside of a per-domain config, all hosts will be
  101. # subject to the same cache. This also means that application services on limited homeservers
  102. # could be authorized on the wrong domain.
  103. #
  104. # ***************************************************************************
  105. # * IT IS HIGHLY RECOMMENDED TO USE PER-DOMAIN CONFIGS WITH THIS FEATURE. *
  106. # ***************************************************************************
  107. accessTokens:
  108. # The maximum time a cached access token will be considered valid. Set to zero (the default)
  109. # to disable the cache and constantly hit the homeserver. This is recommended to be set to
  110. # 43200 (12 hours) on servers with the logout endpoints proxied through the media repo, and
  111. # zero for servers who do not proxy the endpoints through.
  112. maxCacheTimeSeconds: {{ matrix_media_repo_access_tokens_max_cache_time_seconds | to_json }}
  113. # Whether or not to use the `appservices` config option below. If disabled (the default),
  114. # the regular access token cache will be used for each user, potentially leading to high
  115. # memory usage.
  116. useLocalAppserviceConfig: {{ matrix_media_repo_access_tokens_use_local_appservice_config | to_json }}
  117. # The application services (and their namespaces) registered on the homeserver. Only used
  118. # if `useLocalAppserviceConfig` is enabled (recommended).
  119. #
  120. # Usually the appservice will provide you with these config details - they'll just need
  121. # translating from the appservice registration to here. Note that this does not require
  122. # all options from the registration, and only requires the bare minimum required to run
  123. # the media repo.
  124. {% if (matrix_media_repo_access_tokens_appservices | length) > 0 %}
  125. {# `to_nice_yaml` filter unfortunately does not correctly indent arrays. The `indent` filter
  126. is a workaround fixes top-level arrays, but does not fix nested arrays. Hence the use of
  127. the `replace` filter. #}
  128. appservices:
  129. {{ matrix_media_repo_access_tokens_appservices | to_json | from_json
  130. | to_nice_yaml(indent=2, width=999999, sort_keys=false) | indent(width=4, first=true)
  131. | replace(" - ", " - ") }}
  132. {% else%}
  133. # appservices:
  134. # - id: Name_of_appservice_for_your_reference
  135. # asToken: Secret_token_for_appservices_to_use
  136. # senderUserId: "@_example_bridge:yourdomain.com"
  137. # userNamespaces:
  138. # - regex: "@_example_bridge_.+:yourdomain.com"
  139. # # A note about regexes: it is best to suffix *all* namespaces with the homeserver
  140. # # domain users are valid for, as otherwise the appservice can use any user with
  141. # # any domain name it feels like, even if that domain is not configured with the
  142. # # media repo. This will lead to inaccurate reporting in the case of the media
  143. # # repo, and potentially leading to media being considered "remote".
  144. {% endif %}
  145. # These users have full access to the administrative functions of the media repository.
  146. # See docs/admin.md for information on what these people can do. They must belong to one of the
  147. # configured homeservers above.
  148. {% if (matrix_media_repo_admins | length) > 0 %}
  149. admins:
  150. {{ matrix_media_repo_admins | to_json | from_json
  151. | to_nice_yaml(indent=2, width=999999, sort_keys=false) | indent(width=2, first=true) }}
  152. {% else %}
  153. #admins:
  154. # - "@your_username:example.org"
  155. {% endif %}
  156. # Shared secret auth is useful for applications building on top of the media repository, such
  157. # as a management interface. The `token` provided here is treated as a repository administrator
  158. # when shared secret auth is enabled: if the `token` is used in place of an access token, the'
  159. # request will be authorized. This is not limited to any particular domain, giving applications
  160. # the ability to use it on any configured hostname.
  161. sharedSecretAuth:
  162. # Set this to true to enable shared secret auth.
  163. enabled: {{ matrix_media_repo_shared_secret_auth_enabled | to_json }}
  164. # Use a secure value here to prevent unauthorized access to the media repository.
  165. token: {{ matrix_media_repo_shared_secret_auth_token | to_json }}
  166. # Datastores are places where media should be persisted. This isn't dedicated for just uploads:
  167. # thumbnails and other misc data is also stored in these places. The media repo, when looking
  168. # for a datastore to use, will always use the smallest datastore first.
  169. datastores:
  170. {% if (matrix_media_repo_datastore_file_for_kinds | length) > 0 %}
  171. - type: file
  172. # ID for this datastore (cannot change). Alphanumeric recommended.
  173. id: {{ matrix_media_repo_datastore_file_id | to_json }}
  174. # Datastores can be split into many areas when handling uploads. Media is still de-duplicated
  175. # across all datastores (local content which duplicates remote content will re-use the remote
  176. # content's location). This option is useful if your datastore is becoming very large, or if
  177. # you want faster storage for a particular kind of media.
  178. #
  179. # To disable this datastore, making it readonly, specify `forKinds: []`.
  180. #
  181. # The kinds available are:
  182. # thumbnails - Used to store thumbnails of media (local and remote).
  183. # remote_media - Original copies of remote media (servers not configured by this repo).
  184. # local_media - Original uploads for local media.
  185. # archives - Archives of content (GDPR and similar requests).
  186. forKinds: {{ matrix_media_repo_datastore_file_for_kinds | to_json }}
  187. opts:
  188. path: {{ matrix_media_repo_datastore_opts_path | to_json }}
  189. {% endif %}
  190. {% if (matrix_media_repo_datastore_s3_for_kinds | length) > 0 %}
  191. - type: s3
  192. # ID for this datastore (cannot change). Alphanumeric recommended.
  193. id: {{ matrix_media_repo_datastore_s3_id | to_json }}
  194. forKinds: {{ matrix_media_repo_datastore_s3_for_kinds | to_json }}
  195. opts:
  196. # The s3 uploader needs a temporary location to buffer files to reduce memory usage on
  197. # small file uploads. If the file size is unknown, the file is written to this location
  198. # before being uploaded to s3 (then the file is deleted). If you aren't concerned about
  199. # memory usage, set this to an empty string.
  200. tempPath: {{ matrix_media_repo_datastore_s3_opts_temp_path | to_json }}
  201. endpoint: {{ matrix_media_repo_datastore_s3_opts_endpoint | to_json }}
  202. accessKeyId: {{ matrix_media_repo_datastore_s3_opts_access_key_id | to_json }}
  203. accessSecret: {{ matrix_media_repo_datastore_s3_opts_access_secret | to_json }}
  204. ssl: {{ matrix_media_repo_datastore_s3_opts_ssl | to_json }}
  205. bucketName: {{ matrix_media_repo_datastore_s3_opts_bucket_name | to_json }}
  206. {% if matrix_media_repo_datastore_s3_opts_region is defined %}
  207. region: {{ matrix_media_repo_datastore_s3_opts_region | to_json }}
  208. {% else %}
  209. # An optional region for where this S3 endpoint is located. Typically not needed, though
  210. # some providers will need this (like Scaleway). Uncomment to use.
  211. #region: "sfo2"
  212. {% endif %}
  213. {% if matrix_media_repo_datastore_s3_opts_storage_class is defined %}
  214. storageClass: {{ matrix_media_repo_datastore_s3_opts_storage_class | to_json }}
  215. {% else %}
  216. # An optional storage class for tuning how the media is stored at s3.
  217. # See https://aws.amazon.com/s3/storage-classes/ for details; uncomment to use.
  218. #storageClass: STANDARD
  219. {% endif %}
  220. {% if matrix_media_repo_datastore_s3_opts_public_base_url is defined %}
  221. publicBaseUrl: {{ matrix_media_repo_datastore_s3_opts_public_base_url | to_json }}
  222. {% else %}
  223. # When set, if the requesting user/server supports being redirected, and MMR is capable
  224. # of performing that redirection, they will be redirected to the given object location.
  225. # The object ID used in S3 is assumed to be the file name, and will simply be appended.
  226. # It is therefore important to include any trailing slashes or path information. For
  227. # example, an object with ID "hello/world" will get converted to "https://mycdn.example.org/hello/world".
  228. # Note that MMR may not redirect in all cases, even if the client/server requests the
  229. # capability. MMR may still be responsible for bandwidth charges incurred from going to
  230. # the bucket directly.
  231. #publicBaseUrl: "https://mycdn.example.org/"
  232. {% endif %}
  233. # Set to `true` to bypass any local cache when `publicBaseUrl` is set. Has no effect
  234. # when `publicBaseUrl` is unset. Defaults to false (cached media will be served by MMR
  235. # before redirection if present).
  236. redirectWhenCached: {{ matrix_media_repo_datastore_s3_opts_redirect_when_cached | to_json }}
  237. {% endif %}
  238. # Options for controlling archives. Archives are exports of a particular user's content for
  239. # the purpose of GDPR or moving media to a different server.
  240. archiving:
  241. # Whether archiving is enabled or not. Default enabled.
  242. enabled: {{ matrix_media_repo_archiving_enabled | to_json }}
  243. # If true, users can request a copy of their own data. By default, only repository administrators
  244. # can request a copy.
  245. # This includes the ability for homeserver admins to request a copy of their own server's
  246. # data, as known to the repo.
  247. selfService: {{ matrix_media_repo_archiving_self_service | to_json }}
  248. # The number of bytes to target per archive before breaking up the files. This is independent
  249. # of any file upload limits and will require a similar amount of memory when performing an export.
  250. # The file size is also a target, not a guarantee - it is possible to have files that are smaller
  251. # or larger than the target. This is recommended to be approximately double the size of your
  252. # file upload limit, provided there is enough memory available for the demand of exporting.
  253. targetBytesPerPart: {{ matrix_media_repo_archiving_target_bytes_per_part | to_json }} # 200mb default
  254. # The file upload settings for the media repository
  255. uploads:
  256. # The maximum individual file size a user can upload.
  257. maxBytes: {{ matrix_media_repo_max_bytes | to_json }} # 100MB default, 0 to disable
  258. # The minimum number of bytes to let people upload. This is recommended to be non-zero to
  259. # ensure that the "cost" of running the media repo is worthwhile - small file uploads tend
  260. # to waste more CPU and database resources than small files, thus a default of 100 bytes
  261. # is applied here as an approximate break-even point.
  262. minBytes: {{ matrix_media_repo_min_bytes | to_json }} # 100 bytes by default
  263. # The number of bytes to claim as the maximum size for uploads for the limits API. If this
  264. # is not provided then the maxBytes setting will be used instead. This is useful to provide
  265. # if the media repo's settings and the reverse proxy do not match for maximum request size.
  266. # This is purely for informational reasons and does not actually limit any functionality.
  267. # Set this to -1 to indicate that there is no limit. Zero will force the use of maxBytes.
  268. reportedMaxBytes: {{ matrix_media_repo_reported_max_bytes | to_json }}
  269. # The number of pending uploads a user is permitted to have at a given time. They must cancel,
  270. # complete, or otherwise let pending requests expire before uploading any more media. Set to
  271. # zero to disable.
  272. maxPending: {{ matrix_media_repo_max_pending | to_json }}
  273. # The duration the server will wait to receive media that was asynchronously uploaded before
  274. # expiring it entirely. This should be set sufficiently high for a client on poor connectivity
  275. # to upload something. The Matrix specification recommends 24 hours (86400 seconds), however
  276. # this project recommends 30 minutes (1800 seconds).
  277. maxAgeSeconds: {{ matrix_media_repo_max_age_seconds | to_json }}
  278. # Options for limiting how much content a user can upload. Quotas are applied to content
  279. # associated with a user regardless of de-duplication. Quotas which affect remote servers
  280. # or users will not take effect. When a user exceeds their quota they will be unable to
  281. # upload any more media.
  282. quotas:
  283. # Whether quotas are enabled/enforced. Note that even when disabled the media repo will
  284. # track how much media a user has uploaded. Quotas are disabled by default.
  285. enabled: {{ matrix_media_repo_quotas_enabled | to_json }}
  286. # The upload quota rules which affect users. The first rule to match the user ID will take
  287. # effect. If a user does not match a rule, the defaults implied by the above config will
  288. # take effect instead. The user will not be permitted to upload anything above these quota
  289. # values, but can match them exactly.
  290. users:
  291. {{ matrix_media_repo_quotas_users | to_json | from_json
  292. | to_nice_yaml(indent=2, width=999999, sort_keys=false) | indent(width=6, first=true) }}
  293. # Settings related to downloading files from the media repository
  294. downloads:
  295. # The maximum number of bytes to download from other servers
  296. maxBytes: {{ matrix_media_repo_downloads_max_bytes | to_json }} # 100MB default, 0 to disable
  297. # The number of workers to use when downloading remote media. Raise this number if remote
  298. # media is downloading slowly or timing out.
  299. #
  300. # Maximum memory usage = numWorkers multiplied by the maximum download size
  301. # Average memory usage is dependent on how many concurrent downloads your users are doing.
  302. numWorkers: {{ matrix_media_repo_downloads_num_workers | to_json }}
  303. # How long, in minutes, to cache errors related to downloading remote media. Once this time
  304. # has passed, the media is able to be re-requested.
  305. failureCacheMinutes: {{ matrix_media_repo_downloads_failure_cache_minutes | to_json }}
  306. # How many days after a piece of remote content is downloaded before it expires. It can be
  307. # re-downloaded on demand, this just helps free up space in your datastore. Set to zero or
  308. # negative to disable. Defaults to disabled.
  309. expireAfterDays: {{ matrix_media_repo_downloads_expire_after_days | to_json }}
  310. # The default size, in bytes, to return for range requests on media. Range requests are used
  311. # by clients when they only need part of a file, such as a video or audio element. Note that
  312. # the entire file will still be cached (if enabled), but only part of it will be returned.
  313. # If the client requests a larger or smaller range, that will be honoured.
  314. defaultRangeChunkSizeBytes: {{ matrix_media_repo_downloads_default_range_chunk_size_bytes | to_json }} # 10MB default
  315. # URL Preview settings
  316. urlPreviews:
  317. # If enabled, the preview_url routes will be accessible
  318. enabled: {{ matrix_media_repo_url_previews_enabled | to_json }}
  319. # 10MB default, 0 to disable
  320. maxPageSizeBytes: {{ matrix_media_repo_url_previews_max_page_size_bytes | to_json }}
  321. # If true, the media repository will try to provide previews for URLs with invalid or unsafe
  322. # certificates. If false (the default), the media repo will fail requests to said URLs.
  323. previewUnsafeCertificates: {{ matrix_media_repo_url_previews_preview_unsafe_certificates | to_json }}
  324. # Note: URL previews are limited to a given number of words, which are then limited to a number
  325. # of characters, taking off the last word if it needs to. This also applies for the title.
  326. # The number of words to include in a preview (maximum)
  327. numWords: {{ matrix_media_repo_url_previews_num_words | to_json }}
  328. # The maximum number of characters for a description
  329. maxLength: {{ matrix_media_repo_url_previews_max_length | to_json }}
  330. # The maximum number of words to include in a preview's title
  331. numTitleWords: {{ matrix_media_repo_url_previews_num_title_words | to_json }}
  332. # The maximum number of characters for a title
  333. maxTitleLength: {{ matrix_media_repo_url_previews_max_title_length | to_json }}
  334. # The mime types to preview when OpenGraph previews cannot be rendered. OpenGraph previews are
  335. # calculated on anything matching "text/*". To have a thumbnail in the preview the URL must be
  336. # an image and the image's type must be allowed by the thumbnailer.
  337. filePreviewTypes:
  338. {{ matrix_media_repo_url_previews_file_preview_types | to_json | from_json
  339. | to_nice_yaml(indent=2, width=999999, sort_keys=false) | indent(width=4, first=true) }}
  340. # The number of workers to use when generating url previews. Raise this number if url
  341. # previews are slow or timing out.
  342. #
  343. # Maximum memory usage = numWorkers multiplied by the maximum page size
  344. # Average memory usage is dependent on how many concurrent urls your users are previewing.
  345. numWorkers: {{ matrix_media_repo_url_previews_num_workers | to_json }}
  346. # Either allowedNetworks or disallowedNetworks must be provided. If both are provided, they
  347. # will be merged. URL previews will be disabled if neither is supplied. Each entry must be
  348. # a CIDR range.
  349. disallowedNetworks:
  350. {{ matrix_media_repo_url_previews_disallowed_networks | to_json | from_json
  351. | to_nice_yaml(indent=2, width=999999, sort_keys=false) | indent(width=4, first=true) }}
  352. allowedNetworks:
  353. # "Everything". The deny list will help limit this.
  354. # This is the default value for this field.
  355. {{ matrix_media_repo_url_previews_allowed_networks | to_json | from_json
  356. | to_nice_yaml(indent=2, width=999999, sort_keys=false) | indent(width=4, first=true) }}
  357. # How many days after a preview is generated before it expires and is deleted. The preview
  358. # can be regenerated safely - this just helps free up some space in your database. Set to
  359. # zero or negative to disable. Defaults to disabled.
  360. expireAfterDays: {{ matrix_media_repo_url_previews_expire_after_days | to_json }}
  361. # The default Accept-Language header to supply when generating URL previews when one isn't
  362. # supplied by the client.
  363. # Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language
  364. defaultLanguage: {{ matrix_media_repo_url_previews_default_language | to_json }}
  365. # Set the User-Agent header to supply when generating URL previews
  366. userAgent: {{ matrix_media_repo_url_previews_user_agent | to_json }}
  367. # When true, oEmbed previews will be enabled. Typically, these kinds of previews are used for
  368. # sites that do not support OpenGraph or page scraping, such as Twitter. For information on
  369. # specifying providers for oEmbed, including your own, see the following documentation:
  370. # https://docs.t2bot.io/matrix-media-repo/url-previews/oembed.html
  371. # Defaults to disabled.
  372. oEmbed: {{ matrix_media_repo_url_previews_o_embed | to_json }}
  373. # The thumbnail configuration for the media repository.
  374. thumbnails:
  375. # The maximum number of bytes an image can be before the thumbnailer refuses.
  376. maxSourceBytes: {{ matrix_media_repo_thumbnails_max_source_bytes | to_json }} # 10MB default, 0 to disable
  377. # The maximum number of pixels an image can have before the thumbnailer refuses. Note that
  378. # this only applies to image types: file types like audio and video are affected solely by
  379. # the maxSourceBytes.
  380. maxPixels: {{ matrix_media_repo_thumbnails_max_pixels | to_json }} # 32M default
  381. # The number of workers to use when generating thumbnails. Raise this number if thumbnails
  382. # are slow to generate or timing out.
  383. #
  384. # Maximum memory usage = numWorkers multiplied by the maximum image source size
  385. # Average memory usage is dependent on how many thumbnails are being generated by your users
  386. numWorkers: {{ matrix_media_repo_thumbnails_num_workers | to_json }}
  387. # All thumbnails are generated into one of the sizes listed here. The first size is used as
  388. # the default for when no width or height is requested. The media repository will return
  389. # either an exact match or the next largest size of thumbnail.
  390. sizes:
  391. {{ matrix_media_repo_thumbnails_sizes | to_json | from_json
  392. | to_nice_yaml(indent=2, width=999999, sort_keys=false) | indent(width=4, first=true) }}
  393. # To allow for thumbnails to be any size, not just in the sizes specified above, set this to
  394. # true (default false). When enabled, whatever size requested by the client will be generated
  395. # up to a maximum of the largest possible dimensions in the `sizes` list. For best results,
  396. # specify only one size in the `sizes` list when this option is enabled.
  397. dynamicSizing: {{ matrix_media_repo_thumbnails_dynamic_sizing | to_json }}
  398. # The content types to thumbnail when requested. Types that are not supported by the media repo
  399. # will not be thumbnailed (adding application/json here won't work). Clients may still not request
  400. # thumbnails for these types - this won't make clients automatically thumbnail these file types.
  401. types:
  402. {{ matrix_media_repo_thumbnails_types | to_json | from_json
  403. | to_nice_yaml(indent=2, width=999999, sort_keys=false) | indent(width=4, first=true) }}
  404. # Animated thumbnails can be CPU intensive to generate. To disable the generation of animated
  405. # thumbnails, set this to false. If disabled, regular thumbnails will be returned.
  406. allowAnimated: {{ matrix_media_repo_thumbnails_allow_animated | to_json }}
  407. # Default to animated thumbnails, if available
  408. defaultAnimated: {{ matrix_media_repo_thumbnails_default_animated | to_json }}
  409. # The maximum file size to thumbnail when a capable animated thumbnail is requested. If the image
  410. # is larger than this, the thumbnail will be generated as a static image.
  411. maxAnimateSizeBytes: {{ matrix_media_repo_thumbnails_max_animate_size_bytes | to_json }} # 10MB default, 0 to disable
  412. # On a scale of 0 (start of animation) to 1 (end of animation), where should the thumbnailer try
  413. # and thumbnail animated content? Defaults to 0.5 (middle of animation).
  414. stillFrame: {{ matrix_media_repo_thumbnails_still_frame | to_json }}
  415. # How many days after a thumbnail is generated before it expires and is deleted. The thumbnail
  416. # can be regenerated safely - this just helps free up some space in your datastores. Set to
  417. # zero or negative to disable. Defaults to disabled.
  418. expireAfterDays: {{ matrix_media_repo_thumbnails_expire_after_days | to_json }}
  419. # Controls for the rate limit functionality
  420. rateLimit:
  421. # Set this to false if rate limiting is handled at a higher level or you don't want it enabled.
  422. enabled: {{ matrix_media_repo_rate_limit_enabled | to_json }}
  423. # The number of requests per second before an IP will be rate limited. Must be a whole number.
  424. requestsPerSecond: {{ matrix_media_repo_rate_limit_requests_per_second | to_json }}
  425. # The number of requests an IP can send at once before the rate limit is actually considered.
  426. burst: {{ matrix_media_repo_rate_limit_burst | to_json }}
  427. # Identicons are generated avatars for a given username. Some clients use these to give users a
  428. # default avatar after signing up. Identicons are not part of the official matrix spec, therefore
  429. # this feature is completely optional.
  430. identicons:
  431. enabled: {{ matrix_media_repo_identicons_enabled | to_json }}
  432. # The quarantine media settings.
  433. quarantine:
  434. # If true, when a thumbnail of quarantined media is requested an image will be returned. If no
  435. # image is given in the thumbnailPath below then a generated image will be provided. This does
  436. # not affect regular downloads of files.
  437. replaceThumbnails: {{ matrix_media_repo_quarantine_replace_thumbnails | to_json }}
  438. # If true, when media which has been quarantined is requested an image will be returned. If
  439. # no image is given in the thumbnailPath below then a generated image will be provided. This
  440. # will replace media which is not an image (ie: quarantining a PDF will replace the PDF with
  441. # an image).
  442. replaceDownloads: {{ matrix_media_repo_quarantine_replace_downloads | to_json }}
  443. # If provided, the given image will be returned as a thumbnail for media that is quarantined.
  444. #thumbnailPath: "/path/to/thumbnail.png"
  445. thumbnailPath: {{ "" if matrix_media_repo_quarantine_thumbnail_path == "" else matrix_media_repo_quarantine_thumbnail_path | to_json }}
  446. # If true, administrators of the configured homeservers may quarantine media for their server
  447. # only. Global administrators can quarantine any media (local or remote) regardless of this
  448. # flag.
  449. allowLocalAdmins: {{ matrix_media_repo_quarantine_allow_local_admins | to_json }}
  450. # The various timeouts that the media repo will use.
  451. timeouts:
  452. # The maximum amount of time the media repo should spend trying to fetch a resource that is
  453. # being previewed.
  454. urlPreviewTimeoutSeconds: {{ matrix_media_repo_timeouts_url_preview_timeout_seconds | to_json }}
  455. # The maximum amount of time the media repo will spend making remote requests to other repos
  456. # or homeservers. This is primarily used to download media.
  457. federationTimeoutSeconds: {{ matrix_media_repo_timeouts_federation_timeout_seconds | to_json }}
  458. # The maximum amount of time the media repo will spend talking to your configured homeservers.
  459. # This is usually used to verify a user's identity.
  460. clientServerTimeoutSeconds: {{ matrix_media_repo_timeouts_client_server_timeout_seconds | to_json }}
  461. # Prometheus metrics configuration
  462. # For an example Grafana dashboard, import the following JSON:
  463. # https://github.com/turt2live/matrix-media-repo/blob/master/docs/grafana.json
  464. metrics:
  465. # If true, the bindAddress and port below will serve GET /metrics for Prometheus to scrape.
  466. enabled: {{ matrix_media_repo_metrics_enabled | to_json }}
  467. # The address to listen on. Typically "127.0.0.1" or "0.0.0.0" for all interfaces.
  468. bindAddress: {{ matrix_media_repo_metrics_bind_address | to_json }}
  469. # The port to listen on. Cannot be the same as the general web server port.
  470. port: {{ matrix_media_repo_metrics_port | to_json }}
  471. # Plugins are optional pieces of the media repo used to extend the functionality offered.
  472. # Currently there are only antispam plugins, but in future there should be more options.
  473. # Plugins are not supported on per-domain paths and are instead repo-wide. For more
  474. # information on writing plugins, please visit #matrix-media-repo:t2bot.io on Matrix.
  475. # An example OCR plugin to block images with certain text. Note that the Docker image
  476. # for the media repo automatically ships this at /plugins/plugin_antispam_ocr
  477. # - exec: /plugins/plugin_antispam_ocr
  478. # config:
  479. # # The URL to your OCR server (https://github.com/otiai10/ocrserver)
  480. # ocrServer: "http://localhost:8080"
  481. # # The keywords to scan for. The image must contain at least one of the keywords
  482. # # from each list to qualify for spam.
  483. # keywordGroups:
  484. # - - elon
  485. # - musk
  486. # - elonmusk
  487. # - - bitcoin
  488. # # The minimum (and maximum) sizes of images to process.
  489. # minSizeBytes: 20000
  490. # maxSizeBytes: 200000
  491. # # The types of files to process
  492. # types: ["image/png", "image/jpeg", "image/jpg"]
  493. # # The user ID regex to check against
  494. # userIds: "@telegram_.*"
  495. # # How much of the image's height, starting from the top, to consider before
  496. # # discarding the rest. Set to 1.0 to consider the whole image.
  497. # percentageOfHeight: 0.35
  498. {{ matrix_media_repo_plugins | to_json | from_json | to_nice_yaml(indent=2, width=999999, sort_keys=false) }}
  499. # Options for controlling various MSCs/unstable features of the media repo
  500. # Sections of this config might disappear or be added over time. By default all
  501. # features are disabled in here and must be explicitly enabled to be used.
  502. # featureSupport:
  503. # No unstable features are currently supported.
  504. # Support for redis as a cache mechanism
  505. #
  506. # Note: Enabling Redis support will mean that the existing cache mechanism will do nothing.
  507. # It can be safely disabled once Redis support is enabled.
  508. #
  509. # See docs/redis.md for more information on how this works and how to set it up.
  510. redis:
  511. # Whether or not use Redis instead of in-process caching.
  512. enabled: {{ matrix_media_repo_redis_enabled | to_json }}
  513. # The database number to use. Leave at zero if using a dedicated Redis instance.
  514. databaseNumber: {{ matrix_media_repo_redis_database_number | to_json }}
  515. # The Redis shards that should be used by the media repo in the ring. The names of the
  516. # shards are for your reference and have no bearing on the connection, but must be unique.
  517. shards:
  518. {{ matrix_media_repo_redis_shards | to_json | from_json
  519. | to_nice_yaml(indent=2, width=999999, sort_keys=false) | indent(width=4, first=true) }}
  520. # Optional sentry (https://sentry.io/) configuration for the media repo
  521. sentry:
  522. # Whether or not to set up error reporting. Defaults to off.
  523. enabled: {{ matrix_media_repo_sentry_enabled | to_json }}
  524. # Get this value from the setup instructions in Sentry
  525. dsn: {{ matrix_media_repo_sentry_dsn | to_json }}
  526. # Optional environment flag. Defaults to an empty string.
  527. environment: {{ "" if matrix_media_repo_sentry_environment == "" else matrix_media_repo_sentry_environment | to_json }}
  528. # Whether or not to turn on sentry's built in debugging. This will increase log output.
  529. debug: {{ matrix_media_repo_sentry_debug | to_json }}
  530. # Configuration for the internal tasks engine in the media repo. Note that this only applies
  531. # to the media repo process with machine ID zero (the default in single-instance mode).
  532. #
  533. # Tasks include things like data imports/exports.
  534. tasks:
  535. # The number of workers to have available for tasks. Defaults to 5.
  536. numWorkers: {{ matrix_media_repo_tasks_num_workers | to_json }}
  537. # Options for collecting PGO-compatible CPU profiles and submitting them to a hosted pgo-fleet
  538. # server. See https://github.com/t2bot/pgo-fleet for collection/more detail.
  539. #
  540. # If you process more than 1Hz of requests or have more than a dozen media repos deployed, please
  541. # get in contact with `@travis:t2l.io` to submit profiles directly to MMR. Submitted profiles are
  542. # used to improve the build speed for everyone.
  543. pgo:
  544. # Whether collection is enabled. Defaults to false.
  545. enabled: {{ matrix_media_repo_pgo_enabled | to_json }}
  546. # The pgo-fleet submit URL.
  547. submitUrl: {{ matrix_media_repo_pgo_submit_url | to_json }}
  548. # The pgo-fleet submit key.
  549. submitKey: {{ matrix_media_repo_pgo_submit_key | to_json }}