Fix capitalization: matrix → Matrix

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara
2024-10-18 23:28:00 +09:00
parent 08a569b0e6
commit 55fcaac1f1
51 changed files with 107 additions and 108 deletions

View File

@ -1,5 +1,5 @@
homeserver:
# The Matrix server name, this will be the name of the server in your matrix ID.
# The Matrix server name, this will be the name of the server in your Matrix ID.
domain: "{{ matrix_domain }}"
# The url for the appservice to call the client server API from.
url: "{{ matrix_homeserver_url }}"

View File

@ -9,7 +9,7 @@
# Example value: example.com
matrix_domain: ~
# The optional matrix admin MXID, used in bridges' configs to set bridge admin user
# The optional Matrix admin MXID, used in bridges' configs to set bridge admin user
# Example value: "@someone:{{ matrix_domain }}"
matrix_admin: ''

View File

@ -14,7 +14,7 @@ if [ "$sure" != "Yes, I really want to remove everything!" ]; then
echo "Good thing I asked, exiting"
exit 0
else
echo "Stop and remove matrix services"
echo "Stop and remove Matrix services"
for s in $(find {{ devture_systemd_docker_base_systemd_path }}/ -type f -name "matrix-*" -printf "%f\n"); do
systemctl disable --now $s
@ -32,4 +32,3 @@ else
rm -fr "{{ matrix_base_data_path }}"
exit 0
fi

View File

@ -1,5 +1,5 @@
---
# chatgpt is a bot for chatting to openAI chatgpt matrix bot
# chatgpt is a bot for chatting to openAI chatgpt Matrix bot
# Project source code URL: https://github.com/matrixgpt/matrix-chatgpt-bot
matrix_bot_chatgpt_enabled: true

View File

@ -66,7 +66,7 @@ matrix_bot_draupnir_pantalaimon_password: ""
# Note: Draupnir is fairly verbose - expect a lot of messages from it.
matrix_bot_draupnir_management_room: ""
# Endpoint URL that Draupnir uses to interact with the matrix homeserver (client-server API).
# Endpoint URL that Draupnir uses to interact with the Matrix homeserver (client-server API).
# Set this to the pantalaimon URL if you're using that.
matrix_bot_draupnir_homeserver_url: ""

View File

@ -1,4 +1,4 @@
# Endpoint URL that Draupnir uses to interact with the matrix homeserver (client-server API),
# Endpoint URL that Draupnir uses to interact with the Matrix homeserver (client-server API),
# set this to the pantalaimon URL if you're using that.
homeserverUrl: {{ matrix_bot_draupnir_homeserver_url | to_json }}
@ -12,7 +12,7 @@ accessToken: {{ matrix_bot_draupnir_access_token | to_json }}
{% if matrix_bot_draupnir_pantalaimon_use %}
# Options related to Pantalaimon (https://github.com/matrix-org/pantalaimon)
pantalaimon:
# Whether or not Draupnir will use pantalaimon to access the matrix homeserver,
# Whether or not Draupnir will use pantalaimon to access the Matrix homeserver,
# set to `true` if you're using pantalaimon.
#
# Be sure to point homeserverUrl to the pantalaimon instance.

View File

@ -1,5 +1,5 @@
---
# matrix-registration-bot creates and manages registration tokens for a matrix server
# matrix-registration-bot creates and manages registration tokens for a Matrix server
# Project source code URL: https://github.com/moan0s/matrix-registration-bot
matrix_bot_matrix_registration_bot_enabled: true

View File

@ -57,7 +57,7 @@ matrix_bot_mjolnir_pantalaimon_password: ""
# Note: Mjolnir is fairly verbose - expect a lot of messages from it.
matrix_bot_mjolnir_management_room: ""
# Endpoint URL that Mjolnir uses to interact with the matrix homeserver (client-server API).
# Endpoint URL that Mjolnir uses to interact with the Matrix homeserver (client-server API).
# Set this to the pantalaimon URL if you're using that.
matrix_bot_mjolnir_homeserver_url: ""

View File

