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

[Discourse]

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

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

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:
   

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

11. 

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 document

Perform check on document:

[almereyda (jon r)]

@david

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

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?

[david (David Taylor)]

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.

[almereyda (jon r)]

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

[nesnera (Ladislav Nesnera)]

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

[efeefe (Felipe Schmidt Fonseca)]

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

[sunjam (james.network)]

@david

Under Settings (cog icon in bottom left), you can set the bot’s display name and avatar

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

Works perfectly.

[mattdm (Matthew Miller)]

@sunjam

Element (Riotのリブランディング)。

このページを更新して、その変更を反映しました。

アクセス トークンは、設定の下部にある「ヘルプと概要」の下にあるようです。

私も同じ無限スピナーの問題を抱えています。

matrix.org と fedora.im の両方のルームで試しました。

[david (David Taylor)]

自分でセットアップを実行してみましたが、問題なく動作したようです。いくつか考えられることがあります。

• ルームは暗号化されていますか？ 暗号化されたルームをサポートするために追加作業が必要かどうかはわかりません。

• アクセストークンは時間の経過とともに期限切れになるのかもしれません。2017年に統合を構築したときはそうではありませんでしたが、それはずっと昔のことです 。今週後半にローカル設定を再度試して、まだ動作するかどうか確認します。

[mattdm (Matthew Miller)]

@david

あなたの部屋は暗号化されていますか？ 暗号化された部屋をサポートするために追加作業が必要かどうかはわかりません

されていません。

@david

おそらく、アクセストークンは時間の経過とともに期限切れになります。 2017年に統合を構築したときは、これは起こりませんでしたが、それはずっと昔のことです 。 後でローカル設定をもう一度試して、まだ機能するかどうかを確認します。

そうかもしれませんが、アクセストークンをコピーしてすぐに使用しましたが、うまくいきませんでした。

[david (David Taylor)]

記録のために、@mattdmと私はDiscourseの設定にあるホームサーバーURLの末尾のスラッシュに起因する問題であることを突き止めました。

OPの指示にこの件についての注意点を追加し、最新のelement.io UIで動作するようにアクセストークンの指示も更新しました。

[sunjam (james.network)]

スレッドサポートで何かうまくいった人はいますか？

[manning-ncsa (Andrew Manning)]

チャットプラグインの最新バージョン（コミット ba40ede510986f74a23345082ac578e126467b97）をインストールし、テスト用のMatrixルーム（暗号化なし、公開ルーム）を設定したところ、上記で説明されているようにテストを実行しようとすると500 HTTPエラーが発生します（Set up Matrix (element.io) notifications using the discourse-chat-integration plugin - #2 by almereyda

ボットアカウントのアクセストークンは、API（_matrix/client/r0/rooms/{room_id}/send/m.room.message）を使用して、私たち自身のMatrixサーバーにメッセージを送信することで独立して検証されました。

Discourseのログには以下が表示されます。

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'

[mattdm (Matthew Miller)]

@sunjam

スレッドサポートで何かうまくいった人はいますか？

試していませんが、それは興味深いですね。チャンネルの乱雑さを減らすためにすべての投稿を1つのスレッドに入れるということですか、それともトピックの返信をマトリックスのスレッドに投稿することですか？

[sunjam (james.network)]

@mattdm

これは、トピックの返信をMatrixスレッドに投稿することになりますか？

トピックの返信をMatrixスレッドに投稿します。
（現在のSlackと同じフロー）

[mattdm (Matthew Miller)]

Matrixでスレッド返信サポートの追加について、何か進展はありましたか？一部のユーザーがそれを喜ぶと思います。