Latest revision as of 01:53, 7 August 2024

Matrix is an open source project and an open specification for decentralised, real-time communication, similar to IRC but based on the HTTP protocol (not connection-oriented) and including management of backlog (user state kept on server, like email).

Anyone can install an homeserver to keep their chat state. OSGeo currently host a Matrix homeserver. Matrix users are identified by a string in the form @<username>:<homeserver> so by using the OSGeo homeserver you can have a user identifier like @strk:osgeo.org, which is your OSGeo UserID preceded by an @ sign and followed by :osgeo.org.

Matrix allows for bridges to other networks, including IRC so a Matrix client can effectively also be used as a method to access IRC channels. Many rooms are bridged already to corresponding IRC channels (read section below for how to effectively use that bridge).

An OSGeo Matrix Space is available to group OSGeo-related rooms.

Connecting to the OSGeo Matrix Homeserver

Pick a Matrix client application (can run in a browser, on a desktop or on ah handheld device)
When launching the program connect to matrix.osgeo.org
When prompted you can use your OSGeo username/password. Use OSGeo User Search for finding an ID.

Tip: A general room to join is #lounge:osgeo.org

Using Matrix as an IRC client

As of September 2023 this is not easy anymore. Consult your IRC network staff to ask about how do do this.

Help

In case of problem, you may contact User:Strk (https://matrix.to/#/@strk:osgeo.org).

Managing Matrix rooms

Setting up bridges

Bridging Matrix rooms with IRC

As of October 2023 OSGeo is running an experimental IRC <-> Matrix bridge (SAC:Heisenbridge). If you want your project's IRC channel to be bridged to your Matrix room please file a ticket on https://trac.osgeo.org/osgeo or come asking in https://matrix.to/#/#sac:osgeo.org

Bridging Matrix rooms with Telegram

The instructions here: https://t2bot.io/telegram/ show how to bridge a Telegram channel with a Matrix room. This allows people using Matrix clients to join Telegram conversations, and vice-versa. This was tested using the Element matrix client, on the #general:osgeo.org Matrix room and the OSGeoorg Telegram group

Adding Room Aliases / Additional Addresses

If you already have a Matrix room which is not accessible with an :osgeo.org address, you can make it so by adding other 'Addresses' ('Aliases') of the room. For example, the #OSGeoUK:matrix.org room now also has #uk:osgeo.org and #OSGeoUK:matrix.org as additional addresses. To add aliases to the osgeo.org server, you need to be logged in there ( via your osgeo.org account ). Publishing aliases to the osgeo.org matrix room directory requires to have at least "Moderator" status in the room.

@@ Line 1: / Line 1: @@
-[https://matrix.org Matrix] is an alternative method of connecting to OSGeo [[IRC]] channels.
+[https://matrix.org Matrix] is an open source project and an open specification for decentralised, real-time communication, similar to [[IRC]] but based on the HTTP protocol (not connection-oriented) and including management of backlog (user state kept on server, like email).
-# Download a [https://matrix.org/clients/ Matrix client] application (also available on Android and iOS)
+Anyone can install an homeserver to keep their chat state. OSGeo currently host a [[SAC:MatrixSynapse|Matrix homeserver]]. Matrix users are identified by a string in the form '''@<username>:<homeserver>''' so by using the OSGeo homeserver you can have a user identifier like '''@strk:osgeo.org''', which is your [[SAC:LDAP|OSGeo UserID]] preceded by an '''@''' sign and followed by ''':osgeo.org'''.
+Matrix allows for bridges to other networks, including [[IRC]] so a Matrix client can effectively also be used as a method to access [[IRC]] channels. Many rooms are bridged already to corresponding [[IRC]] channels (read section below for how to effectively use that bridge).
+An [https://matrix.to/#/#osgeo:osgeo.org OSGeo Matrix Space] is available to group OSGeo-related rooms.
+= Connecting to the OSGeo Matrix Homeserver =
+# Pick a [https://matrix.org/clients/ Matrix client] application (can run in a browser, on a desktop or on ah handheld device)
 # When launching the program connect to '''matrix.osgeo.org'''
-# When prompted you can use your OSGeo username/password.
+# When prompted you can use your [[SAC:LDAP|OSGeo username/password]]. Use [https://id.osgeo.org/ldap/search OSGeo User Search] for finding an ID.
-Access to community rooms is mostly public. Many rooms are bridged already to corresponding [[IRC]] channels (read section below for how to effectively use that bridge).
+''Tip: A general room to join is #lounge:osgeo.org''
 = Using Matrix as an IRC client =
-To effectively use Matrix as an IRC client for use with OSGeo channels, you should [register your nickname](https://libera.chat/guides/registration) with Libera chat services.
+As of September 2023 this is not easy anymore. Consult your IRC network staff to ask about how do do this.
+= Help =
-More info can be found about Matrix and IRC can be found on https://github.com/matrix-org/matrix-appservice-irc/wiki/Guide:-How-to-use-Matrix-to-participate-in-IRC-rooms
+In case of problem, you may contact [[User:Strk]] (https://matrix.to/#/@strk:osgeo.org).
-= Additional Addresses =
+= Managing Matrix rooms =
-If you already have a Matrix room which is not accessible with an :osgeo.org address, you can make it so by adding other 'Addresses' ('Aliases') of the room. For example, the '''#OSGeoUK:matrix.org''' room now also has ''#uk:osgeo.org'' and ''#OSGeoUK:matrix.org'' as additional addresses. To add aliases to the osgeo.org server, you need to be logged in there ( via your osgeo.org account ). Publishing aliases to the osgeo.org matrix room directory requires to have at least "Moderator" status in the room.
+== Setting up bridges ==
+=== Bridging Matrix rooms with IRC ===
-= Help =
+As of October 2023 OSGeo is running an experimental IRC <-> Matrix bridge ([[SAC:Heisenbridge]]).
+If you want your project's IRC channel to be bridged to your Matrix room please file a ticket on https://trac.osgeo.org/osgeo
+or come asking in https://matrix.to/#/#sac:osgeo.org
-OSGeo currently host a [[SAC:MatrixSynapse|Matrix homeserver]].
+=== Bridging Matrix rooms with Telegram ===
-In case of problem, you may contact [[User:Strk]].
+The instructions here: https://t2bot.io/telegram/ show how to bridge a Telegram channel with a Matrix room. This allows people using Matrix clients to join Telegram conversations, and vice-versa. This was tested using the Element matrix client, on the [https://matrix.to/#/#general:osgeo.org #general:osgeo.org] Matrix room and the [https://t.me/OSGeoorg OSGeoorg Telegram group]
-= OSGeo Matrix Space =
-An [https://matrix.to/#/#osgeo:osgeo.org OSGeo Matrix Space] is available to group OSGeo-related rooms.
-= Bridging Matrix rooms with Telegram =
+== Adding Room Aliases / Additional Addresses ==
-The instructions here: https://t2bot.io/telegram/ show how to bridge a Telegram channel with a Matrix room. This allows people using Matrix clients to join Telegram conversations, and vice-versa. This was tested using the Element matrix client, on the [https://matrix.to/#/#general:osgeo.org #general:osgeo.org] Matrix room and the [https://t.me/OSGeoorg OSGeoorg Telegram group]
+If you already have a Matrix room which is not accessible with an :osgeo.org address, you can make it so by adding other 'Addresses' ('Aliases') of the room. For example, the '''#OSGeoUK:matrix.org''' room now also has ''#uk:osgeo.org'' and ''#OSGeoUK:matrix.org'' as additional addresses. To add aliases to the osgeo.org server, you need to be logged in there ( via your osgeo.org account ). Publishing aliases to the osgeo.org matrix room directory requires to have at least "Moderator" status in the room.

Difference between revisions of "Matrix"