@ -1,4 +1,4 @@
# Endpoint URL that Mjolnir uses to interact with the matrix homeserver (client-server API),
# Endpoint URL that Mjolnir uses to interact with the Matrix homeserver (client-server API),
# set this to the pantalaimon URL if you're using that.
homeserverUrl: {{ matrix_bot_mjolnir_homeserver_url | to_json }}
@ -12,7 +12,7 @@ accessToken: {{ matrix_bot_mjolnir_access_token | to_json }}
{% if matrix_bot_mjolnir_pantalaimon_use %}
# Options related to Pantalaimon (https://github.com/matrix-org/pantalaimon)
pantalaimon:
# Whether or not Mjolnir will use pantalaimon to access the matrix homeserver,
# Whether or not Mjolnir will use pantalaimon to access the Matrix homeserver,
# set to `true` if you're using pantalaimon.
#
# Be sure to point homeserverUrl to the pantalaimon instance.

View File

@ -1,5 +1,5 @@
---
# postmoogle is an email to matrix bot
# postmoogle is an email to Matrix bot
# Project source code URL: https://github.com/etkecc/postmoogle
matrix_bot_postmoogle_enabled: true

View File

@ -61,7 +61,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming
# # The address of the server to connect to.
# irc.example.com:
# # A human-readable short name. This is used to label IRC status rooms
# # where matrix users control their connections.
# # where Matrix users control their connections.
# # E.g. 'ExampleNet IRC Bridge status'.
# # It is also used in the Third Party Lookup API as the instance `desc`
# # property, where each server is an instance.
@ -158,7 +158,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming
# #
# # Join channels even if there are no Matrix users on the other side of
# # the bridge. Set to false to prevent the bot from joining channels which have no
# # real matrix users in them, even if there is a mapping for the channel.
# # real Matrix users in them, even if there is a mapping for the channel.
# # Default: true
# joinChannelsIfNoUsers: true
@ -239,9 +239,9 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming
# global:
# ircToMatrix:
# # Get a snapshot of all real IRC users on a channel (via NAMES) and
# # join their virtual matrix clients to the room.
# # join their virtual Matrix clients to the room.
# initial: false
# # Make virtual matrix clients join and leave rooms as their real IRC
# # Make virtual Matrix clients join and leave rooms as their real IRC
# # counterparts join/part channels. Default: false.
# incremental: false
@ -270,25 +270,25 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming
# mappings:
# # 1:many mappings from IRC channels to room IDs on this IRC server.
# # The matrix room must already exist. Your matrix client should expose
# # The Matrix room must already exist. Your Matrix client should expose
# # the room ID in a "settings" page for the room.
# "#thepub":
# roomIds: ["!kieouiJuedJoxtVdaG:localhost"]
# # Channel key/password to use. Optional. If provided, matrix users do
# # Channel key/password to use. Optional. If provided, Matrix users do
# # not need to know the channel key in order to join the channel.
# # key: "secret"
# # Configuration for virtual matrix users. The following variables are
# # Configuration for virtual Matrix users. The following variables are
# # exposed:
# # $NICK => The IRC nick
# # $SERVER => The IRC server address (e.g. "irc.example.com")
# matrixClients:
# # The user ID template to use when creating virtual matrix users. This
# # The user ID template to use when creating virtual Matrix users. This
# # MUST have $NICK somewhere in it.
# # Optional. Default: "@$SERVER_$NICK".
# # Example: "@irc.example.com_Alice:example.com"
# userTemplate: "@irc_$NICK"
# # The display name to use for created matrix clients. This should have
# # The display name to use for created Matrix clients. This should have
# # $NICK somewhere in it if it is specified. Can also use $SERVER to
# # insert the IRC domain.
# # Optional. Default: "$NICK (IRC)". Example: "Alice (IRC)"
@ -333,7 +333,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming
# # The maximum amount of time in seconds that the client can exist
# # without sending another message before being disconnected. Use 0 to
# # not apply an idle timeout. This value is ignored if this IRC server is
# # mirroring matrix membership lists to IRC. Default: 172800 (48 hours)
# # mirroring Matrix membership lists to IRC. Default: 172800 (48 hours)
# idleTimeout: 10800
# # The number of millseconds to wait between consecutive reconnections if a
# # client gets disconnected. Setting to 0 will cause the scheduling to be
@ -353,7 +353,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming
# concurrentReconnectLimit: 50
# # The number of lines to allow being sent by the IRC client that has received
# # a large block of text to send from matrix. If the number of lines that would
# # be sent is > lineLimit, the text will instead be uploaded to matrix and the
# # be sent is > lineLimit, the text will instead be uploaded to Matrix and the
# # resulting URI is treated as a file. As such, a link will be sent to the IRC
# # side instead of potentially spamming IRC and getting the IRC client kicked.
# # Default: 3.

View File

@ -26,7 +26,7 @@ homeserver:
# is the "domain name" part of the HS URL.
domain: {{ matrix_appservice_irc_homeserver_domain }}
# Should presence be enabled for matrix clients on this bridge. If disabled on the
# Should presence be enabled for Matrix clients on this bridge. If disabled on the
# homeserver then it should also be disabled here to avoid excess traffic.
# Default: true
enablePresence: {{ matrix_appservice_irc_homeserver_enablePresence|to_json }}
@ -47,17 +47,17 @@ ircService:
# Config for Matrix -> IRC bridging
matrixHandler:
# Cache this many matrix events in memory to be used for m.relates_to messages (usually replies).
# Cache this many Matrix events in memory to be used for m.relates_to messages (usually replies).
eventCacheSize: 4096
servers: {{ matrix_appservice_irc_ircService_servers|to_json }}
# Configuration for an ident server. If you are running a public bridge it is
# advised you setup an ident server so IRC mods can ban specific matrix users
# advised you setup an ident server so IRC mods can ban specific Matrix users
# rather than the application service itself.
ident:
# True to listen for Ident requests and respond with the
# matrix user's user_id (converted to ASCII, respecting RFC 1413).
# Matrix user's user_id (converted to ASCII, respecting RFC 1413).
# Default: false.
enabled: false
# The port to listen on for incoming ident requests.

View File

@ -82,7 +82,7 @@
path: "{{ matrix_go_skype_bridge_base_path }}/go-skype-bridge.db"
register: matrix_go_skype_bridge_stat_database
- name: Check if an old matrix state file exists
- name: Check if an old Matrix state file exists
ansible.builtin.stat:
path: "{{ matrix_go_skype_bridge_base_path }}/mx-state.json"
register: matrix_go_skype_bridge_stat_mx_state

View File

@ -109,7 +109,7 @@ bridge:
# Number of chats to sync for new users.
# Since some of the obtained conversations are not the conversations that the user needs to see,
# the actual number of conversations displayed on the matrix client will be slightly less than the set value
# the actual number of conversations displayed on the Matrix client will be slightly less than the set value
initial_chat_sync_count: 10
# Number of old messages to fill when creating new portal rooms.
initial_history_fill_count: 20
@ -181,7 +181,7 @@ bridge:
default: {{ matrix_go_skype_bridge_bridge_encryption_default|to_json }}
puppet_id:
# when set to true, the matrixid of the contact (puppet) from the bridge to the matrix will be encrypted into another string
# when set to true, the matrixid of the contact (puppet) from the bridge to the Matrix will be encrypted into another string
allow: false
# 8 characters
key: '12dsf323'

View File

@ -82,7 +82,7 @@
path: "{{ matrix_mautrix_gmessages_base_path }}/mautrix-gmessages.db"
register: matrix_mautrix_gmessages_stat_database
- name: Check if an old matrix state file exists
- name: Check if an old Matrix state file exists
ansible.builtin.stat:
path: "{{ matrix_mautrix_gmessages_base_path }}/mx-state.json"
register: matrix_mautrix_gmessages_stat_mx_state

View File

@ -82,7 +82,7 @@
path: "{{ matrix_mautrix_signal_base_path }}/mautrix-signal.db"
register: matrix_mautrix_signal_stat_database
- name: Check if an old matrix state file exists
- name: Check if an old Matrix state file exists
ansible.builtin.stat:
path: "{{ matrix_mautrix_signal_base_path }}/mx-state.json"
register: matrix_mautrix_signal_stat_mx_state

