You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: administrator-guides/federation/README.md
+42-42Lines changed: 42 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,62 +2,62 @@
2
2
3
3
## Introduction
4
4
5
-
Rocket.Chat Federation allows servers to communicate with each other, with no limits on the number of connected servers.
5
+
Rocket.Chat Federation allows servers to communicate with each other, with no limits to the number of servers connected.
6
6
7
-
We use industry standards, like DNS records, keeping the process as seamless as possible, seeking the most hassle-free communication between servers.
7
+
We use industry standards, like DNS records, to keep the process as seamless as possible, and seek the most hassle-free communication between servers.
8
8
9
-
When enabling federation on your server, your server becames part of the Rocket.Chat Federated Network, which allows it to find and exchange messages and files with other Federationenabled Rocket.Chat servers.
9
+
When enabling federation on your server, your server becomes part of the Rocket.Chat Federated Network, which allows it to find and exchange messages and files with other Federation-enabled Rocket.Chat servers.
10
10
11
11
## Features
12
12
13
13
-**Current**
14
-
-Inviting users from remote servers;
15
-
- Direct chats between servers;
16
-
- Public, private and broadcast rooms with remote users from any number of servers;
17
-
- Read receipts, notifications and alerts are distributed to remote servers;
18
-
- Mute/Unmute remote users;
19
-
-File sharing among servers;
20
-
-**Confirmed next features**
21
-
- Encrypted rooms;
22
-
- Whitelist servers to communicate with;
23
-
- Better federation setup process, with helpers to validate the configuration;
14
+
-Invite users from remote servers
15
+
- Direct chats between servers
16
+
- Public, private and broadcast rooms with remote users from any number of servers
17
+
- Read receipts, notifications and alerts distributed to remote servers
18
+
- Mute/Unmute remote users
19
+
-Share files among servers
20
+
-**Confirmed Next Features**
21
+
- Encrypted rooms
22
+
- Whitelist servers to communicate with
23
+
- Better federation set-up process, with helpers to validate the configuration
24
24
25
25
## Configuration
26
26
27
-
When you open Federation's config screen, you will see this:
27
+
When you open the Federation config screen, this is what you see:
28
28
29
29
30
30
31
-
Below, a brief explanation of each configuration option:
31
+
The following is a brief explanation of each configuration option:
32
32
33
33
### Enabled
34
34
35
-
This determines whether or not Federation is enabled on this server.
35
+
It determines whether or not Federation is enabled on this server.
36
36
37
37
### Status
38
38
39
-
This is the current Federation status, which can be one of the following:
39
+
It is the current Federation status, which can be one of the following:
40
40
41
-
-**Could not enable, settings are not fully set :**Make sure all the options are correctly filled and saved;
42
-
-**Booting... :** federation is initializing;
43
-
-_[HUB Only]_**Registering with Hub... :** federation is trying to register with the Hub;
44
-
-_[HUB Only]_**Disabled, could not register with Hub :** federation could not register with the Hub;
45
-
-**Disabled :** federation is disabled
46
-
-**Running :** federation is running and ready to communicate with other servers;
41
+
-**Could not enable, settings are not fully set :**make sure all the options are correctly filled and saved
42
+
-**Booting... :**the federation is initializing
43
+
-_[HUB Only]_**Registering with Hub... :**the federation is trying to register with the Hub
44
+
-_[HUB Only]_**Disabled, could not register with Hub :**the federation could not register with the Hub
45
+
-**Disabled :**the federation is disabled
46
+
-**Running :**the federation is running and ready to communicate with other servers
47
47
48
48
### Domain
49
49
50
-
Fill this option with your domain name, usually where the Rocket.Chat server is hosted.
50
+
Fill this option with your domain name, usually the one that hosts the Rocket.Chat.
51
51
52
52
### Public Key
53
53
54
-
All Federation communications are doubleencrypted, which means messages cannot be delivered by mistake to a wrong peer. This is your public key, which is specially generated for Rocket.Chat and by Rocket.Chat, which will be shared with peers you are communicating with.
54
+
All Federation communications are double-encrypted, which means messages cannot be delivered by mistake to a wrong peer. This is your public key, which is specially generated for Rocket.Chat and by Rocket.Chat, and is shared with peers you communicate with.
55
55
56
56
The encryption process encrypts the message using the Server A private key, and the Server B public key.
57
57
58
58
When a server receives the message, it uses the Server B private key and the Server A public key to decrypt it.
59
59
60
-
So, let's say the message ended up on Server C: this server won't have Server B's private key to decrypt it, so the message can't be read at all.
60
+
So, let's say the message ended up on Server C: this server won't have Server B private key to decrypt it, so the message can't be read at all.
61
61
62
62
### Hub URL
63
63
@@ -69,17 +69,17 @@ How are you going to be found in the Rocket.Chat Federated Network? You can choo
69
69
70
70
**Important:** We recommend using the DNS method. The Hub is a tool to allow users to easily adopt, try and validate the feature or as a different way to be part of the Rocket.Chat Federated Network until DNS record changes are made. Also, the Hub requires external communication and access to a specific e-mail address owned by your domain, as explained below, which introduces extra configuration steps in some protected internal networks.
71
71
72
-
## Adding Federation to your server
72
+
## Adding Federation to your Server
73
73
74
-
You have two ways of adding your server to the Rocket.Chat Federated Network:
74
+
You have two ways to add your server to the Rocket.Chat Federated Network:
75
75
76
-
### Recommended: Configuring your DNS
76
+
### Recommended: Configure your DNS
77
77
78
-
To add your server to the Federated Network using the DNS, fill all the needed configuration fields (making sure you are picking **true** on the _Enabled_ field), pick the `DNS`_Discovery Method_ option, save and follow the guide below.
78
+
To add your server to the Federated Network using the DNS, fill all the configuration fields required. Make sure to pick `true` on the `Enabled`, and select **DNS** as your `Discovery Method` option, save and follow the guide below.
79
79
80
80
Let's suppose we have a domain named `mydomain.com`, and my Rocket.Chat server is hosted at `chat.mydomain.com`, port `80`.
81
81
82
-
You'll have to add two DNS records:
82
+
You must add two DNS records:
83
83
84
84
#### SRV Record
85
85
@@ -92,44 +92,44 @@ You'll have to add two DNS records:
92
92
- Target: `chat.mydomain.com`
93
93
- Port: `80`
94
94
95
-
In Amazon Route 53 it would look something like this:
95
+
In Amazon Route 53, it would look something like this:
- Value: `<my public key, as shown on the configuration screen>`
102
102
103
-
NOTE: Some DNS providers won't allow the full public key string to be entered so, after saving, we recommend making sure the string is complete, starting as `-----BEGIN PUBLIC KEY-----` and ending as `-----END PUBLIC KEY-----`. If that is not the case, follow your provider's instructions. For example, AWS's Route 53 needs the string to be split in two pieces, like this:
103
+
**Note**: Some DNS providers do not allow to enter the full public key string. So, after saving, make sure the string is complete: it starts as `-----BEGIN PUBLIC KEY-----` and ends as `-----END PUBLIC KEY-----`. If that is not the case, follow your provider's instructions. For example, AWS Route 53 needs to split the string in two pieces, as follows:
104
104
105
105
```
106
106
"-----BEGIN PUBLIC KEY-----...."
107
107
"...-----END PUBLIC KEY-----"
108
108
```
109
109
110
-
#### Optional: protocol TXT Record
110
+
#### Optional: Protocol TXT Record
111
111
112
-
We recommend using `HTTPS` for all kinds of communications but sometimes that is not possible. If needed, you can add a `rocketchat-protocol` entry with the desired protocol, `http` or `https`.
112
+
We recommend to use `HTTPS` for all kinds of communications, but sometimes that is not possible. If you need, add a `rocketchat-protocol` entry with the desired protocol, `http` or `https`.
113
113
114
114
- Host: `rocketchat-protocol.mydomain.com`
115
115
- Value: `http`
116
116
117
117
#### Conclusion
118
118
119
-
When at least the SRV and the Public Key TXT records are added to the DNS records, you should be able to be found by other peers after the propagation.
119
+
When at least the SRV and the Public Key TXT records are added to the DNS records, other peers should be able to find you after the propagation.
120
120
121
-
### Alternative: registering on Hub
121
+
### Alternative: Register on Hub
122
122
123
-
To add your server to the Federated Network using the Hub, fill all the needed configuration fields (making sure you are picking **true** on the _Enabled_ field), pick the `Hub`_Discovery Method_ option, save and follow the guide below.
123
+
To add your server to the Federated Network using the Hub, fill all the configuration fields needed. Make sure to pick **true** on the `Enabled` field), pick the **Hub** as your `Discovery Method` option, save and follow the guide below.
124
124
125
-
#### Confirm domain ownership
125
+
#### Confirm Domain Ownership
126
126
127
-
When you click `Save` on the federation config screen, you will begin the registration process. This process takes a few seconds and if you are not yet registered to the Hub, you should receive an email at `webmaster@mydomain.com`, where `mydomain.com` is the domain address you configured on the `Domain` field.
127
+
When you click **Save** on the Federation config screen, you begin your registration process. This process takes a few seconds and if you are not yet registered to the Hub, you should receive an email at `webmaster@mydomain.com`, where `mydomain.com` is the domain address you configured on the `Domain` field.
128
128
129
129
Make sure the data is correct and confirm the changes.
130
130
131
-
After that step, you should be able to be found on the Rocket.Chat Federated Network.
131
+
After that step, other peers should be able to find you in the Rocket.Chat Federated Network.
132
132
133
133
## Using Rocket.Chat Federation
134
134
135
-
Click [here](../../user-guides/talking-to-users-from-another-server/) to learn how to use Rocket.Chat federation.
135
+
Click [here](../../user-guides/talking-to-users-from-another-server/) to learn how to use Rocket.Chat Federation.
0 commit comments