From 7302c83f60829032d3fda14a9527ad2229d83bd6 Mon Sep 17 00:00:00 2001 From: Alexandre Iooss Date: Sat, 9 Mar 2019 10:18:10 +0100 Subject: [PATCH 1/3] Add new container --- hosts | 1 + 1 file changed, 1 insertion(+) diff --git a/hosts b/hosts index 34cdde3..8563253 100644 --- a/hosts +++ b/hosts @@ -18,6 +18,7 @@ wiki.adm.auro.re www.adm.auro.re pad.adm.auro.re proxy.adm.auro.re +matrix-services.adm.auro.re [ovh-vm] re2o-server.adm.auro.re From d6627f5cce323a59fe9f8c36909b2f4ea2301dd3 Mon Sep 17 00:00:00 2001 From: Alexandre Iooss Date: Sun, 10 Mar 2019 11:10:59 +0100 Subject: [PATCH 2/3] Add matrix-appservice-discord --- matrix.yml | 6 ++ .../handlers/main.yml | 4 + .../tasks/0_apt_dependencies.yml | 20 +++++ .../tasks/1_user_group.yml | 26 ++++++ .../matrix-appservice-discord/tasks/main.yml | 57 +++++++++++++ .../templates/apt/nodejs.j2 | 5 ++ .../templates/config.yaml.j2 | 85 +++++++++++++++++++ .../matrix-appservice-discord.service.j2 | 18 ++++ 8 files changed, 221 insertions(+) create mode 100644 roles/matrix-appservice-discord/handlers/main.yml create mode 100644 roles/matrix-appservice-discord/tasks/0_apt_dependencies.yml create mode 100644 roles/matrix-appservice-discord/tasks/1_user_group.yml create mode 100644 roles/matrix-appservice-discord/tasks/main.yml create mode 100644 roles/matrix-appservice-discord/templates/apt/nodejs.j2 create mode 100644 roles/matrix-appservice-discord/templates/config.yaml.j2 create mode 100644 roles/matrix-appservice-discord/templates/systemd/matrix-appservice-discord.service.j2 diff --git a/matrix.yml b/matrix.yml index 1975e50..4767ca5 100644 --- a/matrix.yml +++ b/matrix.yml @@ -13,3 +13,9 @@ - hosts: riot.adm.auro.re roles: - matrix-riot + +# Install Matrix services +- hosts: matrix-services.adm.auro.re + roles: + - debian-backports + - matrix-appservice-discord diff --git a/roles/matrix-appservice-discord/handlers/main.yml b/roles/matrix-appservice-discord/handlers/main.yml new file mode 100644 index 0000000..ac3842d --- /dev/null +++ b/roles/matrix-appservice-discord/handlers/main.yml @@ -0,0 +1,4 @@ +--- +# Reload systemd daemons when a service file changes +- name: Reload systemd daemons + command: systemctl daemon-reload diff --git a/roles/matrix-appservice-discord/tasks/0_apt_dependencies.yml b/roles/matrix-appservice-discord/tasks/0_apt_dependencies.yml new file mode 100644 index 0000000..40fbbce --- /dev/null +++ b/roles/matrix-appservice-discord/tasks/0_apt_dependencies.yml @@ -0,0 +1,20 @@ +--- +- name: Configure NodeJS pin + when: + - ansible_distribution == 'Debian' + - ansible_distribution_release == 'stretch' + template: + src: apt/nodejs.j2 + dest: /etc/apt/preferences.d/nodejs + mode: 0644 + +- name: Install required packages + apt: + name: "{{ item }}" + state: present + update_cache: true + with_items: + - git + - nodejs + - npm + - build-essential diff --git a/roles/matrix-appservice-discord/tasks/1_user_group.yml b/roles/matrix-appservice-discord/tasks/1_user_group.yml new file mode 100644 index 0000000..2fe23be --- /dev/null +++ b/roles/matrix-appservice-discord/tasks/1_user_group.yml @@ -0,0 +1,26 @@ +--- +# Security #1 +- name: Create matrix-appservice-discord system group + group: + name: matrix-appservice-discord + system: yes + state: present + +# Security #2 +- name: Create matrix-appservice-discord user + user: + name: matrix-appservice-discord + group: matrix-appservice-discord + home: /var/local/matrix-appservice-discord + comment: Matrix Appservice Discord + system: yes + state: present + +# Security #3 +- name: Secure matrix-appservice-discord home directory + file: + path: /var/local/matrix-appservice-discord + state: directory + owner: matrix-appservice-discord + group: matrix-appservice-discord + mode: 0750 diff --git a/roles/matrix-appservice-discord/tasks/main.yml b/roles/matrix-appservice-discord/tasks/main.yml new file mode 100644 index 0000000..a625a00 --- /dev/null +++ b/roles/matrix-appservice-discord/tasks/main.yml @@ -0,0 +1,57 @@ +--- +# Install APT dependencies +- include_tasks: 0_apt_dependencies.yml + +# Create CodiMD user and group +- include_tasks: 1_user_group.yml + +# Download CodiMD +- name: Clone matrix-appservice-discord project + git: + repo: https://github.com/Half-Shot/matrix-appservice-discord.git + dest: /var/local/matrix-appservice-discord/matrix-appservice-discord + version: v0.4.0 + become: true + become_user: matrix-appservice-discord + +# Setup dependencies +- name: Install matrix-appservice-discord depedencies + command: npm ci + args: + chdir: /var/local/matrix-appservice-discord/matrix-appservice-discord + become: true + become_user: matrix-appservice-discord + +# Typescript into javascript +- name: Compile matrix-appservice-discord + command: npm run build + args: + chdir: /var/local/matrix-appservice-discord/matrix-appservice-discord + become: true + become_user: matrix-appservice-discord + +# Configure +- name: Configure matrix-appservice-discord + template: + src: config.yaml.j2 + dest: /var/local/matrix-appservice-discord/matrix-appservice-discord/config.yaml + owner: matrix-appservice-discord + group: matrix-appservice-discord + mode: 0600 + +# Service file +- name: Install matrix-appservice-discord systemd unit + template: + src: 'systemd/matrix-appservice-discord.service.j2' + dest: '/etc/systemd/system/matrix-appservice-discord.service' + owner: root + group: root + mode: 0644 + notify: Reload systemd daemons + +# Run +#- name: Ensure that matrix-appservice-discord is started +# service: +# name: matrix-appservice-discord +# state: started +# enabled: true diff --git a/roles/matrix-appservice-discord/templates/apt/nodejs.j2 b/roles/matrix-appservice-discord/templates/apt/nodejs.j2 new file mode 100644 index 0000000..65e5110 --- /dev/null +++ b/roles/matrix-appservice-discord/templates/apt/nodejs.j2 @@ -0,0 +1,5 @@ +# {{ ansible_managed }} + +Package: node* libuv1* +Pin: release a=stretch-backports +Pin-Priority: 600 diff --git a/roles/matrix-appservice-discord/templates/config.yaml.j2 b/roles/matrix-appservice-discord/templates/config.yaml.j2 new file mode 100644 index 0000000..64e17dd --- /dev/null +++ b/roles/matrix-appservice-discord/templates/config.yaml.j2 @@ -0,0 +1,85 @@ +# {{ ansible_managed }} + +bridge: + # Domain part of the bridge, e.g. matrix.org + domain: "auro.re" + # This should be your publically facing URL because Discord may use it to + # fetch media from the media store. + homeserverUrl: "https://auro.re" + # Interval at which to process users in the 'presence queue'. If you have + # 5 users, one user will be processed every 500 milliseconds according to the + # value below. This has a minimum value of 250. + # WARNING: This has a high chance of spamming the homeserver with presence + # updates since it will send one each time somebody changes state or is online. + presenceInterval: 500 + # Disable setting presence for 'ghost users' which means Discord users on Matrix + # will not be shown as away or online. + disablePresence: false + # Disable sending typing notifications when somebody on Discord types. + disableTypingNotifications: false + # Disable deleting messages on Discord if a message is redacted on Matrix. + disableDeletionForwarding: false + # Enable users to bridge rooms using !discord commands. See + # https://t2bot.io/discord for instructions. + enableSelfServiceBridging: false + # Disable sending of read receipts for Matrix events which have been + # successfully bridged to Discord. + disableReadReceipts: false +# Authentication configuration for the discord bot. +auth: + clientID: "12345" + botToken: "foobar" +logging: + # What level should the logger output to the console at. + console: "warn" #silly, verbose, info, http, warn, error, silent + lineDateFormat: "MMM-D HH:mm:ss.SSS" # This is in moment.js format + files: + - file: "warn.log" # Will capture warnings + level: "warn" + - file: "botlogs.log" # Will capture logs from DiscordBot + level: "info" + enable: + - "DiscordBot" +database: + userStorePath: "user-store.db" + roomStorePath: "room-store.db" + # You may either use SQLite or Postgresql for the bridge database, which contains + # important mappings for events and user puppeting configurations. + # Use the filename option for SQLite, or connString for Postgresql. + # If you are migrating, see https://github.com/Half-Shot/matrix-appservice-discord/blob/master/docs/howto.md#migrate-to-postgres-from-sqlite + # WARNING: You will almost certainly be fine with sqlite unless your bridge + # is in heavy demand and you suffer from IO slowness. + filename: "discord.db" + # connString: "postgresql://user:password@localhost/database_name" +room: + # Set the default visibility of alias rooms, defaults to "public". + # One of: "public", "private" + defaultVisibility: "public" +channel: + # Pattern of the name given to bridged rooms. + # Can use :guild for the guild name and :name for the channel name. + namePattern: "[Discord] :guild :name" + # Changes made to rooms when a channel is deleted. + deleteOptions: + # Prefix the room name with a string. + #namePrefix: "[Deleted]" + # Prefix the room topic with a string. + #topicPrefix: "This room has been deleted" + # Disable people from talking in the room by raising the event PL to 50 + disableMessaging: false + # Remove the discord alias from the room. + unsetRoomAlias: true + # Remove the room from the directory. + unlistFromDirectory: true + # Set the room to be unavaliable for joining without an invite. + setInviteOnly: true + # Make all the discord users leave the room. + ghostsLeave: true +limits: + # Delay in milliseconds between discord users joining a room. + roomGhostJoinDelay: 6000 + # Delay in milliseconds before sending messages to discord to avoid echos. + # (Copies of a sent message may arrive from discord before we've + # fininished handling it, causing us to echo it back to the room) + discordSendDelay: 750 + diff --git a/roles/matrix-appservice-discord/templates/systemd/matrix-appservice-discord.service.j2 b/roles/matrix-appservice-discord/templates/systemd/matrix-appservice-discord.service.j2 new file mode 100644 index 0000000..afc1b4b --- /dev/null +++ b/roles/matrix-appservice-discord/templates/systemd/matrix-appservice-discord.service.j2 @@ -0,0 +1,18 @@ +# {{ ansible_managed }} + +[Unit] +Description=A bridge between Matrix and Discord +After=syslog.target network-online.target mysql.service postgresql.service +Conflicts=shutdown.target + +[Service] +Type=simple +User=matrix-appservice-discord +Group=matrix-appservice-discord +WorkingDirectory=/var/local/matrix-appservice-discord/matrix-appservice-discord +Environment="NODE_ENV=production" +ExecStart=/usr/bin/nodejs /var/local/matrix-appservice-discord/matrix-appservice-discord/app.js +Restart=always + +[Install] +WantedBy=multi-user.target From 0b887c2abbbe2ef1a4252fdfcfe0c01f12bf082e Mon Sep 17 00:00:00 2001 From: Alexandre Iooss Date: Sun, 10 Mar 2019 11:50:07 +0100 Subject: [PATCH 3/3] Add matrix-appservice-irc --- matrix.yml | 3 +- roles/matrix-appservice-irc/handlers/main.yml | 4 + .../tasks/0_apt_dependencies.yml | 20 + .../tasks/1_user_group.yml | 26 + roles/matrix-appservice-irc/tasks/main.yml | 48 ++ .../templates/apt/nodejs.j2 | 5 + .../templates/config.yaml.j2 | 443 ++++++++++++++++++ .../systemd/matrix-appservice-irc.service.j2 | 17 + 8 files changed, 565 insertions(+), 1 deletion(-) create mode 100644 roles/matrix-appservice-irc/handlers/main.yml create mode 100644 roles/matrix-appservice-irc/tasks/0_apt_dependencies.yml create mode 100644 roles/matrix-appservice-irc/tasks/1_user_group.yml create mode 100644 roles/matrix-appservice-irc/tasks/main.yml create mode 100644 roles/matrix-appservice-irc/templates/apt/nodejs.j2 create mode 100644 roles/matrix-appservice-irc/templates/config.yaml.j2 create mode 100644 roles/matrix-appservice-irc/templates/systemd/matrix-appservice-irc.service.j2 diff --git a/matrix.yml b/matrix.yml index 4767ca5..971ceab 100644 --- a/matrix.yml +++ b/matrix.yml @@ -8,6 +8,8 @@ - debian-backports - matrix-synapse - matrix-mxisd + - matrix-appservice-discord + - matrix-appservice-irc # Install Matrix Riot on corresponding containers - hosts: riot.adm.auro.re @@ -18,4 +20,3 @@ - hosts: matrix-services.adm.auro.re roles: - debian-backports - - matrix-appservice-discord diff --git a/roles/matrix-appservice-irc/handlers/main.yml b/roles/matrix-appservice-irc/handlers/main.yml new file mode 100644 index 0000000..ac3842d --- /dev/null +++ b/roles/matrix-appservice-irc/handlers/main.yml @@ -0,0 +1,4 @@ +--- +# Reload systemd daemons when a service file changes +- name: Reload systemd daemons + command: systemctl daemon-reload diff --git a/roles/matrix-appservice-irc/tasks/0_apt_dependencies.yml b/roles/matrix-appservice-irc/tasks/0_apt_dependencies.yml new file mode 100644 index 0000000..40fbbce --- /dev/null +++ b/roles/matrix-appservice-irc/tasks/0_apt_dependencies.yml @@ -0,0 +1,20 @@ +--- +- name: Configure NodeJS pin + when: + - ansible_distribution == 'Debian' + - ansible_distribution_release == 'stretch' + template: + src: apt/nodejs.j2 + dest: /etc/apt/preferences.d/nodejs + mode: 0644 + +- name: Install required packages + apt: + name: "{{ item }}" + state: present + update_cache: true + with_items: + - git + - nodejs + - npm + - build-essential diff --git a/roles/matrix-appservice-irc/tasks/1_user_group.yml b/roles/matrix-appservice-irc/tasks/1_user_group.yml new file mode 100644 index 0000000..1c5d507 --- /dev/null +++ b/roles/matrix-appservice-irc/tasks/1_user_group.yml @@ -0,0 +1,26 @@ +--- +# Security #1 +- name: Create matrix-appservice-irc system group + group: + name: matrix-appservice-irc + system: yes + state: present + +# Security #2 +- name: Create matrix-appservice-irc user + user: + name: matrix-appservice-irc + group: matrix-appservice-irc + home: /var/local/matrix-appservice-irc + comment: Matrix Appservice IRC + system: yes + state: present + +# Security #3 +- name: Secure matrix-appservice-irc home directory + file: + path: /var/local/matrix-appservice-irc + state: directory + owner: matrix-appservice-irc + group: matrix-appservice-irc + mode: 0750 diff --git a/roles/matrix-appservice-irc/tasks/main.yml b/roles/matrix-appservice-irc/tasks/main.yml new file mode 100644 index 0000000..0f03d5b --- /dev/null +++ b/roles/matrix-appservice-irc/tasks/main.yml @@ -0,0 +1,48 @@ +--- +# Install APT dependencies +- include_tasks: 0_apt_dependencies.yml + +# Create matrix-appservice-irc user and group +- include_tasks: 1_user_group.yml + +- name: Clone matrix-appservice-irc project + git: + repo: https://github.com/matrix-org/matrix-appservice-irc.git + dest: /var/local/matrix-appservice-irc/matrix-appservice-irc + version: 0.11.2 + become: true + become_user: matrix-appservice-irc + +# Setup dependencies +- name: Install matrix-appservice-irc depedencies + command: npm install + args: + chdir: /var/local/matrix-appservice-irc/matrix-appservice-irc + become: true + become_user: matrix-appservice-irc + +# Configure +- name: Configure matrix-appservice-irc + template: + src: config.yaml.j2 + dest: /var/local/matrix-appservice-irc/matrix-appservice-irc/config.yaml + owner: matrix-appservice-irc + group: matrix-appservice-irc + mode: 0600 + +# Service file +- name: Install matrix-appservice-irc systemd unit + template: + src: 'systemd/matrix-appservice-irc.service.j2' + dest: '/etc/systemd/system/matrix-appservice-irc.service' + owner: root + group: root + mode: 0644 + notify: Reload systemd daemons + +# Run +#- name: Ensure that matrix-appservice-irc is started +# service: +# name: matrix-appservice-irc +# state: started +# enabled: true diff --git a/roles/matrix-appservice-irc/templates/apt/nodejs.j2 b/roles/matrix-appservice-irc/templates/apt/nodejs.j2 new file mode 100644 index 0000000..65e5110 --- /dev/null +++ b/roles/matrix-appservice-irc/templates/apt/nodejs.j2 @@ -0,0 +1,5 @@ +# {{ ansible_managed }} + +Package: node* libuv1* +Pin: release a=stretch-backports +Pin-Priority: 600 diff --git a/roles/matrix-appservice-irc/templates/config.yaml.j2 b/roles/matrix-appservice-irc/templates/config.yaml.j2 new file mode 100644 index 0000000..72d1a84 --- /dev/null +++ b/roles/matrix-appservice-irc/templates/config.yaml.j2 @@ -0,0 +1,443 @@ +# {{ ansible_managed }} + +homeserver: + # The URL to the home server for client-server API calls, also used to form the + # media URLs as displayed in bridged IRC channels: + url: "https://auro.re" + # + # The URL of the homeserver hosting media files. This is only used to transform + # mxc URIs to http URIs when bridging m.room.[file|image] events. Optional. By + # default, this is the homeserver URL, specified above. + # + # media_url: "http://media.repo:8008" + + # Drop Matrix messages which are older than this number of seconds, according to + # the event's origin_server_ts. + # If the bridge is down for a while, the homeserver will attempt to send all missed + # events on reconnection. These events may be hours old, which can be confusing to + # IRC users if they are then bridged. This option allows these old messages to be + # dropped. + # CAUTION: This is a very coarse heuristic. Federated homeservers may have different + # clock times and hence produce different origin_server_ts values, which may be old + # enough to cause *all* events from the homeserver to be dropped. + # Default: 0 (don't ever drop) + dropMatrixMessagesAfterSecs: 300 # 5 minutes + + # The 'domain' part for user IDs on this home server. Usually (but not always) + # is the "domain name" part of the HS URL. + domain: "auro.re" + + # 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: true + +# Configuration specific to the IRC service +ircService: + servers: + # The address of the server to connect to. + irc.crans.org: + # 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: "Crans IRC Bridge status" + + additionalAddresses: [ ] + # + # [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: "crans" + + # URL to an icon used as the network icon whenever this network appear in + # a network list. (Like in the riot room directory, for instance.) + # icon: https://example.com/images/hash.png + + # 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 + # A specific CA to trust instead of the default CAs. Optional. + #ca: | + # -----BEGIN CERTIFICATE----- + # ... + # -----END CERTIFICATE----- + + # + # 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 + + 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: "AuroreBot" + # 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: false + # 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 + # This will set the m.room.related_groups state event in newly created rooms + # with the given groupId. This means flares will show up on IRC users in those rooms. + # This should be set to the same thing as namespaces.users.group_id in irc_registration. + # This does not alter existing rooms. + # Leaving this option empty will not set the event. + groupId: +myircnetwork:localhost + # 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 + # 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. + # Default: '#irc_$SERVER_$CHANNEL' + aliasTemplate: "#irc_crans_$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"] + + # 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: true + + # 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: true + + 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: true + + # Apply specific rules to Matrix rooms. Only matrix-to-IRC takes effect. + rooms: + + # Apply specific rules to IRC channels. Only IRC-to-matrix takes effect. + channels: + + 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": ["!kieouiJuedJoxtVdaG:localhost"] + + # 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 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 (IRC)". Example: "Alice (IRC)" + displayName: "$NICK (IRC)" + # 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 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 + # e.g IP_FREEBIND on Linux, 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 + # + # 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 millseconds 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" + + # 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 + # 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). + # Default: false. + enabled: false + # The port to listen on for incoming ident requests. + # Ports below 1024 require root to listen on, and you may not want this to + # run as root. Instead, you can get something like an Apache to yank up + # incoming requests to 113 to a high numbered port. Set the port to listen + # on instead of 113 here. + # Default: 113. + port: 1113 + # The address to listen on for incoming ident requests. + # Default: 0.0.0.0 + address: "::" + + # Configuration for logging. Optional. Default: console debug level logging + # only. + logging: + # Level to log on console/logfile. One of error|warn|info|debug + level: "info" + # The file location to log to. This is relative to the project directory. + logfile: "debug.log" + # The file location to log errors to. This is relative to the project + # directory. + errfile: "errors.log" + # Whether to log to the console or not. + toConsole: true + # The max number of files to keep. Files will be overwritten eventually due + # to rotations. + maxFiles: 5 + + # Optional. Enable Prometheus metrics. If this is enabled, you MUST install `prom-client`: + # $ npm install prom-client@6.3.0 + # Metrics will then be available via GET /metrics on the bridge listening port (-p). + metrics: + # Whether to actually enable the metric endpoint. Default: false + enabled: false + # When collecting remote user active times, which "buckets" should be used. Defaults are given below. + # The bucket name is formed of a duration and a period. (h=hours,d=days,w=weeks). + remoteUserAgeBuckets: + - "1h" + - "1d" + - "1w" + + # The nedb database URI to connect to. This is the name of the directory to + # dump .db files to. This is relative to the project directory. + # Required. + databaseUri: "nedb://data" + + # Configuration options for the debug HTTP API. To access this API, you must + # append ?access_token=$APPSERVICE_TOKEN (from the registration file) to the requests. + # + # The debug API exposes the following endpoints: + # + # GET /irc/$domain/user/$user_id => Return internal state for the IRC client for this user ID. + # + # POST /irc/$domain/user/$user_id => Issue a raw IRC command down this connection. + # Format: new line delimited commands as per IRC protocol. + # + debugApi: + # True to enable the HTTP API endpoint. Default: false. + enabled: false + # The port to host the HTTP API. + port: 11100 + + # Configuration for the provisioning API. + # + # GET /_matrix/provision/link + # GET /_matrix/provision/unlink + # GET /_matrix/provision/listlinks + # + provisioning: + # True to enable the provisioning HTTP endpoint. Default: false. + enabled: false + # The number of seconds to wait before giving up on getting a response from + # an IRC channel operator. If the channel operator does not respond within the + # allotted time period, the provisioning request will fail. + # Default: 300 seconds (5 mins) + requestTimeoutSeconds: 300 + + # WARNING: The bridge needs to send plaintext passwords to the IRC server, it cannot + # send a password hash. As a result, passwords (NOT hashes) are stored encrypted in + # the database. + # + # To generate a .pem file: + # $ openssl genpkey -out passkey.pem -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:2048 + # + # The path to the RSA PEM-formatted private key to use when encrypting IRC passwords + # for storage in the database. Passwords are stored by using the admin room command + # `!storepass server.name passw0rd. When a connection is made to IRC on behalf of + # the Matrix user, this password will be sent as the server password (PASS command). + passwordEncryptionKeyPath: "passkey.pem" + + # Config for Matrix -> IRC bridging + matrixHandler: + # Cache this many matrix events in memory to be used for m.relates_to messages (usually replies). + eventCacheSize: 4096 + +# Options here are generally only applicable to large-scale bridges and may have +# consequences greater than other options in this configuration file. +advanced: + # The maximum number of HTTP(S) sockets to maintain. Usually this is unlimited + # however for large bridges it is important to rate limit the bridge to avoid + # accidentally overloading the homeserver. Defaults to 1000, which should be + # enough for the vast majority of use cases. + maxHttpSockets: 1000 diff --git a/roles/matrix-appservice-irc/templates/systemd/matrix-appservice-irc.service.j2 b/roles/matrix-appservice-irc/templates/systemd/matrix-appservice-irc.service.j2 new file mode 100644 index 0000000..1f25539 --- /dev/null +++ b/roles/matrix-appservice-irc/templates/systemd/matrix-appservice-irc.service.j2 @@ -0,0 +1,17 @@ +# {{ ansible_managed }} + +[Unit] +Description=A bridge between Matrix and IRC +After=syslog.target network-online.target mysql.service postgresql.service +Conflicts=shutdown.target + +[Service] +Type=simple +User=matrix-appservice-irc +Group=matrix-appservice-irc +WorkingDirectory=/var/local/matrix-appservice-irc/matrix-appservice-irc +ExecStart=/usr/bin/nodejs /var/local/matrix-appservice-irc/matrix-appservice-irc/app.js -c config.yaml -f my_registration_file.yaml -p 9999 +Restart=always + +[Install] +WantedBy=multi-user.target