mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2026-10-20 21:34:15 +00:00
Slavi PantaleevandClaude Opus 5.5
bff3f54d53
Containers are created with `--rm`, so Docker removes them asynchronously after they stop. The pre-start `docker rm` returns immediately while that removal is still in progress (its error is suppressed), and the following `docker create --name` can fail with "The container name ... is already in use". This is easy to hit since systemd_service_manager switched its default restart mode to `all-at-once`: many containers stop and start at the same time and Docker falls behind on removals. The playbook then fails at "Restart systemd services needing restart at once", even though the services recover on their own (`Restart=always`) a little later. The external roles (MASH, devture) were hardened against this in 2026-03 (see mother-of-all-self-hosting/ansible-role-valkey@0ba79c0), but the roles in `roles/custom` never were. This ports the same bounded cleanup loop to them: stop, force-remove, and wait until Docker releases the name, failing explicitly after a timeout. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
589 lines
33 KiB
YAML
589 lines
33 KiB
YAML
# SPDX-FileCopyrightText: 2019 - 2020 Lee Verberne
|
|
# SPDX-FileCopyrightText: 2019 - 2022 MDAD project contributors
|
|
# SPDX-FileCopyrightText: 2019 - 2025 Slavi Pantaleev
|
|
# SPDX-FileCopyrightText: 2019 Aaron Raimist
|
|
# SPDX-FileCopyrightText: 2019 Alexander Acevedo
|
|
# SPDX-FileCopyrightText: 2019 Dan Arnfield
|
|
# SPDX-FileCopyrightText: 2019 Hugues Morisset
|
|
# SPDX-FileCopyrightText: 2019 Lyubomir Popov
|
|
# SPDX-FileCopyrightText: 2019 Sylvia van Os
|
|
# SPDX-FileCopyrightText: 2020 John Goerzen
|
|
# SPDX-FileCopyrightText: 2021 - 2026 Thom Wiggers
|
|
# SPDX-FileCopyrightText: 2021 Ahmad Haghighi
|
|
# SPDX-FileCopyrightText: 2021 Joseph Walton-Rivers
|
|
# SPDX-FileCopyrightText: 2021 Panagiotis Georgiadis
|
|
# SPDX-FileCopyrightText: 2021 Sebastian Gumprich
|
|
# SPDX-FileCopyrightText: 2022 Marko Weltzer
|
|
# SPDX-FileCopyrightText: 2022 Nikita Chernyi
|
|
# SPDX-FileCopyrightText: 2023 Samuel Meenzen
|
|
#
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
---
|
|
# Matrix Appservice IRC is a Matrix <-> IRC bridge
|
|
# Project source code URL: https://github.com/matrix-org/matrix-appservice-irc
|
|
|
|
matrix_bridge_appservice_irc_enabled: true
|
|
|
|
matrix_bridge_appservice_irc_container_image_self_build: false
|
|
matrix_bridge_appservice_irc_container_repo: "https://github.com/matrix-org/matrix-appservice-irc.git"
|
|
matrix_bridge_appservice_irc_container_repo_version: "{{ 'master' if matrix_bridge_appservice_irc_version == 'latest' else matrix_bridge_appservice_irc_version }}"
|
|
matrix_bridge_appservice_irc_container_src_files_path: "{{ matrix_base_data_path }}/appservice-irc/docker-src"
|
|
|
|
# matrix_bridge_appservice_irc_version used to contain the full Docker image tag (e.g. `release-X.X.X`).
|
|
# It's a bare version number now. We try to somewhat retain compatibility below.
|
|
# renovate: datasource=docker depName=docker.io/matrixdotorg/matrix-appservice-irc
|
|
matrix_bridge_appservice_irc_version: 4.0.0
|
|
matrix_bridge_appservice_irc_container_image: "{{ matrix_bridge_appservice_irc_container_image_registry_prefix }}matrixdotorg/matrix-appservice-irc:{{ matrix_bridge_appservice_irc_container_image_tag }}"
|
|
matrix_bridge_appservice_irc_container_image_registry_prefix: "{{ 'localhost/' if matrix_bridge_appservice_irc_container_image_self_build else matrix_bridge_appservice_irc_container_image_registry_prefix_upstream }}"
|
|
matrix_bridge_appservice_irc_container_image_registry_prefix_upstream: "{{ matrix_bridge_appservice_irc_container_image_registry_prefix_upstream_default }}"
|
|
matrix_bridge_appservice_irc_container_image_registry_prefix_upstream_default: docker.io/
|
|
matrix_bridge_appservice_irc_container_image_tag: "{{ 'latest' if matrix_bridge_appservice_irc_version == 'latest' else ('release-' + matrix_bridge_appservice_irc_version) }}"
|
|
|
|
matrix_bridge_appservice_irc_base_path: "{{ matrix_base_data_path }}/appservice-irc"
|
|
matrix_bridge_appservice_irc_config_path: "{{ matrix_bridge_appservice_irc_base_path }}/config"
|
|
matrix_bridge_appservice_irc_data_path: "{{ matrix_bridge_appservice_irc_base_path }}/data"
|
|
|
|
matrix_bridge_appservice_irc_homeserver_url: ""
|
|
matrix_bridge_appservice_irc_homeserver_domain: '{{ matrix_domain }}'
|
|
|
|
# ircService.mediaProxy configuration for serving publicly accessible URLs to authenticated Matrix media
|
|
matrix_bridge_appservice_irc_ircService_mediaProxy_bindPort: 11111 # noqa var-naming
|
|
matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_scheme: https # noqa var-naming
|
|
matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_hostname: '{{ matrix_server_fqn_matrix }}' # noqa var-naming
|
|
matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix: '/irc/' # noqa var-naming
|
|
matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl: "{{ matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_scheme }}://{{ matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_hostname }}{{ matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix }}" # noqa var-naming
|
|
|
|
matrix_bridge_appservice_irc_homeserver_enablePresence: true # noqa var-naming
|
|
matrix_bridge_appservice_irc_appservice_address: 'http://matrix-appservice-irc:9999'
|
|
|
|
matrix_bridge_appservice_irc_database_engine: nedb
|
|
matrix_bridge_appservice_irc_database_username: matrix_appservice_irc
|
|
matrix_bridge_appservice_irc_database_password: 'some-password'
|
|
matrix_bridge_appservice_irc_database_hostname: ''
|
|
matrix_bridge_appservice_irc_database_port: 5432
|
|
matrix_bridge_appservice_irc_database_name: matrix_appservice_irc
|
|
matrix_bridge_appservice_irc_database_sslmode: disable
|
|
|
|
# The name of the container network to use when importing a NeDB database into Postgres.
|
|
# For Postgres not working in a container, this can be left empty.
|
|
matrix_bridge_appservice_irc_database_container_network: ''
|
|
|
|
# This is just the Postgres connection string, if Postgres is used.
|
|
# Naming clashes with `matrix_bridge_appservice_irc_database_connectionString` somewhat.
|
|
matrix_bridge_appservice_irc_database_connection_string: 'postgresql://{{ matrix_bridge_appservice_irc_database_username }}:{{ matrix_bridge_appservice_irc_database_password }}@{{ matrix_bridge_appservice_irc_database_hostname }}:{{ matrix_bridge_appservice_irc_database_port }}/{{ matrix_bridge_appservice_irc_database_name }}?sslmode={{ matrix_bridge_appservice_irc_database_sslmode }}'
|
|
|
|
# This is what actually goes into `database.connectionString` for the bridge.
|
|
matrix_bridge_appservice_irc_database_connectionString: |- # noqa var-naming
|
|
{{
|
|
{
|
|
'nedb': 'nedb:///data',
|
|
'postgres': matrix_bridge_appservice_irc_database_connection_string,
|
|
}[matrix_bridge_appservice_irc_database_engine]
|
|
}}
|
|
|
|
matrix_bridge_appservice_irc_ircService_servers: [] # noqa var-naming
|
|
|
|
# Example of `matrix_bridge_appservice_irc_ircService_servers` with one server (and all its options):
|
|
#
|
|
# matrix_bridge_appservice_irc_ircService_servers:
|
|
# # 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.
|
|
# # 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.
|
|
# name: "ExampleNet"
|
|
# # Additional addresses to connect to, used for load balancing between IRCDs.
|
|
# additionalAddresses: [ "irc2.example.com" ]
|
|
# # Typically additionalAddresses would be in addition to the address key given above,
|
|
# # but some configurations wish to exclusively use additional addresses while reserving
|
|
# # the top key for identification purposes. Set this to true to exclusively use the
|
|
# # additionalAddresses array when connecting to servers.
|
|
# onlyAdditionalAddresses: false
|
|
# #
|
|
# # [DEPRECATED] Use `name`, above, instead.
|
|
# # A human-readable description string
|
|
# # description: "Example.com IRC network"
|
|
#
|
|
# # An ID for uniquely identifying this server amongst other servers being bridged.
|
|
# # networkId: "example"
|
|
#
|
|
# # MXC URL to an icon used as the network icon whenever this network appear in
|
|
# # a network list. (Like in the Element room directory, for instance.)
|
|
# # icon: mxc://matrix.org/LpsSLrbANVrEIEOgEaVteItf
|
|
#
|
|
# # The port to connect to. Optional.
|
|
# port: 6697
|
|
# # Whether to use SSL or not. Default: false.
|
|
# ssl: true
|
|
# # Whether or not IRC server is using a self-signed cert or not providing CA Chain
|
|
# sslselfsign: false
|
|
# # Should the connection attempt to identify via SASL (if a server or user password is given)
|
|
# # If false, this will use PASS instead. If SASL fails, we do not fallback to PASS.
|
|
# sasl: false
|
|
# # Whether to allow expired certs when connecting to the IRC server.
|
|
# # Usually this should be off. Default: false.
|
|
# allowExpiredCerts: false
|
|
#
|
|
# # Set additional TLS options for the connections to the IRC server.
|
|
# #tlsOptions:
|
|
# # A specific CA to trust instead of the default CAs. Optional.
|
|
# #ca: |
|
|
# # -----BEGIN CERTIFICATE-----
|
|
# # ...
|
|
# # -----END CERTIFICATE-----
|
|
# # Server name for the SNI (Server Name Indication) TLS extension. If the address you
|
|
# # are using does not report the correct certificate name, you can override it here.
|
|
# # servername: real.server.name
|
|
# # ...or any options in https://nodejs.org/api/tls.html#tls_tls_connect_options_callback
|
|
#
|
|
# #
|
|
# # The connection password to send for all clients as a PASS (or SASL, if enabled above) command. Optional.
|
|
# # password: 'pa$$w0rd'
|
|
# #
|
|
# # Whether or not to send connection/error notices to real Matrix users. Default: true.
|
|
# sendConnectionMessages: true
|
|
#
|
|
# quitDebounce:
|
|
# # Whether parts due to net-splits are debounced for delayMs, to allow
|
|
# # time for the netsplit to resolve itself. A netsplit is detected as being
|
|
# # a QUIT rate higher than quitsPerSecond. Default: false.
|
|
# enabled: false
|
|
# # The maximum number of quits per second acceptable above which a netsplit is
|
|
# # considered ongoing. Default: 5.
|
|
# quitsPerSecond: 5
|
|
# # The time window in which to wait before bridging a QUIT to Matrix that occurred during
|
|
# # a netsplit. Debouncing is jittered randomly between delayMinMs and delayMaxMs so that the HS
|
|
# # is not sent many requests to leave rooms all at once if a netsplit occurs and many
|
|
# # people to not rejoin.
|
|
# # If the user with the same IRC nick as the one who sent the quit rejoins a channel
|
|
# # they are considered back online and the quit is not bridged, so long as the rejoin
|
|
# # occurs before the randomly-jittered timeout is not reached.
|
|
# # Default: 3600000, = 1h
|
|
# delayMinMs: 3600000 # 1h
|
|
# # Default: 7200000, = 2h
|
|
# delayMaxMs: 7200000 # 2h
|
|
#
|
|
# # A map for conversion of IRC user modes to Matrix power levels. This enables bridging
|
|
# # of IRC ops to Matrix power levels only, it does not enable the reverse. If a user has
|
|
# # been given multiple modes, the one that maps to the highest power level will be used.
|
|
# modePowerMap:
|
|
# o: 50
|
|
# v: 1
|
|
# botConfig:
|
|
# # Enable the presence of the bot in IRC channels. The bot serves as the entity
|
|
# # which maps from IRC -> Matrix. You can disable the bot entirely which
|
|
# # means IRC -> Matrix chat will be shared by active "M-Nick" connections
|
|
# # in the room. If there are no users in the room (or if there are users
|
|
# # but their connections are not on IRC) then nothing will be bridged to
|
|
# # Matrix. If you're concerned about the bot being treated as a "logger"
|
|
# # entity, then you may want to disable the bot. If you want IRC->Matrix
|
|
# # but don't want to have TCP connections to IRC unless a Matrix user speaks
|
|
# # (because your client connection limit is low), then you may want to keep
|
|
# # the bot enabled. Default: true.
|
|
# # NB: If the bot is disabled, you SHOULD have matrix-to-IRC syncing turned
|
|
# # on, else there will be no users and no bot in a channel (meaning no
|
|
# # messages to Matrix!) until a Matrix user speaks which makes a client
|
|
# # join the target IRC channel.
|
|
# # NBB: The bridge bot IRC client will still join the target IRC network so
|
|
# # it can service bridge-specific queries from the IRC-side e.g. so
|
|
# # real IRC clients have a way to change their Matrix display name.
|
|
# # See https://github.com/matrix-org/matrix-appservice-irc/issues/55
|
|
# enabled: true
|
|
# # The nickname to give the AS bot.
|
|
# nick: "MatrixBot"
|
|
# # The username to give to the AS bot. Defaults to "matrixbot"
|
|
# username: "matrixbot"
|
|
# # The password to give to NickServ or IRC Server for this nick. Optional.
|
|
# # password: "helloworld"
|
|
# #
|
|
# # 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.
|
|
# # Default: true
|
|
# joinChannelsIfNoUsers: true
|
|
#
|
|
# # Configuration for PMs / private 1:1 communications between users.
|
|
# privateMessages:
|
|
# # Enable the ability for PMs to be sent to/from IRC/Matrix.
|
|
# # Default: true.
|
|
# enabled: true
|
|
# # Prevent Matrix users from sending PMs to the following IRC nicks.
|
|
# # Optional. Default: [].
|
|
# # exclude: ["Alice", "Bob"] # NOT YET IMPLEMENTED
|
|
#
|
|
# # Should created Matrix PM rooms be federated? If false, only users on the
|
|
# # HS attached to this AS will be able to interact with this room.
|
|
# # Optional. Default: true.
|
|
# federate: true
|
|
#
|
|
# # Configuration for mappings not explicitly listed in the 'mappings'
|
|
# # section.
|
|
# dynamicChannels:
|
|
# # Enable the ability for Matrix users to join *any* channel on this IRC
|
|
# # network.
|
|
# # Default: false.
|
|
# enabled: true
|
|
# # Should the AS create a room alias for the new Matrix room? The form of
|
|
# # the alias can be modified via 'aliasTemplate'. Default: true.
|
|
# createAlias: true
|
|
# # Should the AS publish the new Matrix room to the public room list so
|
|
# # anyone can see it? Default: true.
|
|
# published: true
|
|
# # Publish the rooms to the homeserver directory, as oppose to the appservice
|
|
# # room directory. Only used if `published` is on.
|
|
# # Default: false
|
|
# useHomeserverDirectory: true
|
|
# # What should the join_rule be for the new Matrix room? If 'public',
|
|
# # anyone can join the room. If 'invite', only users with an invite can
|
|
# # join the room. Note that if an IRC channel has +k or +i set on it,
|
|
# # join_rules will be set to 'invite' until these modes are removed.
|
|
# # Default: "public".
|
|
# joinRule: public
|
|
# # Should created Matrix rooms be federated? If false, only users on the
|
|
# # HS attached to this AS will be able to interact with this room.
|
|
# # Default: true.
|
|
# federate: true
|
|
# # Force this room version when creating IRC channels. Beware if the homeserver doesn't
|
|
# # support the room version then the request will fail. By default, no version is requested.
|
|
# # roomVersion: "1"
|
|
# # The room alias template to apply when creating new aliases. This only
|
|
# # applies if createAlias is 'true'. The following variables are exposed:
|
|
# # $SERVER => The IRC server address (e.g. "irc.example.com")
|
|
# # $CHANNEL => The IRC channel (e.g. "#python")
|
|
# # This MUST have $CHANNEL somewhere in it.
|
|
# #
|
|
# # In certain circumstances you might want to bridge your whole IRC network as a
|
|
# # homeserver (e.g. #matrix:libera.chat). For these use cases, you can set the
|
|
# # template to just be $CHANNEL. Doing so will preclude you from supporting
|
|
# # other prefix characters though.
|
|
# #
|
|
# # Default: '#irc_$SERVER_$CHANNEL'
|
|
# aliasTemplate: "#irc_$CHANNEL"
|
|
# # A list of user IDs which the AS bot will send invites to in response
|
|
# # to a !join. Only applies if joinRule is 'invite'. Default: []
|
|
# # whitelist:
|
|
# # - "@foo:example.com"
|
|
# # - "@bar:example.com"
|
|
# #
|
|
# # Prevent the given list of channels from being mapped under any
|
|
# # circumstances.
|
|
# # exclude: ["#foo", "#bar"]
|
|
#
|
|
# # excludedUsers:
|
|
# # - regex: "@.*:evilcorp.com"
|
|
# # kickReason: "We don't like Evilcorp"
|
|
#
|
|
# # Configuration for controlling how Matrix and IRC membership lists are
|
|
# # synced.
|
|
# membershipLists:
|
|
# # Enable the syncing of membership lists between IRC and Matrix. This
|
|
# # can have a significant effect on performance on startup as the lists are
|
|
# # synced. This must be enabled for anything else in this section to take
|
|
# # effect. Default: false.
|
|
# enabled: false
|
|
#
|
|
# # Syncing membership lists at startup can result in hundreds of members to
|
|
# # process all at once. This timer drip feeds membership entries at the
|
|
# # specified rate. Default: 10000. (10s)
|
|
# floodDelayMs: 10000
|
|
#
|
|
# global:
|
|
# ircToMatrix:
|
|
# # Get a snapshot of all real IRC users on a channel (via NAMES) and
|
|
# # join their virtual Matrix clients to the room.
|
|
# initial: false
|
|
# # Make virtual Matrix clients join and leave rooms as their real IRC
|
|
# # counterparts join/part channels. Default: false.
|
|
# incremental: false
|
|
# # Should the bridge check if all Matrix users are connected to IRC and
|
|
# # joined to the channel before relaying messages into the room.
|
|
# #
|
|
# # This is considered a safety net to avoid any leakages by the bridge to
|
|
# # unconnected users, but given it ignores all IRC messages while users
|
|
# # are still connecting it may be overkill.
|
|
# requireMatrixJoined: false
|
|
#
|
|
# matrixToIrc:
|
|
# # Get a snapshot of all real Matrix users in the room and join all of
|
|
# # them to the mapped IRC channel on startup. Default: false.
|
|
# initial: false
|
|
# # Make virtual IRC clients join and leave channels as their real Matrix
|
|
# # counterparts join/leave rooms. Make sure your 'maxClients' value is
|
|
# # high enough! Default: false.
|
|
# incremental: false
|
|
#
|
|
# # Apply specific rules to Matrix rooms. Only matrix-to-IRC takes effect.
|
|
# rooms:
|
|
# - room: "!qporfwt:localhost"
|
|
# matrixToIrc:
|
|
# initial: false
|
|
# incremental: false
|
|
#
|
|
# # Apply specific rules to IRC channels. Only IRC-to-matrix takes effect.
|
|
# channels:
|
|
# - channel: "#foo"
|
|
# ircToMatrix:
|
|
# initial: false
|
|
# incremental: false
|
|
# requireMatrixJoined: false
|
|
#
|
|
# # Should the bridge ignore users which are not considered active on the bridge
|
|
# # during startup
|
|
# ignoreIdleUsersOnStartup:
|
|
# enabled: true
|
|
# # How many hours can a user be considered idle for before they are considered
|
|
# # ignoreable
|
|
# idleForHours: 720
|
|
# # A regex which will exclude matching MXIDs from this check.
|
|
# exclude: "foobar"
|
|
#
|
|
# 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 room ID in a "settings" page for the room.
|
|
# "#thepub":
|
|
# roomIds: ["!qporfwt:localhost"]
|
|
# # 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
|
|
# # 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
|
|
# # MUST start with an @ and 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
|
|
# # $NICK somewhere in it if it is specified. Can also use $SERVER to
|
|
# # insert the IRC domain.
|
|
# # Optional. Default: "$NICK". Example: "Alice"
|
|
# displayName: "$NICK"
|
|
# # Number of tries a client can attempt to join a room before the request
|
|
# # is discarded. You can also use -1 to never retry or 0 to never give up.
|
|
# # Optional. Default: -1
|
|
# joinAttempts: -1
|
|
#
|
|
# # Configuration for virtual IRC users. The following variables are exposed:
|
|
# # $LOCALPART => The user ID localpart ("alice" in @alice:localhost)
|
|
# # $USERID => The user ID
|
|
# # $DISPLAY => The display name of this user, with excluded characters
|
|
# # (e.g. space) removed. If the user has no display name, this
|
|
# # falls back to $LOCALPART.
|
|
# ircClients:
|
|
# # The template to apply to every IRC client nick. This MUST have either
|
|
# # $DISPLAY or $USERID or $LOCALPART somewhere in it.
|
|
# # Optional. Default: "M-$DISPLAY". Example: "M-Alice".
|
|
# nickTemplate: "$DISPLAY[m]"
|
|
# # True to allow virtual IRC clients to change their nick on this server
|
|
# # by issuing !nick <server> <nick> commands to the IRC AS bot.
|
|
# # This is completely freeform: it will NOT follow the nickTemplate.
|
|
# allowNickChanges: true
|
|
# # The max number of IRC clients that will connect. If the limit is
|
|
# # reached, the client that spoke the longest time ago will be
|
|
# # disconnected and replaced.
|
|
# # Optional. Default: 30.
|
|
# maxClients: 30
|
|
# # IPv6 configuration.
|
|
# ipv6:
|
|
# # Optional. Set to true to force IPv6 for outgoing connections.
|
|
# only: false
|
|
# # Optional. The IPv6 prefix to use for generating unique addresses for each
|
|
# # connected user. If not specified, all users will connect from the same
|
|
# # (default) address. This may require additional OS-specific work to allow
|
|
# # for the node process to bind to multiple different source addresses
|
|
# # Linux kernels 4.3+ support sysctl net.ipv6.ip_nonlocal_bind=1
|
|
# # Older kernels will need IP_FREEBIND, which requires an LD_PRELOAD with the library
|
|
# # https://github.com/matrix-org/freebindfree as Node does not expose setsockopt.
|
|
# # prefix: "2001:0db8:85a3::" # modify appropriately
|
|
#
|
|
# # Optional. Define blocks of IPv6 addresses for different homeservers
|
|
# # which can be used to restrict users of those homeservers to a given
|
|
# # IP. These blocks should be considered immutable once set, as changing
|
|
# # the startFrom value will NOT adjust existing IP addresses.
|
|
# # Changing the startFrom value to a lower value may conflict with existing clients.
|
|
# # Multiple homeservers may NOT share blocks.
|
|
# blocks:
|
|
# - homeserver: another-server.org
|
|
# startFrom: '10:0000'
|
|
# #
|
|
# # 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)
|
|
# idleTimeout: 10800
|
|
# # The number of milliseconds to wait between consecutive reconnections if a
|
|
# # client gets disconnected. Setting to 0 will cause the scheduling to be
|
|
# # disabled, i.e. it will be scheduled immediately (with jitter.
|
|
# # Otherwise, the scheduling interval will be used such that one client
|
|
# # reconnect for this server will be handled every reconnectIntervalMs ms using
|
|
# # a FIFO queue.
|
|
# # Default: 5000 (5 seconds)
|
|
# reconnectIntervalMs: 5000
|
|
# # The number of concurrent reconnects if a user has been disconnected unexpectedly
|
|
# # (e.g. a netsplit). You should set this to a reasonably high number so that
|
|
# # bridges are not waiting an eternity to reconnect all its clients if
|
|
# # we see a massive number of disconnect. This is unrelated to the reconnectIntervalMs
|
|
# # setting above which is for connecting on restart of the bridge. Set to 0 to
|
|
# # immediately try to reconnect all users.
|
|
# # Default: 50
|
|
# 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
|
|
# # 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.
|
|
# lineLimit: 3
|
|
# # A list of user modes to set on every IRC client. For example, "RiG" would set
|
|
# # +R, +i and +G on every IRC connection when they have successfully connected.
|
|
# # User modes vary wildly depending on the IRC network you're connecting to,
|
|
# # so check before setting this value. Some modes may not work as intended
|
|
# # through the bridge e.g. caller ID as there is no way to /ACCEPT.
|
|
# # Default: "" (no user modes)
|
|
# # userModes: "R"
|
|
# # The format of the realname defined for users, either mxid or reverse-mxid
|
|
# realnameFormat: "mxid"
|
|
# # The minimum time to wait between connection attempts if we were disconnected
|
|
# # due to throttling.
|
|
# # pingTimeoutMs: 600000
|
|
# # The rate at which to send pings to the IRCd if the client is being quiet for a while.
|
|
# # Whilst the IRCd *should* be sending pings to us to keep the connection alive, it appears
|
|
# # that sometimes they don't get around to it and end up ping timing us out.
|
|
# # pingRateMs: 60000
|
|
# # Choose which conditions the IRC bridge should kick Matrix users for. Decisions to this from
|
|
# # defaults should be taken with care as it may dishonestly represent Matrix users on the IRC
|
|
# # network, and cause your bridge to be banned.
|
|
# kickOn:
|
|
# # Kick a Matrix user from a bridged room if they fail to join the IRC channel.
|
|
# channelJoinFailure: true
|
|
# # Kick a Matrix user from ALL rooms if they are unable to get connected to IRC.
|
|
# ircConnectionFailure: true
|
|
# # Kick a Matrix user from ALL rooms if they choose to QUIT the IRC network.
|
|
# userQuit: true
|
|
|
|
# Controls whether the matrix-appservice-irc container exposes its HTTP port (tcp/9999 in the container).
|
|
#
|
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:9999"), or empty string to not expose.
|
|
matrix_bridge_appservice_irc_container_http_host_bind_port: ''
|
|
|
|
# Controls whether the matrix-appservice-irc container exposes its media proxy HTTP port.
|
|
#
|
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:11111"), or empty string to not expose.
|
|
matrix_bridge_appservice_irc_container_media_proxy_host_bind_port: ''
|
|
|
|
matrix_bridge_appservice_irc_container_network: ""
|
|
|
|
matrix_bridge_appservice_irc_container_additional_networks: "{{ matrix_bridge_appservice_irc_container_additional_networks_auto + matrix_bridge_appservice_irc_container_additional_networks_custom }}"
|
|
matrix_bridge_appservice_irc_container_additional_networks_auto: []
|
|
matrix_bridge_appservice_irc_container_additional_networks_custom: []
|
|
|
|
# A list of extra arguments to pass to the container
|
|
matrix_bridge_appservice_irc_container_extra_arguments: []
|
|
|
|
# Controls how long the pre-start cleanup should wait for stale container-name release
|
|
# before failing startup explicitly.
|
|
matrix_bridge_appservice_irc_container_cleanup_timeout_seconds: "{{ devture_systemd_docker_base_container_cleanup_timeout_seconds }}"
|
|
|
|
# Controls the delay between pre-start cleanup retries.
|
|
matrix_bridge_appservice_irc_container_cleanup_retry_delay_seconds: "{{ devture_systemd_docker_base_container_cleanup_retry_delay_seconds }}"
|
|
|
|
# Shell command used in the systemd pre-start phase to deterministically remove a stale
|
|
# container and wait until Docker releases its name.
|
|
matrix_bridge_appservice_irc_container_cleanup_command: |
|
|
i=0;
|
|
while [ "$i" -lt {{ matrix_bridge_appservice_irc_container_cleanup_timeout_seconds }} ]; do
|
|
{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-appservice-irc >/dev/null 2>&1 || true;
|
|
{{ devture_systemd_docker_base_host_command_docker }} rm -f matrix-appservice-irc >/dev/null 2>&1 || true;
|
|
if {{ devture_systemd_docker_base_host_command_docker }} container inspect matrix-appservice-irc >/dev/null 2>&1; then
|
|
i=$((i + 1));
|
|
sleep {{ matrix_bridge_appservice_irc_container_cleanup_retry_delay_seconds }};
|
|
continue;
|
|
fi;
|
|
if {{ devture_systemd_docker_base_host_command_docker }} info >/dev/null 2>&1; then
|
|
exit 0;
|
|
fi;
|
|
echo "Failed to query Docker daemon while cleaning up matrix-appservice-irc" >&2;
|
|
exit 1;
|
|
done;
|
|
echo "Failed to remove stale container matrix-appservice-irc after {{ matrix_bridge_appservice_irc_container_cleanup_timeout_seconds }} attempts" >&2;
|
|
exit 1
|
|
|
|
# matrix_bridge_appservice_irc_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
|
|
# To inject your own other container labels, see `matrix_bridge_appservice_irc_container_labels_additional_labels`.
|
|
matrix_bridge_appservice_irc_container_labels_traefik_enabled: true
|
|
matrix_bridge_appservice_irc_container_labels_traefik_docker_network: "{{ matrix_bridge_appservice_irc_container_network }}"
|
|
matrix_bridge_appservice_irc_container_labels_traefik_entrypoints: web-secure
|
|
matrix_bridge_appservice_irc_container_labels_traefik_tls_certResolver: default # noqa var-naming
|
|
|
|
# Controls whether Traefik labels for the media proxy will be applied
|
|
matrix_bridge_appservice_irc_container_labels_media_proxy_enabled: true
|
|
# Derived from publicUrl_pathPrefix, stripping any trailing slash (unless it's just "/")
|
|
matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_path_prefix: "{{ '/' if matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix == '/' else matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix.rstrip('/') }}"
|
|
matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_rule: "Host(`{{ matrix_bridge_appservice_irc_ircService_mediaProxy_publicUrl_hostname }}`) && PathPrefix(`{{ matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_path_prefix }}`)"
|
|
matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_priority: 2000
|
|
matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_entrypoints: "{{ matrix_bridge_appservice_irc_container_labels_traefik_entrypoints }}"
|
|
matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_tls: "{{ matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_entrypoints != 'web' }}"
|
|
matrix_bridge_appservice_irc_container_labels_media_proxy_traefik_tls_certResolver: "{{ matrix_bridge_appservice_irc_container_labels_traefik_tls_certResolver }}" # noqa var-naming
|
|
|
|
# matrix-appservice-irc container additional labels
|
|
matrix_bridge_appservice_irc_container_labels_additional_labels: ''
|
|
|
|
# List of systemd services that matrix-appservice-irc.service depends on.
|
|
matrix_bridge_appservice_irc_systemd_required_services_list: "{{ matrix_bridge_appservice_irc_systemd_required_services_list_default + matrix_bridge_appservice_irc_systemd_required_services_list_auto + matrix_bridge_appservice_irc_systemd_required_services_list_custom }}"
|
|
matrix_bridge_appservice_irc_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
|
|
matrix_bridge_appservice_irc_systemd_required_services_list_auto: []
|
|
matrix_bridge_appservice_irc_systemd_required_services_list_custom: []
|
|
|
|
# List of systemd services that matrix-appservice-irc.service wants
|
|
matrix_bridge_appservice_irc_systemd_wanted_services_list: []
|
|
|
|
matrix_bridge_appservice_irc_appservice_token: ''
|
|
matrix_bridge_appservice_irc_homeserver_token: ''
|
|
|
|
matrix_bridge_appservice_irc_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
|
|
|
matrix_bridge_appservice_irc_configuration_extension_yaml: |
|
|
# Your custom YAML configuration for Appservice IRC servers goes here.
|
|
# This configuration extends the default starting configuration (`matrix_bridge_appservice_irc_configuration_yaml`).
|
|
#
|
|
# You can override individual variables from the default configuration, or introduce new ones.
|
|
#
|
|
# If you need something more special, you can take full control by
|
|
# completely redefining `matrix_bridge_appservice_irc_configuration_yaml`.
|
|
|
|
matrix_bridge_appservice_irc_configuration_extension: "{{ matrix_bridge_appservice_irc_configuration_extension_yaml | from_yaml if matrix_bridge_appservice_irc_configuration_extension_yaml | from_yaml is mapping else {} }}"
|
|
|
|
matrix_bridge_appservice_irc_configuration: "{{ matrix_bridge_appservice_irc_configuration_yaml | from_yaml | combine(matrix_bridge_appservice_irc_configuration_extension, recursive=True) }}"
|
|
|
|
# The original registration.yaml file generated by AppService IRC is merged with this config override,
|
|
# to produce the final registration.yaml file ultimately used by both the bridge and the homeserver.
|
|
#
|
|
# We do this to ensure consistency:
|
|
# - always having an up-to-date registration.yaml file (synced with the configuration file)
|
|
# - always having the same AS/HS token and appservice ID in the registration.yaml file
|
|
#
|
|
# Learn more about this in `setup_install.yml`
|
|
matrix_bridge_appservice_irc_registration_override_yaml: |
|
|
id: appservice-irc
|
|
as_token: "{{ matrix_bridge_appservice_irc_appservice_token }}"
|
|
hs_token: "{{ matrix_bridge_appservice_irc_homeserver_token }}"
|
|
|
|
matrix_bridge_appservice_irc_registration_override: "{{ matrix_bridge_appservice_irc_registration_override_yaml | from_yaml }}"
|
|
|
|
# matrix_bridge_appservice_irc_restart_necessary controls whether the service
|
|
# will be restarted (when true) or merely started (when false) by the
|
|
# systemd service manager role (when conditional restart is enabled).
|
|
#
|
|
# This value is automatically computed during installation based on whether
|
|
# any configuration files, the systemd service file, or the container image changed.
|
|
# The default of `false` means "no restart needed" — appropriate when the role's
|
|
# installation tasks haven't run (e.g., due to --tags skipping them).
|
|
matrix_bridge_appservice_irc_restart_necessary: false
|