Verified Commit ccf39d78 authored by Jan Alexander Steffens (heftig)'s avatar Jan Alexander Steffens (heftig)
Browse files

matrix: Use more consistent variable names for IRC config

parent d4449415
...@@ -43,7 +43,7 @@ homeserver: ...@@ -43,7 +43,7 @@ homeserver:
# Configuration specific to the IRC service # Configuration specific to the IRC service
ircService: ircService:
servers: servers:
{% for address, settings in vault_matrix_secrets.irc_networks.items() %} {% for address, network in vault_matrix_secrets.irc_networks.items() %}
# The address of the server to connect to. # The address of the server to connect to.
"{{ address }}": "{{ address }}":
# A human-readable short name. This is used to label IRC status rooms # A human-readable short name. This is used to label IRC status rooms
...@@ -51,7 +51,7 @@ ircService: ...@@ -51,7 +51,7 @@ ircService:
# E.g. 'ExampleNet IRC Bridge status'. # E.g. 'ExampleNet IRC Bridge status'.
# It is also used in the Third Party Lookup API as the instance `desc` # It is also used in the Third Party Lookup API as the instance `desc`
# property, where each server is an instance. # property, where each server is an instance.
name: "{{ matrix_server_name }}—{{ settings.name }}" name: "{{ matrix_server_name }}—{{ network.name }}"
additionalAddresses: [] additionalAddresses: []
# #
...@@ -67,7 +67,7 @@ ircService: ...@@ -67,7 +67,7 @@ ircService:
# icon: https://example.com/images/hash.png # icon: https://example.com/images/hash.png
# The port to connect to. Optional. # The port to connect to. Optional.
port: {{ settings.port }} port: {{ network.port }}
# Whether to use SSL or not. Default: false. # Whether to use SSL or not. Default: false.
ssl: true ssl: true
# Whether or not IRC server is using a self-signed cert or not providing CA Chain # Whether or not IRC server is using a self-signed cert or not providing CA Chain
...@@ -139,11 +139,11 @@ ircService: ...@@ -139,11 +139,11 @@ ircService:
# See https://github.com/matrix-org/matrix-appservice-irc/issues/55 # See https://github.com/matrix-org/matrix-appservice-irc/issues/55
enabled: true enabled: true
# The nickname to give the AS bot. # The nickname to give the AS bot.
nick: "{{ settings.nick }}" nick: "{{ network.nick }}"
# The username to give to the AS bot. Defaults to "matrixbot" # The username to give to the AS bot. Defaults to "matrixbot"
username: "{{ settings.username }}" username: "{{ network.username }}"
# The password to give to NickServ or IRC Server for this nick. Optional. # The password to give to NickServ or IRC Server for this nick. Optional.
password: "{{ settings.password }}" password: "{{ network.password }}"
# #
# Join channels even if there are no Matrix users on the other side of # 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 # the bridge. Set to false to prevent the bot from joining channels which have no
...@@ -189,7 +189,7 @@ ircService: ...@@ -189,7 +189,7 @@ ircService:
# This should be set to the same thing as namespaces.users.group_id in irc_registration. # This should be set to the same thing as namespaces.users.group_id in irc_registration.
# This does not alter existing rooms. # This does not alter existing rooms.
# Leaving this option empty will not set the event. # Leaving this option empty will not set the event.
groupId: "+{{ settings.name }}:{{ matrix_server_name }}" groupId: "+{{ network.name }}:{{ matrix_server_name }}"
# Should created Matrix rooms be federated? If false, only users on the # 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. # HS attached to this AS will be able to interact with this room.
# Default: true. # Default: true.
...@@ -203,7 +203,7 @@ ircService: ...@@ -203,7 +203,7 @@ ircService:
# $CHANNEL => The IRC channel (e.g. "#python") # $CHANNEL => The IRC channel (e.g. "#python")
# This MUST have $CHANNEL somewhere in it. # This MUST have $CHANNEL somewhere in it.
# Default: '#irc_$SERVER_$CHANNEL' # Default: '#irc_$SERVER_$CHANNEL'
aliasTemplate: "#{{ settings.name }}_$CHANNEL" aliasTemplate: "#{{ network.name }}_$CHANNEL"
# A list of user IDs which the AS bot will send invites to in response # 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: [] # to a !join. Only applies if joinRule is 'invite'. Default: []
# whitelist: # whitelist:
...@@ -270,10 +270,10 @@ ircService: ...@@ -270,10 +270,10 @@ ircService:
# 1:many mappings from IRC channels to room IDs on this IRC server. # 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. # the room ID in a "settings" page for the room.
{% for channel, config in settings.mappings.items() %} {% for channel, mapping in network.mappings.items() %}
"{{ channel }}": "{{ channel }}":
roomIds: ["{{ config.room }}"] roomIds: ["{{ mapping.room }}"]
key: "{{ config.key }}" key: "{{ mapping.key }}"
{% endfor %} {% endfor %}
# Configuration for virtual matrix users. The following variables are # Configuration for virtual matrix users. The following variables are
...@@ -285,7 +285,7 @@ ircService: ...@@ -285,7 +285,7 @@ ircService:
# MUST have $NICK somewhere in it. # MUST have $NICK somewhere in it.
# Optional. Default: "@$SERVER_$NICK". # Optional. Default: "@$SERVER_$NICK".
# Example: "@irc.example.com_Alice:example.com" # Example: "@irc.example.com_Alice:example.com"
userTemplate: "@{{ settings.name }}_$NICK" userTemplate: "@{{ network.name }}_$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 # $NICK somewhere in it if it is specified. Can also use $SERVER to
# insert the IRC domain. # insert the IRC domain.
...@@ -363,7 +363,7 @@ ircService: ...@@ -363,7 +363,7 @@ ircService:
# so check before setting this value. Some modes may not work as intended # 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. # through the bridge e.g. caller ID as there is no way to /ACCEPT.
# Default: "" (no user modes) # Default: "" (no user modes)
userModes: "{{ settings.user_modes }}" userModes: "{{ network.user_modes }}"
{% endfor %} {% endfor %}
# Set information about the bridged channel in the room state, so that client's may # Set information about the bridged channel in the room state, so that client's may
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment