Matrix Bridge Configuration

Configure the Rocket.Chat workspace to link with your Matrix Homeserver.

You don’t need to perform any additional federation configuration, as the required fields were automatically populated during the installation of Rocket.Chat and Synapse.

Subscribe to any of our premium plans or apply trial on your workspace to unlock all the available federation features.

To access this setting,

• Go to Administration > Workspace > Settings > Federation > Matrix Bridge.

• Enable federation with Matrix.

• AppService ID: A unique identifier for the Application Service. It is automatically generated by Rocket.Chat.

• Homeserver Token: A unique homeserver token to authenticate requests to Application Services.

• App Service Token: A unique Application Service token to authenticate requests to homeservers. It is automatically generated by Rocket.Chat

• Homeserver URL: The URL of the Matrix server you want to use as your Proxy homeserver. e.g. http://localhost:8008

• Homeserver Domain: Your Matrix homeserver's name, the same as you've configured in your Matrix configuration file.

• Bridge URL: The URL for the Matrix bridge. It is the location where you want your bridge to run.

• Ensure the port you use for the bridge is free in your host.

• We recommend you use a brand new Matrix Homeserver as your Proxy homeserver.

• We strongly recommend not connecting to this Matrix Homeserver with other Matrix clients.

• AppService User Localpart: The bot user associated with the application service (Sometimes, it's used to execute some actions).

• Maximum number of users when joining a public room in a remote server: The number of the maximum users when joining a public room in a remote server. Public rooms with more users will be shown in the list of public rooms to join. However, they display a Can't join warning, and users won't be able to join those channels.

Increasing the maximum number may consume a large amount of the resources in your infrastructure platform. It is recommended to adhere to the default size.

• Registration file: Automatically generated and updated by Rocket.Chat based on all the values provided in the above settings (the Application Service is configured using this file).

• Configuration status: This field displays the configuration status between the homeserver and the appservice as Valid or Invalid. For information, see the Pinging section of the Matrix documentation.

• Verify configuration: Use this option to verify the federation connection status. The configuration must be valid before you can take further actions. You can check the report of your Matrix server using the Matrix Federation Tester tool. Configuration is verified when federation is enabled, or when the configuration is changed automatically. You can still use this button to force a verification check.

If you are on an airgapped workspace, you'll need to host federation tester (https://github.com/matrix-org/matrix-federation-tester) on the same network or Rocket.Chat won't be able to verify the configuration. Use the FEDERATION_TESTER_HOST environment variable to set the endpoint of federation tester (including the http or https part).