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 Mi Piace

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 Mi Piace

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 Mi Piace

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

4 Mi Piace

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 Mi Piace

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

1 Mi Piace

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

Works perfectly.

2 Mi Piace

Ho aggiornato questa pagina per riflettere tale modifica.

Il token di accesso si trova, apparentemente, ora sotto “Aiuto e Informazioni” in fondo alle Impostazioni.

Ho lo stesso problema dello spinner infinito. :frowning:

Ho provato con stanze sia su matrix.org che su fedora.im.

1 Mi Piace

Ho appena eseguito la configurazione da solo e sembra aver funzionato bene. Un paio di teorie:

  • Le tue stanze sono crittografate? Non sono sicuro se dobbiamo fare un lavoro extra per supportare le stanze crittografate

  • Forse i token di accesso scadono dopo un po’ di tempo. Questo non succedeva quando ho creato l’integrazione nel 2017, ma è passato molto tempo :older_man:. Riproverò la mia configurazione locale piĂš tardi questa settimana e vedrò se funziona ancora.

1 Mi Piace

Non lo sono.

Forse, ma stavo copiando il token di accesso e poi lo stavo usando quasi immediatamente e questo non ha aiutato.

3 Mi Piace

Per la cronaca, @mattdm e io siamo riusciti a ricondurre questo problema a uno slash finale sull’URL di Homeserver nelle impostazioni di Discourse.

Ho aggiunto una nota a riguardo alle istruzioni nell’OP e ho anche aggiornato le istruzioni del token di accesso per funzionare con l’ultima interfaccia utente di element.io.

5 Mi Piace

Qualcuno ha avuto successo con il supporto ai thread?

Installazione dell’ultima versione del plugin chat (commit ba40ede510986f74a23345082ac578e126467b97), e configurazione di una stanza Matrix di test (stanza pubblica non crittografata), ricevo un errore HTTP 500 quando tento un test come descritto sopra. Stesso sintomo di rotellina infinita che richiede l’aggiornamento della pagina.

Il token di accesso dell’account bot è stato verificato in modo indipendente inviando un messaggio alla stanza tramite API (_matrix/client/r0/rooms/{room_id}/send/m.room.message) al nostro server Matrix.

I log di Discourse mostrano

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.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'

Non ho provato, ma sarebbe interessante. Intendi inserire tutti i post in un unico thread per ridurre il disordine dei canali, o si tratterebbe di pubblicare le risposte all’argomento in un thread matrix?

2 Mi Piace

Pubblicazione di risposte all’argomento su un thread di matrix.
(Stesso flusso di quello che ha attualmente Slack)

1 Mi Piace

Sono curioso di sapere se ci sono stati sviluppi sull’aggiunta del supporto per le risposte in thread per Matrix. Alcuni dei nostri utenti lo apprezzerebbero.

3 Mi Piace