Merge pull request 'CHAT_Bridges_Gateways' (#75) from CHAT_Bridges_Gateways into master
Reviewed-on: #75 Reviewed-by: meaz <meaz@no-reply@disroot.org>
This commit is contained in:
commit
9abad28d75
|
|
@ -0,0 +1,83 @@
|
|||
---
|
||||
title: 'IRC'
|
||||
published: true
|
||||
visible: true
|
||||
indexed: false
|
||||
updated:
|
||||
last_modified: March, 2021
|
||||
app: Biboumi
|
||||
app_version: 9.0
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- chat
|
||||
- xmpp
|
||||
- irc
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
# XMPP to IRC gateway
|
||||
|
||||
[**IRC**](https://en.wikipedia.org/wiki/Internet_Relay_Chat) is a real time communication protocol based on text.
|
||||
|
||||
**Disroot Chat** allows you to connect to any **IRC** channel, on any server, using your **XMPP** client of choice. This is possible thanks to [**Biboumi**](https://biboumi.louiz.org/), a gateway that connects both protocols and allows access to IRC channels as if they were XMPP rooms. Our gateway is hosted at **irc.disroot.org**
|
||||
|
||||
# How does it work?
|
||||
## Joining a channel
|
||||
To join an **IRC** channel using your **XMPP** client, use the following schema:
|
||||
|
||||
`#channelname%irc.network.tld@irc.disroot.org`
|
||||
|
||||
For example, to join **#archlinux** channel on the **Freenode IRC** network you need to use the following format:
|
||||
|
||||
`#archlinux%irc.freenode.net@irc.disroot.org`
|
||||
|
||||
Make sure to provide the correct channel name (**#channel**) and IRC server's address (**irc.network.ltd**).<br>
|
||||
**@irc.disroot.org** must remain as it is pointing to our **Biboumi**'s address.
|
||||
|
||||
## Private chats (1:1)
|
||||
The gateway also allows private chats with IRC users (1 on 1 chat). To start a private chat with a user on IRC, you need to use the following syntax:
|
||||
|
||||
`nick%irc.network.tld@irc.disroot.org`
|
||||
|
||||
Where **nick** is the username you want to talk to.
|
||||
|
||||
## Nicknames
|
||||
While on **XMPP** a user can have a different nickname for each room, **IRC** nicknames are server-wide, which means that a user only has one single nickname on all the channels of a server. So, the nickname you choose when joining an IRC channel on a given server will be the same in all other channels that you join on that same server.
|
||||
|
||||
Keep in mind that if you change your nickname on an IRC channel, it will be changed on all channels on the same server as well. To have a different nickname in a channel you are about to join, you will need to do it explicitly with the **/nick** command before joining the channel.
|
||||
|
||||
For example: `/nick yournickname` (most IRC servers limit the nickname to 9 characters)
|
||||
|
||||
# User settings
|
||||
IRC settings can be configured at three different levels:
|
||||
|
||||
1. Transport Level: `irc.disroot.org`
|
||||
2. Network Level: `irc.network.tld@irc.disroot.org`
|
||||
3. Channel Level: `#channel%irc.network.tld@irc.disroot.org`
|
||||
|
||||
If there are common options across all the levels, priority or over-ride of those settings is set in the following way:
|
||||
|
||||
`1. Channel > 2. Network > 3. Transport`
|
||||
|
||||
## Short-term / one-shot setup
|
||||
|
||||
1. Join chat `#channel%irc.network.tld@irc.disroot.org`, with a chosen nick.
|
||||
2. You will get messages from `irc.network.tld@irc.disroot.org`. If your nick is registered, send message `NickServ IDENTIFY password`.
|
||||
3. Start chatting in `#channel`.
|
||||
|
||||
To setup a **different channel** on the **same network** just repeat steps 1 and 3. To setup a **different channel** but on a **different network** then repeat steps 1 to 3.
|
||||
|
||||
## Long-term / recurring setup
|
||||
|
||||
1. Add `irc.disroot.org` to your roaster.
|
||||
2. Execute ad-hoc command on it, then enable history and persistence.
|
||||
3. Add `irc.network.tld@irc.disroot.org` to your roaster.
|
||||
4. Execute ad-hoc command on it, then add your username (nick) and password (nick password).
|
||||
5. Add `#channel%irc.network.tld@irc.disroot.org` to bookmarks and then join.
|
||||
6. Execute ad-hoc command on it, then enable history and persistence.
|
||||
7. Start chatting in `#channel`.
|
||||
|
||||
To join a **different channel** on the **same network**, repeat steps 5 to 7. But if you want to join a **different channel** on a **different network** then repeat steps 3 to 7.
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: 'Matrix bridge'
|
||||
published: true
|
||||
visible: true
|
||||
indexed: false
|
||||
updated:
|
||||
last_modified: March, 2021
|
||||
app: Bifrost
|
||||
app_version: 0.2.0
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- chat
|
||||
- xmpp
|
||||
- matrix
|
||||
- bridge
|
||||
page-toc:
|
||||
active: false
|
||||
---
|
||||
|
||||
# Matrix bridge
|
||||
You can connect to any **Matrix** room hosted on any **Matrix** server via **Bifrost Matrix bridge** (_**which is hosted by Matrix.org**_). To join a Matrix room:
|
||||
|
||||
`#room#matrix.domain.tld@matrix.org`
|
||||
|
||||
Where `#room` is the **Matrix** room you want to join and `matrix.domain.tld` is the **Matrix server address** you want to join. Make sure to leave `@matrix.org` as it is, because it's the **Matrix bridge address**.
|
||||
|
||||
!! ### IMPORTANT NOTICE
|
||||
!! As it is mentioned in the [**Bifrost**](https://github.com/matrix-org/matrix-bifrost)'s code page:<br>
|
||||
!! ###### `This bridge is in very active development currently and intended mainly for experimentation and evaluation purposes`
|
||||
!! **So please keep in mind that this "bridge" is unstable and sometimes it can be down**.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 140 KiB |
|
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
title: 'Chat: Gateways and Bridges'
|
||||
published: true
|
||||
visible: true
|
||||
indexed: true
|
||||
updated:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- chat
|
||||
- xmpp
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
# XMPP: Gateways and bridges
|
||||
|
||||
|
||||
|
||||
On the internet there are a wide variety of networks co-existing, most of them using different hardware and running different software. One way to enable communication between them is through **gateways** and **bridges**. These allow users on different platforms to communicate with each other regardless of the protocols they use.
|
||||
|
||||
Currently, **Disroot Chat** allows interaction with the following protocols:
|
||||
|
||||
## [IRC](irc)
|
||||
Learn how to use the **IRC** gateway
|
||||
|
||||
## [Matrix](matrix)
|
||||
Learn how to use the **Matrix** bridge
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 117 KiB |
|
|
@ -1,77 +0,0 @@
|
|||
---
|
||||
title: 'Chat Transports: IRC'
|
||||
published: true
|
||||
visible: true
|
||||
indexed: true
|
||||
updated:
|
||||
app: Biboumi
|
||||
app_version: 9.0
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- chat
|
||||
- xmpp
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
# XMPP <-> IRC
|
||||
|
||||
Disroot Chat provides [Biboumi](https://biboumi.louiz.org/), an IRC transport for XMPP, at irc.disroot.org.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
The syntax for connecting to IRC channel is:
|
||||
|
||||
`#channel%irc.network.tld@irc.disroot.org`
|
||||
|
||||
The syntax for connecting to IRC user is:
|
||||
|
||||
`nick%irc.network.tld@irc.disroot.org`
|
||||
|
||||
## SETTINGS
|
||||
|
||||
Settings can be configured at three different levels, by executing ad-hoc commands on respective items:
|
||||
|
||||
1. IRC-Transport Level: `irc.disroot.org`
|
||||
2. IRC-Network Level: `irc.network.tld@irc.disroot.org`
|
||||
3. IRC-Channel Level: `#channel%irc.network.tld@irc.disroot.org`
|
||||
|
||||
If there are common options across all the levels, priority or over-ride of those settings happens in the order of [3] > [2] > [1].
|
||||
|
||||
## STEPS
|
||||
|
||||
### For short-term/one-shot
|
||||
|
||||
1. Join chat `#channel%irc.network.tld@irc.disroot.org`, with a chosen nick.
|
||||
2. You'll get messages from `irc.network.tld@irc.disroot.org`. If your nick is registered, send message `NickServ IDENTIFY password`.
|
||||
3. Start chatting in `#channel`.
|
||||
|
||||
Repeat 1 and 3, for different channel on same network.
|
||||
|
||||
Repeat 1 to 3, for different channel on different network.
|
||||
|
||||
### For long-term/recurring
|
||||
|
||||
1. Add `irc.disroot.org` to your roster.
|
||||
2. Execute ad-hoc command on it, then enable history and persistence.
|
||||
3. Add `irc.network.tld@irc.disroot.org` to your roster.
|
||||
4. Execute ad-hoc command on it, then add your username (nick) and password (nick password).
|
||||
5. Add `#channel%irc.network.tld@irc.disroot.org` to bookmarks and then join.
|
||||
6. Execute ad-hoc command on it, then enable history and persistence.
|
||||
7. Start chatting in `#channel`.
|
||||
|
||||
Repeat 5 to 7, if joining different channel on same network.
|
||||
|
||||
Repeat 3 to 7, if joining different channel on different network.
|
||||
|
||||
## CLIENTS
|
||||
|
||||
Any client can be used, although only following clients are known to support ad-hoc commands.
|
||||
|
||||
### Gajim
|
||||
|
||||
1. Right-click on the roster element.
|
||||
2. Click 'Execute Command'.
|
||||
3. Follow the options.
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
---
|
||||
title: 'Chat: Transports'
|
||||
published: true
|
||||
visible: true
|
||||
indexed: true
|
||||
updated:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- chat
|
||||
- xmpp
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
# XMPP Transports
|
||||
|
||||
In XMPP realm, transports are the means to connect to different protocols.
|
||||
|
||||
Currently, Disroot Chat provides following transports:
|
||||
|
||||
1. [IRC](https://howto.disroot.org/en/tutorials/chat/transports/irc)
|
||||
Loading…
Reference in New Issue