Set up Matrix (element.io) notifications using the discourse-chat-integration plugin

This howto describes how to setup the Matrix (element.io) provider included in discourse-chat-integration.

Thanks to @ara4n and members of the #matrix-dev:matrix.org room for their help with this integration :slight_smile:

Install

If you haven’t already, install the discourse-chat-integration plugin

Set up Matrix

These instructions assume you are using the element.io web client. Equivalent steps should be possible using other interfaces.

  1. Open https://app.element.io/ in a new incognito window (you’ll see why later)

  2. Create a user account for your bot. You’ll probably want to write down the password somewhere in case you want to log back in later. Discourse does not need it.

  3. Use the interface to join any rooms that you want to be able to send notifications to

  4. Open the user settings by clicking your avatar in the top left, then All Settings

  5. Configure the bot’s display name and avatar

  6. Switch to the “Help and About” tab, scroll down to “Advanced”, and copy the Homeserver address and your “Access Token” - you’ll need them later.

  7. DO NOT CLICK LOG OUT. If you do, the Access Token will be invalidated, and it won’t work. Instead, just close the incognito window. If you forgot to open an incognito window, go back to step 1 :wink:

Set up Discourse

  1. In your Discourse site settings, enter your home server address in the chat_integration_matrix_homeserver setting. Make sure to include the protocol. (e.g. https://matrix.org). Do not include a trailing slash.

  2. Paste the access token you copied earlier into the chat_integration_matrix_access_token site setting

  3. Enable chat_integration_matrix_enabled

  4. Go to the Plugins tab, then Chat Integration

  5. Go to the Matrix tab, then Add Channel

  6. Enter a name for the channel (this is only displayed in the admin interface, it can be anything)

  7. Enter the “Room ID” for a room that you want to send notifications to. In the Element web client, you can find it by opening your room, clicking the name at the top, then scroll to the bottom. It will look something like

    !cdGUowUAqlgLHVerqE:matrix.org
    
  8. Save Channel

  9. Use the Test button on the channel you just created to check that everything’s working. You should see something like this:
    17

  10. Set up some “Rules” for your channel, according to the discourse-chat-integration instructions.

  11. giphy-downsized (1)

Technical Notes
  • At the time of writing, there does not seem to be a way of obtaining an “access token” for a “bot” in a user-friendly way. The incognito window solution is the most user-friendly way I could find

  • The matrix spec does not currently define a way of providing “rich text” messages. There is a spec under development, but for now this plugin uses the “unofficial” method which has been adopted in the element.io client. Clients that do not support this will simply fall back to a plain text message

  • There is no provision in this implementation for ‘refreshing’ access tokens. This is based on the understanding that the majority of homeservers currently in use do not expire tokens. If this changes in the future, this will need to be revisited.

Last edited by @JammyDodger 2024-05-26T07:09:39Z

Check documentPerform check on document:
19 Me gusta

The test is not working for us:

422 No Reason Phrase

and the spinner will keep on turning indefinitely until full page reload. How can we triage the error?

4 Me gusta

I just tried setting up a matrix integration using the instructions above, and it all worked ok. Can you confirm that you’re running the latest version of Discourse and this plugin?

Are you using the matrix.org homeserver, or your own homeserver? The 422 error is coming from that server.

I would suggest double checking your channel identifier, and also your matrix access token in your Discourse site settings.

4 Me gusta

Thanks for the hints. I’ll try that out, before reporting back here.

4 Me gusta

I have absolutely the same issue as @almereyda has.
@david, can you update obtaing “Access Token”, please? (Riot seems to be intensively developed :+1:)
+“Doctor log

2 Me gusta

I’m also interested in updated instructions about getting an access token…

1 me gusta

Currently called Room settings in Element (rebranding of Riot).

Works perfectly.

2 Me gusta

He actualizado esta página para reflejar ese cambio.

El token de acceso, aparentemente, ahora está en “Ayuda y Acerca de” en la parte inferior de Configuración.

Tengo el mismo problema del spinner infinito. :frowning:

Lo intenté con salas tanto en matrix.org como en fedora.im.

1 me gusta

Acabo de pasar por la configuración yo mismo y pareció funcionar bien. Un par de teorías:

  • ¿Están cifradas tus salas? No estoy seguro si necesitamos hacer trabajo adicional para admitir salas cifradas.

  • Quizás los tokens de acceso expiran después de algún tiempo. Esto solía suceder cuando construí la integración en 2017, pero eso fue hace mucho tiempo :older_man:. Intentaré mi configuración local de nuevo más tarde esta semana y veré si todavía funciona.

1 me gusta

No lo están.

Quizás, pero estaba copiando la token de acceso y luego usándola básicamente de inmediato y eso no ayudó.

3 Me gusta

Para que conste, @mattdm y yo pudimos rastrear esto hasta una barra diagonal al final de la URL del servidor de origen en la configuración de Discourse.

He añadido una nota sobre esto a las instrucciones en el OP, y también he actualizado las instrucciones del token de acceso para que funcionen con la última interfaz de usuario de element.io.

5 Me gusta

¿Alguien ha tenido suerte con el soporte de hilos?

Al instalar la última versión del plugin de chat (commit ba40ede510986f74a23345082ac578e126467b97) y configurar una sala de Matrix de prueba (sala pública sin cifrar), recibo un error HTTP 500 cuando intento una prueba como se describe arriba. Mismo síntoma de spinner infinito que requiere actualizar la página.

El token de acceso de la cuenta del bot fue verificado de forma independiente enviando un mensaje a la sala usando la API (_matrix/client/r0/rooms/{room_id}/send/m.room.message) a nuestro propio servidor de Matrix.

Los registros de Discourse muestran

Started POST "/admin/plugins/chat-integration/test" for 141.142.60.55 at 2022-11-16 18:16:47 +0000
Processing by DiscourseChatIntegration::ChatController#test as */*
  Parameters: {"channel_id"=>"107", "topic_id"=>"466"}
Completed 500 Internal Server Error in 62ms (ActiveRecord: 0.0ms | Allocations: 10109)
NameError (uninitialized constant FinalDestination::HTTP)
app/controllers/application_controller.rb:387:in `block in with_resolved_locale'
app/controllers/application_controller.rb:387:in `with_resolved_locale'
lib/middleware/omniauth_bypass_middleware.rb:71:in `call'
lib/middleware/content_security_policy/middleware.rb:12:in `call'
lib/middleware/anonymous_cache.rb:361:in `call'
config/initializers/100-quiet_logger.rb:23:in `call'
config/initializers/100-silence_logger.rb:31:in `call'
lib/middleware/enforce_hostname.rb:23:in `call'
lib/middleware/request_tracker.rb:198:in `call'

No lo he intentado, pero sería interesante. ¿Te refieres a poner todas las publicaciones en un solo hilo para reducir el desorden del canal, o se trataría de publicar respuestas de temas en un hilo de matrix?

2 Me gusta

Publicar respuestas a temas en un hilo de matrix.
(Mismo flujo que tiene Slack actualmente)

1 me gusta

Tengo curiosidad por saber si ha habido algún avance en la adición de soporte para respuestas encadenadas para matrix. Algunos de nuestros usuarios lo agradecerían.

3 Me gusta