View File

@ -82,7 +82,7 @@
path: "{{ matrix_mautrix_whatsapp_base_path }}/mautrix-whatsapp.db"
register: matrix_mautrix_whatsapp_stat_database
- name: Check if an old matrix state file exists
- name: Check if an old Matrix state file exists
ansible.builtin.stat:
path: "{{ matrix_mautrix_whatsapp_base_path }}/mx-state.json"
register: matrix_mautrix_whatsapp_stat_mx_state

View File

@ -62,7 +62,7 @@
- "{{ matrix_mautrix_wsproxy_base_path }}"
- "{{ matrix_mautrix_wsproxy_config_path }}"
- name: Check if an old matrix state file exists
- name: Check if an old Matrix state file exists
ansible.builtin.stat:
path: "{{ matrix_mautrix_wsproxy_base_path }}/mx-state.json"
register: matrix_mautrix_wsproxy_stat_mx_state

View File

@ -781,7 +781,7 @@ matrix_media_repo_rate_limit_buckets_download_drain_bytes_per_minute: 5242880 #
matrix_media_repo_rate_limit_buckets_download_overflow_limit_bytes: 104857600 # 100mb default (the same as the default remote download maxBytes)
# Identicons are generated avatars for a given username. Some clients use these to give users a
# default avatar after signing up. Identicons are not part of the official matrix spec, therefore
# default avatar after signing up. Identicons are not part of the official Matrix spec, therefore
# this feature is completely optional.
matrix_media_repo_identicons_enabled: true

View File

@ -517,7 +517,7 @@ rateLimit:
# Identicons are generated avatars for a given username. Some clients use these to give users a
# default avatar after signing up. Identicons are not part of the official matrix spec, therefore
# default avatar after signing up. Identicons are not part of the official Matrix spec, therefore
# this feature is completely optional.
identicons:
enabled: {{ matrix_media_repo_identicons_enabled | to_json }}

View File

@ -1,5 +1,5 @@
---
# E2EE aware proxy daemon for matrix clients.
# E2EE aware proxy daemon for Matrix clients.
# Project source code URL: https://github.com/matrix-org/pantalaimon
matrix_pantalaimon_enabled: true

View File

@ -1,5 +1,5 @@
---
# matrix-registration is a simple python application to have a token based matrix registration
# matrix-registration is a simple python application to have a token based Matrix registration
# See: https://zeratax.github.io/matrix-registration/
# Project source code URL: https://github.com/ZerataX/matrix-registration

View File

@ -48,7 +48,7 @@ matrix_static_files_container_labels_traefik_docker_network: "{{ matrix_static_f
matrix_static_files_container_labels_traefik_entrypoints: web-secure
matrix_static_files_container_labels_traefik_tls_certResolver: default # noqa var-naming
# Controls whether labels will be added that expose the well-known public endpoint on the matrix domain.
# Controls whether labels will be added that expose the well-known public endpoint on the Matrix domain.
matrix_static_files_container_labels_well_known_matrix_endpoint_enabled: true
matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_hostname: ''
matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_path_prefix: /.well-known/matrix
@ -234,7 +234,7 @@ matrix_static_files_file_matrix_client_configuration: "{{ matrix_static_files_fi
# If you wish to rely on DNS SRV records only, you can disable this.
# Using DNS SRV records implies that you'll be handling Matrix Federation API traffic (tcp/8448)
# using certificates for the base domain (`matrix_domain`) and not for the
# matrix domain (`matrix_server_fqn_matrix`).
# Matrix domain (`matrix_server_fqn_matrix`).
matrix_static_files_file_matrix_server_enabled: true
# Controls the m.server property in the /.well-known/matrix/server file

View File

