matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-appservice-irc.md

# Setting up Appservice IRC (optional)

**Note**: bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) can also happen via the [Heisenbridge](configuring-playbook-bridge-heisenbridge.md) bridge supported by the playbook.

The playbook can install and configure the [matrix-appservice-irc](https://github.com/matrix-org/matrix-appservice-irc) bridge for you.

See the project's [documentation](https://github.com/matrix-org/matrix-appservice-irc/blob/master/HOWTO.md) to learn what it does and why it might be useful to you.

## Adjusting the playbook configuration

To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:

```yaml
matrix_appservice_irc_enabled: true

matrix_appservice_irc_ircService_servers:
  irc.example.com:
    name: "ExampleNet"
    port: 6697
    ssl: true
    sasl: false
    allowExpiredCerts: false
    sendConnectionMessages: true
    botConfig:
      enabled: true
      nick: "MatrixBot"
      joinChannelsIfNoUsers: true
    privateMessages:
      enabled: true
      federate: true
    dynamicChannels:
      enabled: true
      createAlias: true
      published: true
      joinRule: public
      groupId: +myircnetwork:localhost
      federate: true
      aliasTemplate: "#irc_$CHANNEL"
    membershipLists:
      enabled: false
      floodDelayMs: 10000
      global:
        ircToMatrix:
          initial: false
          incremental: false
        matrixToIrc:
          initial: false
          incremental: false
    matrixClients:
      userTemplate: "@irc_$NICK"
      displayName: "$NICK (IRC)"
      joinAttempts: -1
    ircClients:
      nickTemplate: "$DISPLAY[m]"
      allowNickChanges: true
      maxClients: 30
      idleTimeout: 10800
      reconnectIntervalMs: 5000
      concurrentReconnectLimit: 50
      lineLimit: 3
```

## Installing

After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`

## Usage

You then need to start a chat with `@irc_bot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base domain, not the `matrix.` domain).
Add support for matrix-appservice-irc 2019-01-31 06:37:23 +01:00			`# Setting up Appservice IRC (optional)`

Cross-link similar bridges 2021-05-19 12:32:05 +02:00			`Note: bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) can also happen via the [Heisenbridge](configuring-playbook-bridge-heisenbridge.md) bridge supported by the playbook.`

			`The playbook can install and configure the [matrix-appservice-irc](https://github.com/matrix-org/matrix-appservice-irc) bridge for you.`
Add support for matrix-appservice-irc 2019-01-31 06:37:23 +01:00
Fix matrix-appservice-irc database specification This fixes an incorrect indentation in the database specification for appservice-irc which caused matrix-appservice-irc to refuse to start with the remarkably unhelpful error message: ``` ERROR:CLI Failed to run bridge. ``` This also updates doc links to the new matrixdotorg repo because the tedomum repo contains out-of-date documentation. 2020-02-08 11:02:03 +01:00			`See the project's [documentation](https://github.com/matrix-org/matrix-appservice-irc/blob/master/HOWTO.md) to learn what it does and why it might be useful to you.`
Add support for matrix-appservice-irc 2019-01-31 06:37:23 +01:00
Use common expression on documentation regarding playbook configuration Overall the playbook uses the expression "Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:" with the heading "Adjusting the playbook configuration" for sections to explain what to be added as variables Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-10-12 13:48:24 +02:00			`## Adjusting the playbook configuration`

			To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:
Add support for matrix-appservice-irc 2019-01-31 06:37:23 +01:00
			```yaml
Correct variable name in documentation 2019-01-31 16:58:45 +01:00			`matrix_appservice_irc_enabled: true`
Make IRC bridge configuration entirely managed by the playbook 2019-06-19 11:28:58 +02:00
			`matrix_appservice_irc_ircService_servers:`
			`irc.example.com:`
			`name: "ExampleNet"`
			`port: 6697`
			`ssl: true`
			`sasl: false`
			`allowExpiredCerts: false`
			`sendConnectionMessages: true`
			`botConfig:`
			`enabled: true`
			`nick: "MatrixBot"`
			`joinChannelsIfNoUsers: true`
			`privateMessages:`
			`enabled: true`
			`federate: true`
			`dynamicChannels:`
			`enabled: true`
			`createAlias: true`
			`published: true`
			`joinRule: public`
			`groupId: +myircnetwork:localhost`
			`federate: true`
			`aliasTemplate: "#irc_$CHANNEL"`
			`membershipLists:`
			`enabled: false`
			`floodDelayMs: 10000`
			`global:`
			`ircToMatrix:`
			`initial: false`
			`incremental: false`
			`matrixToIrc:`
			`initial: false`
			`incremental: false`
			`matrixClients:`
			`userTemplate: "@irc_$NICK"`
			`displayName: "$NICK (IRC)"`
			`joinAttempts: -1`
			`ircClients:`
			`nickTemplate: "$DISPLAY[m]"`
			`allowNickChanges: true`
			`maxClients: 30`
			`idleTimeout: 10800`
			`reconnectIntervalMs: 5000`
			`concurrentReconnectLimit: 50`
			`lineLimit: 3`
Add support for matrix-appservice-irc 2019-01-31 06:37:23 +01:00			```

Use common sentences on documentation regarding installation Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-10-12 20:03:46 +02:00			`## Installing`

			After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`

			`## Usage`

Rename some variables 2019-02-28 10:51:09 +01:00			You then need to start a chat with `@irc_bot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base domain, not the `matrix.` domain).