Differences between revisions 7 and 51 (spanning 44 versions)
Revision 7 as of 2016-12-31 03:11:19
Size: 2247
Comment: clarify
Revision 51 as of 2021-08-28 21:08:23
Size: 9603
Editor: ?lifeform
Comment: Remove obsolete section "Use Let's encrypt certificate for ejabberd"
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
== Chat Server (XMPP) == ## page was renamed from FreedomBox/Manual/XMPP
#language en

##TAG:TRANSLATION-HEADER-START
~- [[de/FreedomBox/Manual/ejabberd|Deutsch]] - [[FreedomBox/Manual/ejabberd|English]] - [[es/FreedomBox/Manual/ejabberd|Español]] - [[DebianWiki/EditorGuide#translation|(+)]]-~
##TAG:TRANSLATION-HEADER-END


<<TableOfContents()>>

## BEGIN_INCLUDE

== Ejabberd (Chat Server) ==
||<tablestyle="float: right;"> {{attachment:ejabberd-icon_en_V01.png|ejabberd icon}} ||

'''Available since''': version 0.3
Line 5: Line 20:
XMPP is a federated protocol for Instant Messaging. This means that users who have accounts on one server, can talk to users that are on another server. XMPP can also be used for voice and video calls, if supported by the clients. XMPP is a federated server-client protocol for Instant Messaging. This means that users who have accounts on one server, can talk to users that are on another server.
Line 7: Line 22:
XMPP can also be used for voice and video calls, if supported by the clients.

Currently !FreedomBox offers both, a server (ejabberd) and a web client ([[FreedomBox/Manual/JSXC|JSXC]]) from its web interface.

=== Privacy ===
Line 13: Line 33:
For XMPP to work, your !FreedomBox needs to have a Domain Name that can be accessed over the public Internet. You can read more about obtaining a Domain Name in the [[../DynamicDNS|Dynamic DNS section of this manual]]. For XMPP to work, your !FreedomBox needs to have a Domain Name that can be accessed over the network.

If you only need the local network (LAN) users to chat with each other you can invent your domain name, but if you want users from the internet to join your rooms you need a
public domain name. You can read more about obtaining a Domain Name in the [[../DynamicDNS|Dynamic DNS section of this manual]].
Line 17: Line 39:
Please note that [[Pagekite]] does not support the XMPP protocol at this time. '''Note''': After changing your Domain Name, the Chat Server (XMPP) page may show that the service is not running. After a minute or so, it should be up and running again.
Line 19: Line 41:
=== Registering XMPP users through SSO === Please note that [[FreedomBox/Manual/PageKite|PageKite]] does not support the XMPP protocol at this time.
Line 21: Line 43:
Currently, all users created through Plinth will be able to login to the XMPP server. You can add new users through the System Users and Groups module. It does not matter which Groups are selected for the new user. === Registering FreedomBox users to use XMPP ===
Line 23: Line 45:
=== Using the web client === Currently, all users created through !FreedomBox will be able to login to the XMPP server. You can add new users through the System module [[FreedomBox/Manual/Users|Users and Groups]]. It does not matter which Groups are selected for the new user.
Line 25: Line 47:
After the XMPP module install completes, the JSXC web client for XMPP can be accessed at {{{https://<your freedombox>/plinth/apps/xmpp/jsxc/}}}. It will automatically check the BOSH server connection to the configured domain name. === Port Forwarding ===
Line 27: Line 49:
=== Using a desktop or mobile client === If your !FreedomBox is behind a router, you will need to set up port forwarding on your router. You should forward the following ports for XMPP:
 * TCP 5222 (client-to-server)
 * TCP 5269 (server-to-server)
Line 29: Line 53:
[[https://xmpp.org/software/clients.html|XMPP clients]] are available for various desktop and mobile platforms. === Compatible clients ===

 * !FreedomBox provides a web client: [[FreedomBox/Manual/JSXC|JSXC]].
 * [[https://xmpp.org/software/clients.html|XMPP clients]] are available for various desktop and mobile platforms. !FreedomBox links to the download sources of some of them. Feel free to include more [[https://wiki.debian.org/FreedomBox/Manual/ejabberd?action=edit&editor=text|here]] (needs free registration). We'll notice and might list them in !FreedomBox.

 {{attachment:xmpp-clients_en_V01.png|XMPP clients}}


==== FreedomBox webclient ====

For maximum simplicity !FreedomBox provides a web client: [[FreedomBox/Manual/JSXC|JSXC]]. No need for your users to install additional software on their side. They'll be able to just use their browser. This is usually the first choice for new and eventual users.

==== Mobile clients ====

You can download an XMPP client for your smartphone or tablet among the ones listed below.

===== Conversations (Android) =====

[[https://conversations.im/|Conversations]] is an Android XMPP client with videochat support available on [[https://f-droid.org/packages/eu.siacs.conversations|F-Droid]] or the [[https://play.google.com/store/apps/details?id=eu.siacs.conversations|Play Store]]. In addition to text messaging, you can use Conversations to send images and have group chats.

||<tablestyle="background:transparent; margin: 0 0 1em 1em;" style="text-align: center; padding:0.5em; border-style:none;"> {{attachment:conversations-first-screen.png|Conversations - First screen|width=200}} {{attachment:conversations-login.png|Conversations - Login|width=200}} {{attachment:conversations-add-contacts.png|Conversations - Add contacts|width=200}}||

''From left to right: (1) First screen - (2) Login screen - (3) Add contacts.''

When first starting the Conversations app, you will be asked whether you want to create a new account or if you want to use an existing account. Choose "I already have an account" (1)

With ejabberd installed, the !FreedomBox provides an XMPP account for every !FreedomBox user. Additional (non-admin) !FreedomBox user accounts can be created under '''System''' > [[FreedomBox/Manual/Users|Users and Groups]].

Once logged into a FreedomBox/XMPP account (2), the Conversation app provides a + button that brings up a few choices to contact other people (3).

===== Movim (Android) =====

[[https://movim.eu/|Movim]] is a free software XMPP client with videochat support for Android available on [[https://f-droid.org/packages/com.movim.movim/|F-Droid]].

===== ChatSecure (iOS) =====

[[https://chatsecure.org|ChatSecure]] is a free software XMPP client with videochat support available from the [[https://apps.apple.com/us/app/chatsecure/id464200063|App Store]].

===== Monal (iOS) =====

[[https://monal.im|Monal]] is a free software XMPP client with videochat support available from the [[https://apps.apple.com/us/app/monal-free-xmpp-chat/id317711500|App Store]].

===== Siskin (iOS) =====

[[https://siskin.im|Siskin]] is a free software XMPP client with videochat support available from the [[https://apps.apple.com/us/app/tigase-messenger/id1153516838|App Store]].

==== Desktop clients ====

===== Gajim (Windows, MacOS, Linux) =====

[[https://gajim.org/|Gajim]] is a XMPP open-source client for the desktop, available for Windows, MacOS and Linux. This application is available in Debian, and for other operating systems you can download it from [[https://gajim.org/download/|this page]] and find instructions about installation.

||<tablestyle="background:transparent; margin: 0 0 1em 1em;" style="text-align: center; padding:0.5em; border-style:none;"> {{attachment:gajim-first-screen.png|Gajim - First screen|width=300}} {{attachment:gajim-login.png|Gajim - Login|width=300}} {{attachment:gajim-main-window.png|Gajim - Main Window|width=200}}||

''From left to right: (1) First screen - (2) Login screen - (3) Main window''

A popup shows up right after you start Gajim for the first time (1), asking you to either login to your XMPP (!FreedomBox) account or to register for a new account.
When you choose to login, after clicking "Forward", you will be asked a Jabber ID and a password (2): you have to enter your !FreedomBox account and password here.

Finally, after logging in successfully, you will see the main Gajim screen (3). From there, you can add a contact (''Account'' > ''Add contact...'') then you can start a conversation (''Gajim'' > ''Start chat'').

===== Dino (Linux) =====

[[https://dino.im/|Dino]] is another XMPP free software client for the desktop. It is available for [[https://github.com/dino/dino/wiki/Distribution-Packages||multiple Linux distributions]].

||<tablestyle="background:transparent; margin: 0 0 1em 1em;" style="text-align: center; padding:0.5em; border-style:none;"> {{attachment:dino-first-screen.png|Dino - First screen|width=200}} {{attachment:dino-login.png|Dino - Login|width=300}} {{attachment:dino-start-conversation.png|Dino - Start a conversation|width=200}}||

''From left to right: (1) First screen - (2) Login screen - (3) Start conversation''

When first starting Dino after installation, click on the `Setup account` button. You will be then asked your `JID`: this is your !FreedomBox account. Enter it then click `Next` (2). Alternatively, you can click on `Create account` if you don't have a !FreedomBox account.

Once you have logged in, you will be able to either start a conversation with one of your XMPP contacts or to join a channel (3).

===== Movim (Linux) =====

[[https://movim.eu/|Movim]] is a free software XMPP client with videochat support for Linux. The project provides an unofficial Debian package.

===== Monal (MacOS) =====

[[https://monal.im|Monal]] is a free software XMPP client with videochat support available from the [[https://apps.apple.com/app/id1499227291?mt=12|Mac App Store]].


=== External links ===

==== Ejabberd ====
 * Website: https://www.ejabberd.im
 * User documentation: https://docs.ejabberd.im

==== Clients' sites ====
 * Conversations: https://conversations.im
 * Gajim: https://gajim.org
 * Dino: https://github.com/dino/dino
 * Movim: https://movim.eu
 * !ChatSecure: https://chatsecure.org
 * Monal: https://monal.im
 * Siskin: https://siskin.im

==== XMPP Protocol ====
 * Website: https://xmpp.org
 * Summary at Wikipedia: https://en.wikipedia.org/wiki/XMPP

Deutsch - English - Español - (+)

Ejabberd (Chat Server)

ejabberd icon

Available since: version 0.3

1. What is XMPP?

XMPP is a federated server-client protocol for Instant Messaging. This means that users who have accounts on one server, can talk to users that are on another server.

XMPP can also be used for voice and video calls, if supported by the clients.

Currently FreedomBox offers both, a server (ejabberd) and a web client (JSXC) from its web interface.

2. Privacy

With XMPP, there are two ways that conversations can be secured:

  1. TLS: This secures the connection between the client and server, or between two servers. This should be supported by all clients and is highly recommended.
  2. End-to-end: This secures the messages sent from one client to another, so that even the server cannot see the contents. The latest and most convenient protocol is called OMEMO, but it is only supported by a few clients. There is another protocol called OTR that may be supported by some clients that lack OMEMO support. Both clients must support the same protocol for it to work.

3. Setting the Domain Name

For XMPP to work, your FreedomBox needs to have a Domain Name that can be accessed over the network.

If you only need the local network (LAN) users to chat with each other you can invent your domain name, but if you want users from the internet to join your rooms you need a public domain name. You can read more about obtaining a Domain Name in the Dynamic DNS section of this manual.

Once you have a Domain Name, you can tell your FreedomBox to use it by setting the Domain Name in the System Configuration.

Note: After changing your Domain Name, the Chat Server (XMPP) page may show that the service is not running. After a minute or so, it should be up and running again.

Please note that PageKite does not support the XMPP protocol at this time.

4. Registering FreedomBox users to use XMPP

Currently, all users created through FreedomBox will be able to login to the XMPP server. You can add new users through the System module Users and Groups. It does not matter which Groups are selected for the new user.

5. Port Forwarding

If your FreedomBox is behind a router, you will need to set up port forwarding on your router. You should forward the following ports for XMPP:

  • TCP 5222 (client-to-server)
  • TCP 5269 (server-to-server)

6. Compatible clients

  • FreedomBox provides a web client: JSXC.

  • XMPP clients are available for various desktop and mobile platforms. FreedomBox links to the download sources of some of them. Feel free to include more here (needs free registration). We'll notice and might list them in FreedomBox.

    XMPP clients

6.1. FreedomBox webclient

For maximum simplicity FreedomBox provides a web client: JSXC. No need for your users to install additional software on their side. They'll be able to just use their browser. This is usually the first choice for new and eventual users.

6.2. Mobile clients

You can download an XMPP client for your smartphone or tablet among the ones listed below.

6.2.1. Conversations (Android)

Conversations is an Android XMPP client with videochat support available on F-Droid or the Play Store. In addition to text messaging, you can use Conversations to send images and have group chats.

Conversations - First screen Conversations - Login Conversations - Add contacts

From left to right: (1) First screen - (2) Login screen - (3) Add contacts.

When first starting the Conversations app, you will be asked whether you want to create a new account or if you want to use an existing account. Choose "I already have an account" (1)

With ejabberd installed, the FreedomBox provides an XMPP account for every FreedomBox user. Additional (non-admin) FreedomBox user accounts can be created under System > Users and Groups.

Once logged into a FreedomBox/XMPP account (2), the Conversation app provides a + button that brings up a few choices to contact other people (3).

6.2.2. Movim (Android)

Movim is a free software XMPP client with videochat support for Android available on F-Droid.

6.2.3. ChatSecure (iOS)

ChatSecure is a free software XMPP client with videochat support available from the App Store.

6.2.4. Monal (iOS)

Monal is a free software XMPP client with videochat support available from the App Store.

6.2.5. Siskin (iOS)

Siskin is a free software XMPP client with videochat support available from the App Store.

6.3. Desktop clients

6.3.1. Gajim (Windows, MacOS, Linux)

Gajim is a XMPP open-source client for the desktop, available for Windows, MacOS and Linux. This application is available in Debian, and for other operating systems you can download it from this page and find instructions about installation.

Gajim - First screen Gajim - Login Gajim - Main Window

From left to right: (1) First screen - (2) Login screen - (3) Main window

A popup shows up right after you start Gajim for the first time (1), asking you to either login to your XMPP (FreedomBox) account or to register for a new account. When you choose to login, after clicking "Forward", you will be asked a Jabber ID and a password (2): you have to enter your FreedomBox account and password here.

Finally, after logging in successfully, you will see the main Gajim screen (3). From there, you can add a contact (Account > Add contact...) then you can start a conversation (Gajim > Start chat).

6.3.2. Dino (Linux)

Dino is another XMPP free software client for the desktop. It is available for https://github.com/dino/dino/wiki/Distribution-Packages.

Dino - First screen Dino - Login Dino - Start a conversation

From left to right: (1) First screen - (2) Login screen - (3) Start conversation

When first starting Dino after installation, click on the Setup account button. You will be then asked your JID: this is your FreedomBox account. Enter it then click Next (2). Alternatively, you can click on Create account if you don't have a FreedomBox account.

Once you have logged in, you will be able to either start a conversation with one of your XMPP contacts or to join a channel (3).

6.3.3. Movim (Linux)

Movim is a free software XMPP client with videochat support for Linux. The project provides an unofficial Debian package.

6.3.4. Monal (MacOS)

Monal is a free software XMPP client with videochat support available from the Mac App Store.

7.1. Ejabberd

7.2. Clients' sites

7.3. XMPP Protocol

Back to Features introduction or manual pages.


Intro

Information

Support

Contribute

Reports

Promote

Vision

Hardware

Live Help

Where To Start

Translate

Calls

Talks

Overview

Download

Q&A

To Do

Design

Releases

Press

Features

Manual

Contributors

Code

Blog

FreedomBox for Communities

FreedomBox Developer Manual

HELP & DISCUSSIONS: Discussion Forum - Mailing List - #freedombox irc.debian.org | CONTACT Foundation | JOIN Project

Next call: Saturday, December 11 at 14:00 UTC

This page is copyright its contributors and is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.


CategoryFreedomBox