@ -6,7 +6,7 @@
# These well-known files may be served without a `Content-Type: application/json` header,
# so we can't rely on the uri module's automatic parsing of JSON.
- name: Check .well-known on the matrix hostname
- name: Check .well-known on the Matrix hostname
ansible.builtin.uri:
url: "{{ well_known_url_matrix }}"
follow_redirects: none
@ -18,21 +18,21 @@
register: result_well_known_matrix
ignore_errors: true
- name: Fail if .well-known not working on the matrix hostname
- name: Fail if .well-known not working on the Matrix hostname
ansible.builtin.fail:
msg: "Failed checking that the well-known file for {{ well_known_file_check.purpose }} is configured at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ well_known_url_matrix }}`). Is port 443 open in your firewall? Full error: {{ result_well_known_matrix }}"
when: "result_well_known_matrix.failed"
- name: Parse JSON for well-known payload at the matrix hostname
- name: Parse JSON for well-known payload at the Matrix hostname
ansible.builtin.set_fact:
well_known_matrix_payload: "{{ result_well_known_matrix.content | from_json }}"
- name: Fail if .well-known not CORS-aware on the matrix hostname
- name: Fail if .well-known not CORS-aware on the Matrix hostname
ansible.builtin.fail:
msg: "The well-known file for {{ well_known_file_check.purpose }} on `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ well_known_url_matrix }}`) is not CORS-aware. The file needs to be served with an Access-Control-Allow-Origin header set."
when: "well_known_file_check.cors and 'access_control_allow_origin' not in result_well_known_matrix"
- name: Report working .well-known on the matrix hostname
- name: Report working .well-known on the Matrix hostname
ansible.builtin.debug:
msg: "well-known for {{ well_known_file_check.purpose }} is configured correctly for `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ well_known_url_matrix }}`)"
@ -63,7 +63,7 @@
when: "well_known_file_check.cors and 'access_control_allow_origin' not in result_well_known_identity"
# For people who manually copy the well-known file, try to detect if it's outdated
- name: Fail if well-known is different on matrix hostname and identity hostname
- name: Fail if well-known is different on Matrix hostname and identity hostname
ansible.builtin.fail:
msg: "The well-known files for {{ well_known_file_check.purpose }} at `{{ matrix_server_fqn_matrix }}` and `{{ matrix_domain }}` are different. Perhaps you copied the file ({{ well_known_file_check.path }}) manually before and now it's outdated?"
when: "well_known_matrix_payload != well_known_identity_payload"

View File

@ -11,7 +11,7 @@ traefik.http.services.{{ matrix_static_files_identifier }}.loadbalancer.server.p
{% if matrix_static_files_container_labels_well_known_matrix_endpoint_enabled %}
############################################################
# #
# Related to /.well-known/matrix on the matrix domain #
# Related to /.well-known/matrix on the Matrix domain #
# #
############################################################
@ -43,7 +43,7 @@ traefik.http.routers.{{ matrix_static_files_identifier }}-well-known.tls.certRes
############################################################
# #
# /Related to /.well-known/matrix on the matrix domain #
# /Related to /.well-known/matrix on the Matrix domain #
# #
############################################################
{% endif %}

View File

@ -1183,7 +1183,7 @@ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_invites: true
# this means that spammy messages will appear as empty to users. Default
# false.
matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_messages: false
# Remove users from the user directory search by filtering matrix IDs and
# Remove users from the user directory search by filtering Matrix IDs and
# display names by the entries in the user ban list. Default false.
matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_usernames: false
# The room IDs of the ban lists to honour. Unlike other parts of Mjolnir,

View File

