Matrix: Difference between revisions

From KDE Community Wiki
(Add instructions for users who already have matrix.org accounts)
No edit summary
Line 1: Line 1:
[https://www.matrix.org Matrix] is an open standard for interoperable, decentralised, real-time communications. KDE is officially using Matrix for collaboration within the community, superseding more antiquated and closed source services.  Matrix is an open protocol and network for decentralized communication, backed by an open standard and open source reference implementations for servers, clients, client SDKs, bridges, bots and more.  It provides all the features you would expect from a modern chat system: infinite scrollback, file transfer, typing notifications, read receipts, presence, search, push notifications, stickers, VoIP calling and conferencing, etc.  It even provides end-to-end encryption (based on Signal’s double ratchet algorithm) for when you want some privacy.
KDE is officially using Matrix for collaboration within the community, superseding more antiquated and closed-source services.
 
[https://www.matrix.org Matrix] is an open standard for interoperable, decentralised, real-time communications.   
 
Matrix is an open protocol and network for decentralized communication, backed by an open standard and open source reference implementations for servers, clients, client SDKs, bridges, bots and more.  It provides all the features you would expect from a modern chat system: infinite scrollback, file transfer, typing notifications, read receipts, presence, search, push notifications, stickers, VoIP calling and conferencing, etc.  It even provides end-to-end encryption (based on Signal’s double ratchet algorithm) for when you want some privacy.


Furthermore, Matrix natively supports bridges to other protocols, such as IRC (the official KDE messaging channel). This means that you can use a Matrix client to join and use IRC channels like if they were Matrix rooms.  
Furthermore, Matrix natively supports bridges to other protocols, such as IRC (the official KDE messaging channel). This means that you can use a Matrix client to join and use IRC channels like if they were Matrix rooms.  
Line 6: Line 10:


== Clients ==
== Clients ==
You can chat using your web browser and visiting [https://webchat.kde.org KDE's webchat] or you can use a desktop or mobile client. [https://matrix.org/docs/projects/clients-matrix Here is a list of clients for your desktop or mobile devices].
You can chat using your web browser by visiting [https://webchat.kde.org KDE's webchat] or you can use a desktop or mobile client. [https://matrix.org/docs/projects/clients-matrix Check out a list of clients for your desktop or mobile devices].


KDE also features its own client, [https://apps.kde.org/neochat/ NeoChat].
KDE also features its own native Matrix client, [https://apps.kde.org/neochat/ NeoChat].


== Registering and Logging in ==
== Registering and Logging in ==
Line 18: Line 22:


# Visit [https://webchat.kde.org KDE's online webchat]
# Visit [https://webchat.kde.org KDE's online webchat]
# Locate the ''Create Account'' button. Press it. <br /> [[File:Riot upload 00.png|700px|center]]
# Click the ''Create Account'' button. <br /> [[File:Riot upload 00.png|700px|center]]
# Choose a cool nickname and set your password. You can include an email if you ever need to recover your password, but this is optional. Click ''Register''. <br />[[File:Kde-register.png|700px|center]]<br />Note: the dialog now includes a checkbox for agreement with the Privacy Policy and Terms and Conditions.
# Choose a cool nickname and set your password. You can optionally include an email address if you ever need to recover your password. Click ''Register''. <br />[[File:Kde-register.png|700px|center]]<br />Note: the dialog now includes a checkbox for agreement with the Privacy Policy and Terms and Conditions.
<br />
<br />


Line 26: Line 30:
==== Using the Element desktop client ====
==== Using the Element desktop client ====


Download the desktop client [https://element.io/get-started from Element's website]. APT repositories with Debian/Ubuntu packages are provided. Your mileage may vary for other distributions. The latest stable version number is listed on [https://github.com/vector-im/element-web/releases/latest Element's GitHub releases page] and is the version number you should aim for.
Download the desktop client [https://element.io/get-started from Element's website]. APT repositories with Debian/Ubuntu packages are provided.  
 
Choose the latest stable version number listed at [https://github.com/vector-im/element-web/releases/latest Element's GitHub releases page].


Registration is the same process as the steps above.  
Registering here follows the same process as above.  


'''Homeserver URL''': '''https://kde.modular.im''' (if you would like a Matrix account on KDE's Modular homeserver)
'''Homeserver URL''': '''https://kde.modular.im''' (if you would like to use your Matrix account on KDE's Modular homeserver)


[[File:Web_registration_01.png|700px|center]]
[[File:Web_registration_01.png|700px|center]]


==== Using the Element client for mobile ====
==== Using the Element Client for Mobile ====


''Currently Element only supports having one account''
''Currently Element only supports having one account''


In Signin/Register select the ''Use custom server options (Advanced)'' option to set the following
Under '''Signin/Register''' select the ''Use custom server options (Advanced)'' option to set the following


* Home server: https://kde.modular.im
* Home server: '''https://kde.modular.im'''
* Identity server: https://vector.im (not required on Element(Android). Other OSes please confirm)
* Identity server: '''https://vector.im''' (not required on Element for Android. Other operating systems please confirm)


[[File:Screenshot Riot.im kde settings.png|500px|center]]
[[File:Screenshot Riot.im kde settings.png|500px|center]]
Line 53: Line 59:
===== Plasma Mobile =====
===== Plasma Mobile =====
On Plasma Mobile you can use [https://apps.kde.org/neochat/ NeoChat].
On Plasma Mobile you can use [https://apps.kde.org/neochat/ NeoChat].


== Rooms ==
== Rooms ==
Check back often as we will be adding new rooms as we go.
The following is a collection of active rooms where KDE development and other activities happen. Some rooms are more active than others and you're welcome to browse through them. We add new rooms as they are formed.


=== Welcome ===
==== Welcome ====
New to KDE? [https://webchat.kde.org/#/room/#kde-welcome:kde.org Start here and find out what this is all about].
New to KDE? [https://webchat.kde.org/#/room/#kde-welcome:kde.org Start here and find out what this is all about].


=== General KDE channel ===
==== General KDE channel ====


Share your experience with [https://webchat.kde.org/#/room/#kde:kde.org the KDE community].
Share your experience with [https://webchat.kde.org/#/room/#kde:kde.org the KDE community].


=== Plasma ===
==== Plasma ====


* Plasma Desktop: [https://webchat.kde.org/#/room/#plasma:kde.org Find out more about KDE's desktop environment here].
* Plasma Desktop: [https://webchat.kde.org/#/room/#plasma:kde.org Find out more about KDE's desktop environment here].
* Plasma Mobile: [https://webchat.kde.org/#/room/#plasmamobile:kde.org Plasma Mobile developers, users and other interested people]
* Plasma Mobile: [https://webchat.kde.org/#/room/#plasmamobile:kde.org Plasma Mobile developers, users and other interested people]


=== System applications, frameworks and other operating systems ===
==== System applications, frameworks and other operating systems ====


* [https://webchat.kde.org/#/room/#kirigami:kde.org Kirigami]
* [https://webchat.kde.org/#/room/#kirigami:kde.org Kirigami]
Line 78: Line 86:
* [https://webchat.kde.org/#/room/#kde-windows:kde.org KDE Apps for Windows]
* [https://webchat.kde.org/#/room/#kde-windows:kde.org KDE Apps for Windows]


=== Distribution-centered KDE rooms ===
==== Distribution-centered KDE rooms ====


* [https://webchat.kde.org/#/room/#debian-kde:matrix.org Debian KDE]
* [https://webchat.kde.org/#/room/#debian-kde:matrix.org Debian KDE]
Line 94: Line 102:
* [https://webchat.kde.org/#/room/#ubuntustudio-offtopic:kde.org Ubuntu Studio (Offtopic Room)]
* [https://webchat.kde.org/#/room/#ubuntustudio-offtopic:kde.org Ubuntu Studio (Offtopic Room)]


=== For (potential) contributors ===
==== For (potential) contributors ====


* Development: [https://webchat.kde.org/#/room/#kde-devel:kde.org KDE developers discuss technical stuff here].
* Development: [https://webchat.kde.org/#/room/#kde-devel:kde.org KDE developers discuss technical stuff here].
Line 106: Line 114:
* Flatpak packaging: [https://matrix.to/#/#flatpak:kde.org To assist in packaging KDE apps as flatpaks].
* Flatpak packaging: [https://matrix.to/#/#flatpak:kde.org To assist in packaging KDE apps as flatpaks].


=== Applications ===
==== Applications ====


Here is a list of individual applications that have their own Matrix rooms:
Here is a list of individual applications that have their own Matrix rooms:
Line 136: Line 144:
* Yakuake: [https://webchat.kde.org/#/room/#yakuake:kde.org A fancy drop-down terminal]
* Yakuake: [https://webchat.kde.org/#/room/#yakuake:kde.org A fancy drop-down terminal]


=== Events and goals ===
==== Events and goals ====


* [https://webchat.kde.org/#/room/#kde-soc:kde.org KDE Season of Code]
* [https://webchat.kde.org/#/room/#kde-soc:kde.org KDE Season of Code]
Line 149: Line 157:
* [https://webchat.kde.org/#/room/#kde-is-privacy:kde.org KDE is Privacy]
* [https://webchat.kde.org/#/room/#kde-is-privacy:kde.org KDE is Privacy]


=== Local communities ===
==== Local communities ====


* [https://webchat.kde.org/#/room/#kde_ru:kde.org KDE Russia]
* [https://webchat.kde.org/#/room/#kde_ru:kde.org KDE Russia]
Line 178: Line 186:
* Leave room again
* Leave room again
* Join via local alias e.g. /join #YOUR_CHANNEL
* Join via local alias e.g. /join #YOUR_CHANNEL
* Everyone can now join your room via the #YOUR_CHANNEL locally and #YOUR_CHANNEL:kde.org in the Matrix
* Everyone can now join your room using the #YOUR_CHANNEL locally and #YOUR_CHANNEL:kde.org in Matrix


Where you can setup the alias depends on the client you use. For webchat.kde.org it'll look a bit like this:
You can set up your alias depending on the client you choose. For webchat.kde.org it looks like this:


[[File:Riot-room-alias-1.png|500px|center]]
[[File:Riot-room-alias-1.png|500px|center]]
Line 189: Line 197:
[[File:Riot-room-flairs.png|500px|center]]
[[File:Riot-room-flairs.png|500px|center]]


== Why should I use the Matrix IRC bridge? ==


Your IRC nickname will be available 24/7 and other people will be able to ping or contact you even if you are away from your computer. This can also be achieved by using an IRC bouncer, but Matrix has several advantages:
<br/>
=Frequently Asked Questions=
<br/>
 
== Why should I use the Matrix IRC Bridge? ==
 
Your IRC nickname will be available 24/7 and other people will be able to ping or contact you even if you are away from your computer. While this can also be achieved using an IRC bouncer, Matrix has several advantages over this:


* Matrix provides unlimited chat history, an IRC bouncer doesn't.
* Matrix provides unlimited chat history, an IRC bouncer does not.
* The Matrix IRC bridge is much easier to setup than an IRC bouncer.
* The Matrix IRC bridge is much easier to setup than an IRC bouncer.
* The Matrix reference client [https://element.io/ (Element)] can be used from smartphones.
* The Matrix reference client [https://element.io/ (Element)] can be used from smartphones.
Line 199: Line 212:
== How does it compare with IrcsomeBot? ==
== How does it compare with IrcsomeBot? ==


IrcsomeBot is a Telegram bot that can bridge a Telegram group with an IRC channel. However there are the following shortcomings:
IrcsomeBot is a Telegram bot that can bridge a Telegram group with an IRC channel. However there are a few shortcomings:


* A KDE sysadmin needs to [https://community.kde.org/Infrastructure/IRC#Telegram_Bridge setup the bridge] between each room/channel. Matrix instead supports out of the box any freenode channel (and also other IRC networks).
* A KDE sysadmin needs to [https://community.kde.org/Infrastructure/IRC#Telegram_Bridge setup the bridge] between each room/channel. Matrix instead supports out of the box any freenode channel (and also other IRC networks).
* IrcsomeBot is the only nickname that joins the IRC channel and forwards the messages sent from Telegram on behalf of their senders. Matrix instead performs a native bridging between the two protocols and creates a real IRC user that joins the IRC channel. Other people will be able to keep the usual IRC workflow with your bridged nickname (<code>/whois</code>, <code>/query</code>, etc.). In fact, they won't even know that you are using the Matrix bridge instead of a classic IRC client.
* IrcsomeBot is the only nickname that joins the IRC channel and forwards the messages sent from Telegram on behalf of their senders. Matrix instead performs a native bridging between the two protocols and creates a real IRC user that joins the IRC channel. Other people will be able to keep the usual IRC workflow with your bridged nickname (<code>/whois</code>, <code>/query</code>, etc.). In fact, they won't even know that you are using the Matrix bridge instead of a classic IRC client.


== How do I join an IRC channel? ==
== How do I Join an IRC Channel? ==


You can search or browse IRC channels from Element. Just type the name of the channel you want to join and you are done.
You can search or browse IRC channels from Element. Just type the name of the channel you want to join and you are done.
Line 222: Line 235:
</pre>
</pre>


== How do I change my IRC nickname? ==
== How do I change My IRC nickname? ==


By default, the IRC bridge will use your matrix display name to generate an IRC nickname (ending with <tt>-M</tt>). If you don't like the default nickname, you can change it by sending the following command to the <code>@freenode-irc:kde.org</code> bot (you will need first to start a private conversation with the bot):
By default, the IRC bridge will use your matrix display name to generate an IRC nickname (ending with <tt>-M</tt>). If you don't like the default nickname, you can change it by sending the following command to the <code>@freenode-irc:kde.org</code> bot (you will need first to start a private conversation with the bot):

Revision as of 19:42, 1 March 2022

KDE is officially using Matrix for collaboration within the community, superseding more antiquated and closed-source services.

Matrix is an open standard for interoperable, decentralised, real-time communications.

Matrix is an open protocol and network for decentralized communication, backed by an open standard and open source reference implementations for servers, clients, client SDKs, bridges, bots and more. It provides all the features you would expect from a modern chat system: infinite scrollback, file transfer, typing notifications, read receipts, presence, search, push notifications, stickers, VoIP calling and conferencing, etc. It even provides end-to-end encryption (based on Signal’s double ratchet algorithm) for when you want some privacy.

Furthermore, Matrix natively supports bridges to other protocols, such as IRC (the official KDE messaging channel). This means that you can use a Matrix client to join and use IRC channels like if they were Matrix rooms.

 
Tip
If you'd rather skip reading this long wiki page and just want to start with a list of popular and common matrix rooms, you'll be interested in the KDE Matrix Space!


Clients

You can chat using your web browser by visiting KDE's webchat or you can use a desktop or mobile client. Check out a list of clients for your desktop or mobile devices.

KDE also features its own native Matrix client, NeoChat.

Registering and Logging in

On the web

THIS IS THE RECOMMENDED WAY OF REGISTERING YOUR ACCOUNT.

Even if you plan on using a desktop or mobile client later, register through the web chat since it uses all the correct defaults to get a :kde.org account.

  1. Visit KDE's online webchat
  2. Click the Create Account button.
  3. Choose a cool nickname and set your password. You can optionally include an email address if you ever need to recover your password. Click Register.

    Note: the dialog now includes a checkbox for agreement with the Privacy Policy and Terms and Conditions.


That's it! You can start chatting with members of KDE's community.

Using the Element desktop client

Download the desktop client from Element's website. APT repositories with Debian/Ubuntu packages are provided.

Choose the latest stable version number listed at Element's GitHub releases page.

Registering here follows the same process as above.

Homeserver URL: https://kde.modular.im (if you would like to use your Matrix account on KDE's Modular homeserver)

Using the Element Client for Mobile

Currently Element only supports having one account

Under Signin/Register select the Use custom server options (Advanced) option to set the following

Android

The Element client is available from Google Play and F-Droid.

iOS

There is also a client for iOS available from Apple's App Store.

Plasma Mobile

On Plasma Mobile you can use NeoChat.


Rooms

The following is a collection of active rooms where KDE development and other activities happen. Some rooms are more active than others and you're welcome to browse through them. We add new rooms as they are formed.

Welcome

New to KDE? Start here and find out what this is all about.

General KDE channel

Share your experience with the KDE community.

Plasma

System applications, frameworks and other operating systems

Distribution-centered KDE rooms

For (potential) contributors

Applications

Here is a list of individual applications that have their own Matrix rooms:

Events and goals

Local communities

How to Add Your Existing IRC Channel as Room

Note

This only needs to be done once by an IRC operator. After that all users may use the more convenient local room name to join.


  • /join #_freenode_#YOUR_CHANNEL:kde.org
  • On the IRC side you need to OP your matrix user, so either use a temporary nick on Matrix, or add multiple nicks to your IRC identity and use a different one on Matrix and IRC, or have a fellow OP give you OP privileges
  • Setup a local alias for kde.org via the matrix room settings
  • Leave room again
  • Join via local alias e.g. /join #YOUR_CHANNEL
  • Everyone can now join your room using the #YOUR_CHANNEL locally and #YOUR_CHANNEL:kde.org in Matrix

You can set up your alias depending on the client you choose. For webchat.kde.org it looks like this:

You may additionally want to mark the room as published in the directory (so one can search for it) and set the KDE flair +kde:kde.org (so a fancy KDE flair will get shown; currently not set up). Both settings on webchat.kde.org are immediately after the room settings where you created the local room alias.



Frequently Asked Questions


Why should I use the Matrix IRC Bridge?

Your IRC nickname will be available 24/7 and other people will be able to ping or contact you even if you are away from your computer. While this can also be achieved using an IRC bouncer, Matrix has several advantages over this:

  • Matrix provides unlimited chat history, an IRC bouncer does not.
  • The Matrix IRC bridge is much easier to setup than an IRC bouncer.
  • The Matrix reference client (Element) can be used from smartphones.

How does it compare with IrcsomeBot?

IrcsomeBot is a Telegram bot that can bridge a Telegram group with an IRC channel. However there are a few shortcomings:

  • A KDE sysadmin needs to setup the bridge between each room/channel. Matrix instead supports out of the box any freenode channel (and also other IRC networks).
  • IrcsomeBot is the only nickname that joins the IRC channel and forwards the messages sent from Telegram on behalf of their senders. Matrix instead performs a native bridging between the two protocols and creates a real IRC user that joins the IRC channel. Other people will be able to keep the usual IRC workflow with your bridged nickname (/whois, /query, etc.). In fact, they won't even know that you are using the Matrix bridge instead of a classic IRC client.

How do I Join an IRC Channel?

You can search or browse IRC channels from Element. Just type the name of the channel you want to join and you are done.

If your favorite matrix client doesn't have a similar feature, you can join any freenode channel by joining the following Matrix room:

#_freenode_#<irc_channel_name>:kde.org

For example, if you want to join the #kde-devel IRC channel, just type:

/join #_freenode_#kde-devel:kde.org

How do I change My IRC nickname?

By default, the IRC bridge will use your matrix display name to generate an IRC nickname (ending with -M). If you don't like the default nickname, you can change it by sending the following command to the @freenode-irc:kde.org bot (you will need first to start a private conversation with the bot):

!nick <your_favorite_irc_nickname>

How do I join an IRC channel that requires registered nicknames?

Start by opening a direct chat with NickServ. For freenode, that's @_freenode_NickServ:kde.org. Then send it a message of format:

identify [<nickname>] <password>

— where nickname is optional assuming you are identifying for your current nickname.

To make the bridge store your credentials and log in automatically, in direct chat with the @freenode-irc:kde.org you can use the !storepass <string> command to save a string that is sent in PASS command when your IRC-presence connects.

With freenode you can use:

!storepass nickname:password

How do I change my away status?

The @freenode-irc:kde.org bot accepts raw IRC commands. To set the away status use:

!cmd AWAY <away_message>

for example:

!cmd AWAY Sleeping

To remove the away status just use:

!cmd AWAY

I already have an account in the default Matrix homeserver, how do I access the KDE server and rooms with it?

After logging in to Element, you can click the compass icon next to the search bar to open the Explore Rooms dialog, click on Matrix Rooms, Add New Server..., then just type "kde.org". Now you should be able to browse the list of rooms in the KDE homeserver.

Other questions?

Check out the FAQ maintained upstream.

You can also ask questions related to matrix in #kde-matrix-support / #kde-matrix-support:kde.org