Jump to content

Matrix and IRC: Difference between revisions

From postmarketOS Wiki
irc stuff
(26 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Note|'''Chat platforms other than IRC and Matrix are not official. [https://postmarketos.org/chats-and-social-media We advise against proprietary platforms].'''}}
{{Note|'''Chat platforms other than IRC and Matrix are not official. [https://postmarketos.org/chats-and-social-media We advise against proprietary platforms].'''}}


Please join our chat, so we can help you with using postmarketOS in real time. The chat is bridged between Matrix and IRC. We also provide an offtopic channel, which can be used to discuss your favorite pizza API and other non-related topics with the postmarketOS community.
Please join our chat, so we can help you with using postmarketOS in real time.
 
The chat is bridged between Matrix and IRC, which means whatever you send in IRC will be received on Matrix, and vice-versa, so you can talk to use regardless of what chat platform (IRC or Matrix) you use.
 
We also provide an off-topic channel, which can be used to discuss your favorite pizza API and other topics unrelated to the postmarketOS community.


Here's a list of channels. Either join them manually using a native client or click on the name to open a web client.
Here's a list of channels. Either join them manually using a native client or click on the name to open a web client.
Once connected, go straight to the [https://wiki.postmarketos.org/wiki/Matrix_and_IRC#Help_and_guidelines_for_new_IRC_and_Matrix_users Help and guidelines for new IRC and Matrix users] section before asking.


{| class="wikitable"
{| class="wikitable"
Line 9: Line 15:
! Topic !! IRC !! Matrix
! Topic !! IRC !! Matrix
|-
|-
| Main channel, for user questions and general discussion || [https://webchat.oftc.net/?channels=postmarketos #postmarketos] || [https://matrix.to/#/#main:postmarketos.org #main:postmarketos.org]
| Main channel, for user questions and general discussion || {{IRC channel|#postmarketos}} || {{Matrix channel|#main:postmarketos.org}}
|-
| For device porting, getting kernels to compile, ... || {{IRC channel|#postmarketos-porting}} || {{Matrix channel|#porting:postmarketos.org}}
|-
| For coordination on audio related issues and improvements || {{IRC channel|#postmarketos-audio}} || {{Matrix channel|#audio:postmarketos.org}}
|-
| For discussing integration and development of systemd || {{IRC channel|#postmarketos-systemd}} || {{Matrix channel|#systemd:postmarketos.org}}
|-
|-
| For device porting, getting kernels to compile, ... || [https://webchat.oftc.net/?channels=postmarketos-porting #postmarketos-porting] || [https://matrix.to/#/#porting:postmarketos.org #porting:postmarketos.org]
| For discussing development on systemd polyfills and alternatives || {{IRC channel|#postmarketos-openrc}} || {{Matrix channel|#openrc:postmarketos.org}}
|-
|-
| For discussing integration and development of systemd || [https://webchat.oftc.net/?channels=postmarketos-systemd #postmarketos-systemd] || [https://matrix.to/#/#systemd:postmarketos.org #systemd:postmarketos.org]
| For all other postmarketOS development, e.g. pmbootstrap, tools, ... || {{IRC channel|#postmarketos-devel}} || {{Matrix channel|#devel:postmarketos.org}}
|-
|-
| For discussing development on systemd polyfills and alternatives || [https://webchat.oftc.net/?channels=postmarketos-openrc #postmarketos-openrc] || [https://matrix.to/#/#openrc:postmarketos.org #openrc:postmarketos.org]
| Mainline kernel development || {{IRC channel|#postmarketos-mainline}} || {{Matrix channel|#mainline:postmarketos.org}}
|-
|-
| For all other postmarketOS development, e.g. pmbootstrap, tools, ... || [https://webchat.oftc.net/?channels=postmarketos-devel #postmarketos-devel] || [https://matrix.to/#/#devel:postmarketos.org #devel:postmarketos.org]
| Bootloader hacking, assembly, etc. See also [[:Category:Low-level]] || {{IRC channel|#postmarketos-lowlevel}} || {{Matrix channel|#lowlevel:postmarketos.org}}
|-
|-
| Mainline kernel development || [https://webchat.oftc.net/?channels=postmarketos-mainline #postmarketos-mainline] || [https://matrix.to/#/#mainline:postmarketos.org #mainline:postmarketos.org]
| Announcements for maintainers, for [[Creating_a_release_branch#Timeline|testing new releases]] || {{IRC channel|#postmarketos-release-party}} || {{Matrix channel|#testing:postmarketos.org}}
|-
|-
| Bootloader hacking, assembly, etc. See also [[:Category:Low-level]] || [https://webchat.oftc.net/?channels=postmarketos-lowlevel #postmarketos-lowlevel] || [https://matrix.to/#/#lowlevel:postmarketos.org #lowlevel:postmarketos.org]
| [https://gitlab.postmarketos.org/postmarketOS/mobile-config-firefox/ mobile-config-firefox] discussions || {{IRC channel|#mobile-config-firefox}} || {{Matrix channel|#mobile-config-firefox:postmarketos.org}}
|-
|-
| Announcements for maintainers, for [[Creating_a_release_branch#Timeline|testing new releases]] || [https://webchat.oftc.net/?channels=postmarketos-release-party #postmarketos-release-party] || [https://matrix.to/#/#release-party:postmarketos.org #release-party:postmarketos.org]
| For discussion about events and conferences || (unavailable) || {{Matrix channel|#events:postmarketos.org}}
|-
|-
| Other topics || [https://webchat.oftc.net/?channels=postmarketos-offtopic #postmarketos-offtopic] || [https://matrix.to/#/#offtopic:postmarketos.org #offtopic:postmarketos.org]
| Other topics || {{IRC channel|#postmarketos-offtopic}} || {{Matrix channel|#offtopic:postmarketos.org}}
|}
|}


Line 35: Line 47:
On postmarketOS phones, you can even try clients listed in [[Applications by category#Matrix]].
On postmarketOS phones, you can even try clients listed in [[Applications by category#Matrix]].


The easiest is to join the Matrix space: [https://matrix.to/#/#space:postmarketos.org #space:postmarketos.org] (might not be supported by all clients).
The easiest is to join the Matrix space: {{Matrix channel|#space:postmarketos.org}} (might not be supported by all clients).
This groups all available rooms together.
This groups all available rooms together.


Line 45: Line 57:
[[File:TheLounge_Logomark.png|thumb|right|384px|IRC client [https://thelounge.chat/ TheLounge]]]
[[File:TheLounge_Logomark.png|thumb|right|384px|IRC client [https://thelounge.chat/ TheLounge]]]


Point your client to OFTC using the following parameters:
OFTC hosts the postmarketOS channels. If you wish to use your own IRC client to chat, point it to OFTC using the following parameters:


* Network address: irc.oftc.net
* Network address: <code>irc.oftc.net</code>
* Port: 6697 (SSL)
* Port: 6697
* SSL/TLS encryption: enabled
 
If you are having trouble joining the postmarketOS IRC channels, double-check if you are connected to OFTC ''with TLS/SSL encryption enabled''. The postmarketOS channels currently disallow users not connecting securely from joining, and you may get a message similar to <code>You must connect via SSL to join this channel (+S)</code> if you are trying to join but are not connected securely. Consult your IRC client's documentation to enable TLS/SSL encryption.
 
The easiest is, if you're using a web client, to join all channels at once: [https://webchat.oftc.net/?channels=postmarketos%2Cpostmarketos-porting%2Cpostmarketos-audio%2Cpostmarketos-systemd%2Cpostmarketos-openrc%2Cpostmarketos-devel%2Cpostmarketos-mainline%2Cpostmarketos-lowlevel%2Cpostmarketos-release-party%2Cmobile-config-firefox%2Cpostmarketos-offtopic join all channels]. The web client enables you to chat on the IRC channels right from your web browser. Alternatively you can run the following command on your IRC client:
 
<syntaxhighlight lang=text>
/join #postmarketos,#postmarketos-porting,#postmarketos-audio,#postmarketos-systemd,#postmarketos-openrc,#postmarketos-devel,#postmarketos-mainline,#postmarketos-lowlevel,#postmarketos-release-party,#mobile-config-firefox,#postmarketos-offtopic
</syntaxhighlight>


The easiest is, if you're using a web client, to join all channels at once: [https://webchat.oftc.net/?channels=postmarketos%2Cpostmarketos-porting%2Cpostmarketos-devel%2Cpostmarketos-mainline%2Cpostmarketos-lowlevel%2Cpostmarketos-release-party%2Cpostmarketos-offtopic%2Cpostmarketos-systemd%2Cpostmarketos-openrc join all channels]
On postmarketOS phones, you can even try clients listed in [[Applications by category#IRC]].
On postmarketOS phones, you can even try clients listed in [[Applications by category#IRC]].


{{note|Due to abuse, Tor users without a cloak are quieted. If you're connecting through Tor, you must register your nick and get a cloak before you can talk.}}
{{note|Due to abuse, Tor users without a ''cloak'' or ''virtual host'' are quieted. If you're connecting through Tor, you must register your nick and get a cloak before you can talk, see [[#Register your username on IRC side]].}}
 
== Moderation requests ==
 
For spam and CoC-related matters, or if you would like to get in touch with the chat moderation team, ask in:
 
* {{IRC channel|#postmarketos-modreq}} or {{Matrix channel|#modreq:postmarketos.org}}
 
Those channels are '''only''' meant for urgent moderation needs; '''user support question go in the main #postmarketos channel'''.
 
Additionally, to ensure anonymity, please '''do not idle in the channel'''.  Join only when you need something from the moderation team, and leave the channel after your request has been handled.  The channels are '''not''' meant for ban appeals.  Email the CoC team: '''help@postmarketos.org'''  instead.


== Help and guidelines for new IRC and Matrix users ==
== Help and guidelines for new IRC and Matrix users ==


As with every Matrix room and IRC channel, we encourage you to stay around for a while after you ask a question, and listen to the various discussions.
As with every Matrix room and IRC channel, we encourage you to stay around for a while after you ask a question, and listen to the various discussions.
Some people usually read everything that happens there, so it is likely that someone will answer you ''if they have the answer''.


Due to this, please make extensive use of the off-topic channel to lower the noise in the others, and make the lives of those who read the entire ''backlog'' easier. Also note that everyone doesn't read every channel; if you want to draw someone's attention, type their name to ''ping'' them (doing this too often is considered rude, though). To prevent flooding the channel, please also use a service like https://bpaste.net/ instead of pasting your logs directly.
While the channels are often very active and you may be able to get an answer minutes after asking, sometimes an answer can take hours and in rare occasions can even take a day. Don't leave right after asking your question, or ask to ask, just go straight to your question, and wait! Give us as much info as possible, such as logs, which device you're using, etc, so we can help you. Many usually read everything that happens there, so it is likely that someone will answer you ''if they have the answer''.


Remember that when you close your IRC client to go sleep, you miss out on half the planet. Please consider either setting up an IRC bouncer or using Matrix for offline history and better rich-media support.
Due to this, please make extensive use of the off-topic channel to lower the noise in the others, and make the lives of those who read the entire ''backlog'' easier. Also note that everyone doesn't read every channel; if you want to draw someone's attention, type their name to ''ping'' them (doing this too often is considered rude, though). To prevent flooding the channel, please also use a pastebin service like https://bpaste.net/ instead of pasting your logs directly.
 
Remember that when you close your IRC client to go sleep, you miss out on half the planet. Please consider either setting up an IRC bouncer or using Matrix for offline history, or simply keep your IRC client open.
 
Be respectful and have nice discussions with everyone, follow the [https://postmarketos.org/coc Code of Conduct].


Special note for Matrix users: You can set the notifications setting to "Mentions only" so that you will only disturbed when someone writes your name.
Special note for Matrix users: You can set the notifications setting to "Mentions only" so that you will only disturbed when someone writes your name.
Line 73: Line 106:
* Verify your account at [https://services.oftc.net/ services.oftc.net]
* Verify your account at [https://services.oftc.net/ services.oftc.net]
* Login by sending this to NickServ: <code>identify <password> <nickname></code>
* Login by sending this to NickServ: <code>identify <password> <nickname></code>
* To get a cloak, send this to NickServ: <code>set cloak on</code>


It's recommended to setup SSL CertFP on your client for automatic login. Instructions for IRC clients are [https://oftc.net/NickServ/CertFP/ here]. Unfourtunately, autologin with Matrix is broken (for years now).
It is recommended to setup SSL CertFP on your client for automatic login. Instructions for IRC clients are [https://oftc.net/NickServ/CertFP/ here]. Unfourtunately, autologin with Matrix is broken so you will need to identify manually every time.
 
== Room robots ==
Rooms have a Matrix robot using the account @robot:postmarketos.org which helps with administration (banning users, syncing rooms, etc.). Only team members can access the admin functions, but it will respond with useful context about <code>pmaports</code> issues or MRs if you refer to them by number like <code>pma!345</code> for MRs and <code>pma#567</code> for issues.
 
== Bridging a new postmarketOS channel (team members only) ==
 
=== Requirements ===


* An IRC client and a NickServ account with permissions on IRC side (must have +o for the bridging process)
Any questions related to OFTC should go in their IRC support channel, <code>#oftc</code>.
* Admin permissions on Matrix side


=== How-to ===
== Bots ==
All channels have a bot using the Matrix account <code>@robot:postmarketos.org</code>, and connecting to IRC under the nicks <code>pmosbot</code> and <code>pmosbot_</code> (actually the bridged Matrix user). It helps with administration (banning users, syncing rooms, etc.). Only team members can access the admin functions, but it will respond with useful context about repository issues or merge requests if you refer to them by number like <code>[alias]![id]</code> for MRs and <code>[alias]#[id]</code> for issues.


* In Element, click on the "Room info" icon, then "Add widgets, bridges & bots"
<code>[alias]</code> can be any of the following:
* Click on "IRC Bridge (OFTC)", then enter the IRC channel name
* Enter your IRC nick (which must have +o in the IRC channel)
* Click on "Request link"
* On IRC, you should have received a message similar to this:
** <source>
<MatrixBridge> @myself:matrix.org has requested to bridge 'postmarketOS new channel' (https://matrix.to/#/#postmarketos-channel:matrix.org) with #postmarketos-new-channel on this IRC network. Respond with 'yes' or 'y' to allow, or simply ignore this message to disallow. You have 300 seconds from when this message was sent.
</source>
* Send <code>yes</code> or <code>y</code> to MatrixBridge
* Both channels should now be bridged, now proceed to setting up the bridge


=== Setting up the bridge ===
<pre>
pma        = gitlab.postmarketos.org/postmarketOS/pmaports
org        = gitlab.postmarketos.org/postmarketOS/postmarketos.org
pmb        = gitlab.postmarketos.org/postmarketOS/pmbootstrap
art        = gitlab.postmarketos.org/postmarketOS/artwork
bpo        = gitlab.postmarketos.org/postmarketOS/build.postmarketos.org
mrh        = gitlab.postmarketos.org/postmarketOS/mrhlpr
osk        = gitlab.postmarketos.org/postmarketOS/osk-sdl
wiki        = gitlab.postmarketos.org/postmarketOS/wiki
relup      = gitlab.postmarketos.org/postmarketOS/postmarketos-release-upgrade
megapixels  = gitlab.postmarketos.org/postmarketOS/megapixels
boot-deploy = gitlab.postmarketos.org/postmarketOS/boot-deploy
welcome    = gitlab.postmarketos.org/postmarketOS/postmarketos-welcome
bot        = gitlab.postmarketos.org/postmarketOS/jonathan
pmos        = gitlab.postmarketos.org/postmarketOS/postmarketos
mcf        = gitlab.postmarketos.org/postmarketOS/mobile-config-firefox
</pre>


* In Element, type <code>/devtools</code>
For example:
* Click on "Explore room state", then "Send custom state event"
<pre>
* Enter the following:
> Hmm, bot!5 CI seems to fail for some reason..
** Event Type: <code>org.matrix.appservice-irc.config</code>
* pmosbot_: [!5, opened] Don't react on quoted messages: https://gitlab.postmarketos.org/postmarketOS/jonathan/-/merge_requests/5
** State Key: (empty)
</pre>
** Event content:
*** <source>
{
  "lineLimit": 10
}
</source>
* Click on "Send"


== See also ==
== See also ==

Revision as of 11:04, 26 March 2025

Note Chat platforms other than IRC and Matrix are not official. We advise against proprietary platforms.

Please join our chat, so we can help you with using postmarketOS in real time.

The chat is bridged between Matrix and IRC, which means whatever you send in IRC will be received on Matrix, and vice-versa, so you can talk to use regardless of what chat platform (IRC or Matrix) you use.

We also provide an off-topic channel, which can be used to discuss your favorite pizza API and other topics unrelated to the postmarketOS community.

Here's a list of channels. Either join them manually using a native client or click on the name to open a web client.

Once connected, go straight to the Help and guidelines for new IRC and Matrix users section before asking.

Topic IRC Matrix
Main channel, for user questions and general discussion #postmarketos (on OFTC) #main:postmarketos.org (on Matrix)
For device porting, getting kernels to compile, ... #postmarketos-porting (on OFTC) #porting:postmarketos.org (on Matrix)
For coordination on audio related issues and improvements #postmarketos-audio (on OFTC) #audio:postmarketos.org (on Matrix)
For discussing integration and development of systemd #postmarketos-systemd (on OFTC) #systemd:postmarketos.org (on Matrix)
For discussing development on systemd polyfills and alternatives #postmarketos-openrc (on OFTC) #openrc:postmarketos.org (on Matrix)
For all other postmarketOS development, e.g. pmbootstrap, tools, ... #postmarketos-devel (on OFTC) #devel:postmarketos.org (on Matrix)
Mainline kernel development #postmarketos-mainline (on OFTC) #mainline:postmarketos.org (on Matrix)
Bootloader hacking, assembly, etc. See also Category:Low-level #postmarketos-lowlevel (on OFTC) #lowlevel:postmarketos.org (on Matrix)
Announcements for maintainers, for testing new releases #postmarketos-release-party (on OFTC) #testing:postmarketos.org (on Matrix)
mobile-config-firefox discussions #mobile-config-firefox (on OFTC) #mobile-config-firefox:postmarketos.org (on Matrix)
For discussion about events and conferences (unavailable) #events:postmarketos.org (on Matrix)
Other topics #postmarketos-offtopic (on OFTC) #offtopic:postmarketos.org (on Matrix)

Matrix

Matrix client Element

In case you have no experience in using IRC, this is a method similar to mainstream chat platforms.

On postmarketOS phones, you can even try clients listed in Applications by category#Matrix.

The easiest is to join the Matrix space: #space:postmarketos.org (on Matrix) (might not be supported by all clients). This groups all available rooms together.

After you register at any Matrix homeserver and join the channel, the offline history will be saved automatically. So, your questions can be answered even when you are offline!

Note: Our rooms are public & everyone can access the history even if you are not a registered Matrix user.

IRC

IRC client TheLounge

OFTC hosts the postmarketOS channels. If you wish to use your own IRC client to chat, point it to OFTC using the following parameters:

  • Network address: irc.oftc.net
  • Port: 6697
  • SSL/TLS encryption: enabled

If you are having trouble joining the postmarketOS IRC channels, double-check if you are connected to OFTC with TLS/SSL encryption enabled. The postmarketOS channels currently disallow users not connecting securely from joining, and you may get a message similar to You must connect via SSL to join this channel (+S) if you are trying to join but are not connected securely. Consult your IRC client's documentation to enable TLS/SSL encryption.

The easiest is, if you're using a web client, to join all channels at once: join all channels. The web client enables you to chat on the IRC channels right from your web browser. Alternatively you can run the following command on your IRC client:

/join #postmarketos,#postmarketos-porting,#postmarketos-audio,#postmarketos-systemd,#postmarketos-openrc,#postmarketos-devel,#postmarketos-mainline,#postmarketos-lowlevel,#postmarketos-release-party,#mobile-config-firefox,#postmarketos-offtopic

On postmarketOS phones, you can even try clients listed in Applications by category#IRC.

Note Due to abuse, Tor users without a cloak or virtual host are quieted. If you're connecting through Tor, you must register your nick and get a cloak before you can talk, see #Register your username on IRC side.

Moderation requests

For spam and CoC-related matters, or if you would like to get in touch with the chat moderation team, ask in:

Those channels are only meant for urgent moderation needs; user support question go in the main #postmarketos channel.

Additionally, to ensure anonymity, please do not idle in the channel. Join only when you need something from the moderation team, and leave the channel after your request has been handled. The channels are not meant for ban appeals. Email the CoC team: help@postmarketos.org instead.

Help and guidelines for new IRC and Matrix users

As with every Matrix room and IRC channel, we encourage you to stay around for a while after you ask a question, and listen to the various discussions.

While the channels are often very active and you may be able to get an answer minutes after asking, sometimes an answer can take hours and in rare occasions can even take a day. Don't leave right after asking your question, or ask to ask, just go straight to your question, and wait! Give us as much info as possible, such as logs, which device you're using, etc, so we can help you. Many usually read everything that happens there, so it is likely that someone will answer you if they have the answer.

Due to this, please make extensive use of the off-topic channel to lower the noise in the others, and make the lives of those who read the entire backlog easier. Also note that everyone doesn't read every channel; if you want to draw someone's attention, type their name to ping them (doing this too often is considered rude, though). To prevent flooding the channel, please also use a pastebin service like https://bpaste.net/ instead of pasting your logs directly.

Remember that when you close your IRC client to go sleep, you miss out on half the planet. Please consider either setting up an IRC bouncer or using Matrix for offline history, or simply keep your IRC client open.

Be respectful and have nice discussions with everyone, follow the Code of Conduct.

Special note for Matrix users: You can set the notifications setting to "Mentions only" so that you will only disturbed when someone writes your name.

Register your username on IRC side

Some channels may not allow you to speak unless you register your nick.

  • Open a new chat with "NickServ" (Matrix: open a new chat with @_oftc_NickServ:matrix.org)
  • Register your account by sending this to NickServ: register <password> <email> (example: register dhg235h234jbb you@hello.world)
  • Verify your account at services.oftc.net
  • Login by sending this to NickServ: identify <password> <nickname>
  • To get a cloak, send this to NickServ: set cloak on

It is recommended to setup SSL CertFP on your client for automatic login. Instructions for IRC clients are here. Unfourtunately, autologin with Matrix is broken so you will need to identify manually every time.

Any questions related to OFTC should go in their IRC support channel, #oftc.

Bots

All channels have a bot using the Matrix account @robot:postmarketos.org, and connecting to IRC under the nicks pmosbot and pmosbot_ (actually the bridged Matrix user). It helps with administration (banning users, syncing rooms, etc.). Only team members can access the admin functions, but it will respond with useful context about repository issues or merge requests if you refer to them by number like [alias]![id] for MRs and [alias]#[id] for issues.

[alias] can be any of the following:

pma         = gitlab.postmarketos.org/postmarketOS/pmaports
org         = gitlab.postmarketos.org/postmarketOS/postmarketos.org
pmb         = gitlab.postmarketos.org/postmarketOS/pmbootstrap
art         = gitlab.postmarketos.org/postmarketOS/artwork
bpo         = gitlab.postmarketos.org/postmarketOS/build.postmarketos.org
mrh         = gitlab.postmarketos.org/postmarketOS/mrhlpr
osk         = gitlab.postmarketos.org/postmarketOS/osk-sdl
wiki        = gitlab.postmarketos.org/postmarketOS/wiki
relup       = gitlab.postmarketos.org/postmarketOS/postmarketos-release-upgrade
megapixels  = gitlab.postmarketos.org/postmarketOS/megapixels
boot-deploy = gitlab.postmarketos.org/postmarketOS/boot-deploy
welcome     = gitlab.postmarketos.org/postmarketOS/postmarketos-welcome
bot         = gitlab.postmarketos.org/postmarketOS/jonathan
pmos        = gitlab.postmarketos.org/postmarketOS/postmarketos
mcf         = gitlab.postmarketos.org/postmarketOS/mobile-config-firefox

For example:

 > Hmm, bot!5 CI seems to fail for some reason..
 * pmosbot_: [!5, opened] Don't react on quoted messages: https://gitlab.postmarketos.org/postmarketOS/jonathan/-/merge_requests/5

See also