@ -32,7 +32,7 @@ modules: {{ matrix_synapse_modules|to_json }}
# created on this server. For example if the server_name was example.com,
# usernames on this server would be in the format @user:example.com
#
# In most cases you should avoid using a matrix specific subdomain such as
# In most cases you should avoid using a Matrix specific subdomain such as
# matrix.example.com or synapse.example.com as the server_name for the same
# reasons you wouldn't use user@email.example.com as your email address.
# See https://matrix-org.github.io/synapse/latest/delegate.html
@ -293,7 +293,7 @@ listeners:
{% endif %}
{% if matrix_synapse_federation_port_enabled and matrix_synapse_tls_federation_listener_enabled %}
# TLS-enabled listener: for when matrix traffic is sent directly to synapse.
# TLS-enabled listener: for when Matrix traffic is sent directly to synapse.
- port: {{ matrix_synapse_container_federation_api_tls_port|to_json }}
tls: true
bind_addresses: ['::']
@ -305,7 +305,7 @@ listeners:
compress: false
{% endif %}
# Unsecure HTTP listener (Client API): for when matrix traffic passes through a reverse proxy
# Unsecure HTTP listener (Client API): for when Matrix traffic passes through a reverse proxy
# that unwraps TLS.
- port: {{ matrix_synapse_container_client_api_port|to_json }}
tls: false
@ -318,7 +318,7 @@ listeners:
compress: false
{% if matrix_synapse_federation_port_enabled %}
# Unsecure HTTP listener (Federation API): for when matrix traffic passes through a reverse proxy
# Unsecure HTTP listener (Federation API): for when Matrix traffic passes through a reverse proxy
# that unwraps TLS.
- port: {{ matrix_synapse_container_federation_api_plain_port|to_json }}
tls: false
@ -1873,7 +1873,7 @@ saml2_config:
#saml_session_lifetime: 5m
# An external module can be provided here as a custom solution to
# mapping attributes returned from a saml provider onto a matrix user.
# mapping attributes returned from a saml provider onto a Matrix user.
#
user_mapping_provider:
# The custom module's class. Uncomment to use a custom module.
@ -1896,7 +1896,7 @@ saml2_config:
#mxid_source_attribute: displayName
# The mapping system to use for mapping the saml attribute onto a
# matrix ID.
# Matrix ID.
#
# Options include:
# * 'hexencode' (which maps unpermitted characters to '=xx')
@ -2037,7 +2037,7 @@ saml2_config:
# switching from password logins to OIDC. Defaults to false.
#
# user_mapping_provider: Configuration for how attributes returned from a OIDC
# provider are mapped onto a matrix user. This setting has the following
# provider are mapped onto a Matrix user. This setting has the following
# sub-properties:
#
# module: The class name of a custom mapping module. Default is
@ -2831,7 +2831,7 @@ opentracing:
#homeserver_whitelist:
# - ".*"
# A list of the matrix IDs of users whose requests will always be traced,
# A list of the Matrix IDs of users whose requests will always be traced,
# even if the tracing system would otherwise drop the traces due to
# probabilistic sampling.
#

View File

@ -66,7 +66,7 @@ matrix_user_verification_service_uvs_auth_token: ''
# Pin UVS to only check openId Tokens for the matrix_server_name configured by this playbook.
matrix_user_verification_service_uvs_pin_openid_verify_server_name: true
# Matrix server name to verify OpenID tokens against.
# This is not the homeserverURL, but rather the domain in the matrix "user ID"
# This is not the homeserverURL, but rather the domain in the Matrix "user ID"
# UVS can also be instructed to verify against the Matrix server name passed in the token, to enable set to ""
matrix_user_verification_service_uvs_openid_verify_server_name: "{{ matrix_domain }}"

View File

@ -1,6 +1,6 @@
---
- name: Find leftover matrix scripts in /usr/local/bin
- name: Find leftover Matrix scripts in /usr/local/bin
ansible.builtin.find:
path: "/usr/local/bin"
patterns:
@ -19,7 +19,7 @@
- matrix-synapse-worker-write-pid
register: matrix_usr_local_bin_files_result
- name: Ensure /usr/local/bin does not contain matrix scripts
- name: Ensure /usr/local/bin does not contain Matrix scripts
ansible.builtin.file:
path: "{{ item.path }}"
state: absent

View File

@ -1,11 +1,11 @@
---
- name: Ensure matrix-ssl files are deleted
- name: Ensure Matrix SSL-related files are deleted
ansible.builtin.file:
path: "{{ matrix_base_data_path }}/ssl"
state: absent
- name: Ensure matrix SSL-related systemd timers and services are gone
- name: Ensure Matrix SSL-related systemd timers and services are gone
ansible.builtin.file:
path: "{{ devture_systemd_docker_base_systemd_path }}/{{ item }}"
state: absent