Difference between revisions of "Matrix"

From OSGeo
Jump to navigation Jump to search
(16 intermediate revisions by 6 users not shown)
Line 1: Line 1:
For those who like the [[Matrix|http://matrix.org]] environment for communication, there is https://matrix.to/#/+osgeo:matrix.org community.
+
[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).
  
Access to community rooms is mostly public. Many rooms are bridged already to corresponding [[IRC]] channels.
+
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'''.
  
In case of problem, you may contact [[User:Strk]].
+
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).
  
OSGeo currently host a [[SAC:MatrixSynapse|Matrix homeserver]]
+
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 [[SAC:LDAP|OSGeo username/password]]. Use [https://id.osgeo.org/ldap/search OSGeo User Search] for finding an ID.
  
 
= Using Matrix as an IRC client =
 
= Using Matrix as an IRC client =
  
To effectively use Matrix as an IRC client for use with OSGeo channels, you should register your nickname with Freenode
+
As of September 2023 this is not easy anymore. Consult your IRC network staff to ask about how do do this.
services and instruct the Matrix bridge to hold that identity for you. To do so:
+
 
 +
= 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.
 +
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 [https://matrix.to/#/#general:osgeo.org #general:osgeo.org] Matrix room and the [https://t.me/OSGeoorg OSGeoorg Telegram group]
 +
 
  
# In matrix, open a room connection to <code>@freenode_NickServ:matrix.org</code>,  this will connect you to the freenode nickserv
 
# If you haven't done so already, enter the command <code>register [<email>] <password></code>. This will register your nickname (needs you to follow instructions sent by email to complete the registration)
 
# Enter the command <code>identify [<nickname>] <password></code>  This will identify your matrix user with Freenode
 
# Open a direct chat (in matrix) with <code>@appservice-irc:matrix.org</code>
 
# Use <code>!storepass nickname:password</code> to store your irc nickname and password with matrix to send automatically when you login to matrix
 
  
Then restart your matrix session to test
+
== Adding Room Aliases / Additional Addresses ==
  
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
+
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.

Revision as of 05:56, 27 September 2023

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

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

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