Unverified Commit aabbf23c authored by Faria Masood's avatar Faria Masood Committed by gitbook-bot
Browse files

GitBook: [master] 682 pages and 37 assets modified

parent 57970c3c
......@@ -82,6 +82,7 @@
* [Logging into a server](guides/user-guides/login.md)
* [Message Actions](guides/user-guides/message-actions.md)
* [Messages](guides/user-guides/messaging.md)
* [Off-the-record \(OTR\) Messaging Guide](guides/user-guides/off-the-record-otr-messaging-guide.md)
* [Registering an account](guides/user-guides/registration.md)
* [Talking to users from another server](guides/user-guides/talking-to-users-from-another-server.md)
* [Voice and Video Conferencing](guides/user-guides/voice-and-video-conferencing.md)
......
......@@ -24,7 +24,7 @@ As an administrator, you can see your _User_, _Messages_, and _Channels_ engagem
The user tab shows you the following engagement matrices.
![](../../.gitbook/assets/image%20%28129%29%20%281%29.png)
![](../../.gitbook/assets/image%20%28129%29%20%281%29%20%281%29.png)
Download the data for any matrix you want in CSV, using the download button, as shown below:
......
......@@ -11,7 +11,7 @@ The Message Auditing Panel includes the following features, allowing you or spec
* Review messages between users in the Message Auditing Panel.
* Check details in the Auditing Log about the individuals who used the Message Auditing Panel.
You access the Message Auditing Panel and the Message Auditing Log from the Administration UI ![](../../.gitbook/assets/administrator-ui%20%282%29%20%282%29%20%281%29.png).
You access the Message Auditing Panel and the Message Auditing Log from the Administration UI ![](../../.gitbook/assets/administrator-ui%20%282%29%20%282%29%20%282%29%20%281%29.png).
This feature is only available with the Enterprise and Gold versions of Rocket.Chat.
......@@ -62,7 +62,7 @@ The Message Auditing Panel returns all messages that match the search values def
Note that the auditor does not have to be a participant in the room to be able to read the messages. However, the auditor cannot read the encrypted messages of other users if they are not included in the conversation. In this case, Rocket.Chat recommends that you disable message encryption:
* Go to the Administration UI ![](../../.gitbook/assets/administrator-ui%20%282%29%20%282%29%20%282%29.png).
* Go to the Administration UI ![](../../.gitbook/assets/administrator-ui%20%282%29%20%282%29%20%282%29%20%282%29.png).
* Click **Administration**.
* Scroll down to **E2E Encryption** on the left-side menu.
......@@ -78,7 +78,7 @@ To check the details about who used the Message Auditing Panel and their search
Rocket.Chat recommends the following setting preferences to enable you to view any modified or removed messages.
* Got to the Administration UI ![](../../.gitbook/assets/administrator-ui%20%282%29%20%282%29.png).
* Got to the Administration UI ![](../../.gitbook/assets/administrator-ui%20%282%29%20%282%29%20%282%29.png).
* Click **Administration**.
* Scroll down to **Messages** on the left-side menu.
......
......@@ -96,5 +96,5 @@ Click `Save changes` in the top right corner.
On the server, login as a regular user \(not the BOT user\), go to `general` room, and try to talk to your bot by typing `@bot_rasa hello`:
![Rasa bot is talking](../../../.gitbook/assets/rasa_bot_example%20%281%29.png)
![Rasa bot is talking](../../../.gitbook/assets/rasa_bot_example%20%281%29%20%281%29.png)
......@@ -140,7 +140,7 @@ URLs: http://ngrok_public_url/webhooks/rocketchat/webhook
### Example
Type `@bot_rasa hello` to start a conversation with the Rasa bot ![example](../../.gitbook/assets/rasa_bot_example%20%281%29%20%281%29.png)
Type `@bot_rasa hello` to start a conversation with the Rasa bot ![example](../../.gitbook/assets/rasa_bot_example%20%281%29%20%281%29%20%281%29.png)
### Additional Information
......
......@@ -10,7 +10,7 @@ To access **Agents** settings:
Go to Omnichannel panel settings, as shown below:
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%282%29.png)
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%285%29%20%282%29.png)
Settings appear, as shown below:
......
......@@ -20,7 +20,7 @@ Go to Analytics in the omnichannel panel settings, as shown below:
2. Select your desired department.
![](../../../.gitbook/assets/8%20%286%29%20%281%29%20%281%29.png)
![](../../../.gitbook/assets/8%20%286%29%20%281%29%20%281%29%20%281%29.png)
3. Select your desired start date and end date.
......@@ -56,7 +56,7 @@ You can also see the **percentage of conversations**, an **average of chat durat
2. Select your desired department.
![](../../../.gitbook/assets/8%20%286%29%20%281%29.png)
![](../../../.gitbook/assets/8%20%286%29%20%281%29%20%281%29.png)
3. Select your desired start date and end date.
......
......@@ -6,7 +6,7 @@ To access **Current Chats** settings:
Go to Omnichannel panel settings, as shown below:
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%285%29.png)
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%285%29%20%285%29.png)
Settings appear, as shown below:
......
......@@ -10,7 +10,7 @@ To access **Custom Fields** settings:
Go to Omnichannel panel settings, as shown below:
![](../../../.gitbook/assets/0%20%288%29%20%285%29.png)
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%285%29.png)
Custom Fields menu appears, as shown below:
......
......@@ -11,7 +11,7 @@ To access **Livechat Triggers** settings:
Go to Omnichannel panel settings, as shown below:
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%284%29.png)
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%285%29%20%284%29.png)
Livechat Triggers menu appears, as shown below:
......
......@@ -10,7 +10,7 @@ To access **Managers** settings:
Go to Omnichannel panel settings, as shown below:
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%283%29.png)
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%285%29%20%283%29.png)
Settings appear, as shown below:
......
......@@ -10,7 +10,7 @@ To access **Monitors** settings:
Go to Omnichannel panel settings, as shown below:
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%281%29.png)
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%285%29%20%281%29.png)
Settings appear, as shown below:
......
......@@ -28,7 +28,7 @@ Send an email to [omni@rocket.chat](mailto:omni@rocket.chat) to request an API k
5. Return to the main Rocket.Chat interface. Go to Omnichannel panel settings, as shown below:
![](../../../.gitbook/assets/0%20%288%29%20%285%29.png)
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%285%29.png)
......
......@@ -9,6 +9,10 @@ description: >-
## Encryption Process Overview
{% hint style="info" %}
End-to-end encryption and its related features \(as listed below\) are currently in beta mode. If you come across problems and areas for improvement, please submit an issue in Github.
{% endhint %}
First of all, upon login, the client auto-generates the encryption password and asks the user to save it. This password is used to generate a secure 256-bit **AES-CBC** encryption key, called “**Master** **Key**”.
For using end to end encryption \(**E2EE**\), the client \(**C**\) of a user \(**U**\) needs to have a Public-Private key pair \(**Ku, Kr**\). This key pair is generated when the user logs in with a client for the first time. The public key is sent to the server and stored in the database in the User model. The private key is first encrypted using the Master key and then sent to the server for storing in the User model database. If a public-private key pair already exists in the database for the user, instead of generating it again, it is downloaded from the server. The downloaded public key is used as-is, and the encrypted private key is first decrypted using the master key. If the master key has not been decrypted client-side already, the user is prompted to enter the master key again.
......@@ -205,6 +209,12 @@ This means to request the push message content from the server to display it and
Note: This feature is **Enterprise Edition only**.
## Off-the record Messaging \(OTR\) encryption specifications
OTR is closely related to End-to-End-Encryption. It uses the same ciphers, but instead uses only the participant´s local session storage to store the keys.
Keys are exchanged, when the OTR invitation is accepted by the counterpart, that is why all participants need to be online. Messages from an OTR session are removed when the session storage is cleared.
# End to End Encryption Guide
> Note: This feature is currently in beta. Encrypted messages of encrypted rooms will not be found by search operations. The mobile apps may not support the encypted messages \(currently under implementation\). Bots may not be able to see encrypted messages until they implement support for it. Uploads will not be encrypted in this version.
> Note: This feature is currently in beta. Encrypted messages of encrypted rooms will not be found by search operations. Bots may not be able to see encrypted messages until they implement support for it. File uploads will not be encrypted in this version.
## Getting started
Once your servers admin has enabled End to End Encryption as an option you will see a banner across the top of your interface like this:
Once your server admin has enabled End to End Encryption as an option you will see a banner across the top of your interface like this:
![ ](../../.gitbook/assets/e2e-banner.png)
......
# Off-the-record \(OTR\) Messaging Guide
{% hint style="info" %}
This feature is currently in beta. Search operations will not find encrypted messages of encrypted rooms. The mobile apps and multi-DMs may not support the encrypted messages \(currently under implementation\). File Uploads will not be encrypted in this version.
{% endhint %}
Off-the-record \(OTR\) Messaging is a feature that allows users to exchange **temporary, encrypted messages directly between each other**. This happens by using the local**,** non-persistent session storage of their browser rather than storing messages on the Rocket.Chat server. After an OTR session ends and the session storage is cleared, the OTR messages are removed and can no longer be restored.
{% hint style="success" %}
OTR messages can help exchange confidential information between users without creating a record of this exchange on the server.
{% endhint %}
{% hint style="info" %}
In contrast to OTR, _end-to-end encrypted messages_ have a record on the server \(in the form of the encrypted message string\) and are persistent.
{% endhint %}
## Getting started
Prerequisites for using OTR are:
* OTR has been enabled by your server administrator \(if not, you will not be able to see OTR in the DM context menu\)
* a direct message \(DM\) room with only one other participant
* you and your DM-partner have entered their [end-to-end encryption key](https://docs.rocket.chat/guides/user-guides/end-to-end-encryption)
* you and your DM-partner are both online
## Starting an OTR conversation
_See the following steps with the sample users A and B._
_User A:_ Start the OTR conversation by clicking the DM context menu and selecting **OTR**. This will open the OTR-sidebar.
![Selecting OTR-Panel](../../.gitbook/assets/image%20%2895%29.png)
**User A:** Start OTR.
![Starting OTR-Chat](../../.gitbook/assets/image%20%28115%29.png)
_User B:_ Accept the OTR invitation.
![Accepting the invitation](../../.gitbook/assets/image%20%28129%29.png)
The following messages will be subject to the OTR session and be marked by a key-icon. Unlike end-to-end encryption, this key icon is **bold**.
![OTR messages visual display](../../.gitbook/assets/image%20%2835%29.png)
If User A or B breaks OTR \(by clearing their local session storage, e.g., refreshing the web client\), one of them needs to re-initiate the OTR session by clicking **Refresh Keys**.
![Options during OTR conversation](../../.gitbook/assets/image%20%28176%29.png)
## Ending an OTR conversation
In case User A or B wants to end the OTR session, one needs to click "End OTR". This ends the OTR session. The following messages will follow the normal configuration of the DM and be recorded on the server again. Refreshing his local session storage will make all **OTR messages disappear for the user.**
![Ending OTR conversations](../../.gitbook/assets/image%20%2847%29.png)
......@@ -2,7 +2,7 @@
To get support from us, click **Support**, as shown below:
![](../../../.gitbook/assets/image%20%28115%29%20%282%29%20%281%29.png)
![](../../../.gitbook/assets/image%20%28115%29%20%282%29%20%282%29%20%281%29.png)
......
......@@ -44,7 +44,7 @@ If you want to end your subscription, please note that it can be done only by th
This will stop your subscription and hibernate your server \(your server will still exist in case you want to get back to Rocket.Chat later\).
![](../.gitbook/assets/cancel_cloud_subscription%20%281%29%20%281%29%20%281%29.png)
![](../.gitbook/assets/cancel_cloud_subscription%20%281%29%20%281%29%20%281%29%20%281%29.png)
If you need a database dump or if you want to permanently delete your workspace and all the data associated with it - submit a ticket here on our Helpdesk or drop an email to [support@rocket.chat](mailto:support@rocket.chat) with the respective request.
......@@ -70,7 +70,7 @@ If, for example, you started your trial on December 1st, it expired on December
If your trial expired and you didn’t manage to add your payment method to continue subscription, navigate to Payment methods in your Cloud Console \([cloud.rocket.chat](https://cloud.rocket.chat/)\) -> click on **Add payment method** \(top right corner\) to add your card \(credit/debit card is the only payment method we accept at the moment\).
![](../.gitbook/assets/add_payment_method%20%281%29%20%281%29%20%281%29.png)
![](../.gitbook/assets/add_payment_method%20%281%29%20%281%29%20%281%29%20%281%29.png)
![](../.gitbook/assets/add_credit_card.png)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment