989
Comment: Added definition to Chat server page
|
2883
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
== Chat Server (XMPP) == | ## page was renamed from FreedomBox/Manual/XMPP <<TableOfContents()>> ## BEGIN_INCLUDE == ejabberd (Chat Server) == ||<tablestyle="float: right;"> {{attachment:ejabberd-icon_en_V01.png|alt="ejabberd icon"}} || |
Line 5: | Line 12: |
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 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. 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. 1. 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. |
Line 9: | Line 20: |
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 Dynamic DNS section of this manual. | 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]]. |
Line 11: | Line 22: |
Once you have a Domain Name, you can tell your !FreedomBox to use it by setting the Domain Name in the System Config. | Once you have a Domain Name, you can tell your !FreedomBox to use it by setting the Domain Name in the System [[../Configure|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. |
Line 13: | Line 25: |
Please note that Pagekite does not support the XMPP protocol at this time. | Please note that [[FreedomBox/Manual/PageKite|PageKite]] does not support the XMPP protocol at this time. |
Line 17: | Line 29: |
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. | Currently, all users created through !FreedomBox 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. === Using the web client === 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. === Using a desktop or mobile client === [[https://xmpp.org/software/clients.html|XMPP clients]] are available for various desktop and mobile platforms. === 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) |
Line 20: | Line 46: |
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages. |
Contents
ejabberd (Chat Server)
|
What is XMPP?
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.
With XMPP, there are two ways that conversations can be secured:
- 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.
- 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.
Setting the Domain Name
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 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.
Registering XMPP users through SSO
Currently, all users created through FreedomBox 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.
Using the web client
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.
Using a desktop or mobile client
XMPP clients are available for various desktop and mobile platforms.
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)
Back to Features introduction or manual pages.
Intro |
Information |
Support |
Contribute |
Reports |
Promote |
|
|
|
|||||
|
|
|
HELP & DISCUSSIONS: Discussion Forum - Matrix - Mailing List - #freedombox irc.debian.org | CONTACT Foundation | JOIN Project
Next call: Saturday, April 13 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.