Unverified Commit 4fb543a3 authored by Faria Masood's avatar Faria Masood Committed by gitbook-bot

GitBook: [master] 21 pages and 46 assets modified

parent 06af028a
......@@ -26,7 +26,7 @@ When calling a production Rocket.Chat server, ensure it is running via HTTPS and
| `/api/v1/spotlight` | Searches for users or rooms that are visible to the user. | [Link](methods/miscellaneous/spotlight.md) |
| `/api/v1/statistics` | Statistics about the Rocket.Chat server. | [Link](methods/miscellaneous/statistics.md) |
| `/api/v1/statistics.list` | Selectable statistics about the Rocket.Chat server. | [Link](methods/miscellaneous/statistics-list.md) |
| `/api/v1/instances.get` | Gets all running instances. | [Link](methods/miscellaneous/instances-get.md) |
| `/api/v1/instances.get` | Gets all running instances. | [Link](https://github.com/RocketChat/docs/tree/06af028aecca9430169baa3f517704a68deb6278/api/rest-api/methods/miscellaneous/instances-get.md) |
### Assets
......@@ -354,10 +354,11 @@ When calling a production Rocket.Chat server, ensure it is running via HTTPS and
| `/api/v1/webdav.getMyAccounts` | Retrieves the user's webdav accounts. | [Link](methods/webdav/getmyaccounts.md) |
### Licenses
| Url | Method | Short Description | Details Page |
| :--- | :--- | :--- | :--- |
| `/api/v1/licenses.get` | `GET` | Gets all active licenses. | [Link](methods/licenses/get.md) |
| `/api/v1/licenses.add` | `POST` | Adds a new license. | [Link](methods/licenses/add.md) |
| `/api/v1/licenses.get` | `GET` | Gets all active licenses. | [Link](https://github.com/RocketChat/docs/tree/06af028aecca9430169baa3f517704a68deb6278/api/rest-api/methods/licenses/get.md) |
| `/api/v1/licenses.add` | `POST` | Adds a new license. | [Link](https://github.com/RocketChat/docs/tree/06af028aecca9430169baa3f517704a68deb6278/api/rest-api/methods/licenses/add.md) |
## Language specific wrappers
......
......@@ -14,5 +14,5 @@ Just some generic information, such as information about the server and authenti
| `/api/v1/spotlight` | Searches for users or rooms that are visible to the user. | [Link](spotlight.md) |
| `/api/v1/statistics` | Statistics about the Rocket.Chat server. | [Link](statistics.md) |
| `/api/v1/statistics.list` | Selectable statistics about the Rocket.Chat server. | [Link](statistics-list.md) |
| `/api/v1/instances.get` | Gets all running instances. | [Link](methods/miscellaneous/instances-get.md) |
| `/api/v1/instances.get` | Gets all running instances. | [Link](https://github.com/RocketChat/docs/tree/06af028aecca9430169baa3f517704a68deb6278/api/rest-api/methods/miscellaneous/methods/miscellaneous/instances-get.md) |
......@@ -16,7 +16,7 @@ This is the URL provided by your IdP for logging out. In SAML-terminology, it re
### Custom Issuer \(SP entityID\)
The URI that is the unique identifier of your service. By convention, this is also the URL of your \(unedited\) metadata. Again, where you set Custom Provider to 'my-app', this will be:
The URI is the unique identifier of your service. By convention, this is also the URL of your \(unedited\) metadata. Again, where you set Custom Provider to 'my-app', this will be:
`https://my-rocketchat-domain.tld/_saml/metadata/my-app`
......@@ -32,17 +32,17 @@ Format for this is PEM WITH `-----BEGIN CERTIFICATE-----` and `-----END CERTIFIC
### Private Key Contents \(SP Signing Private Key\)
The private key matching the self-signed certificate you created as PKCS\#1 PEM. Format for this is PEM WITH `-----BEGIN PRIVATE KEY-----` and `-----END PRIVATE KEY-----`.
The private key matches the self-signed certificate you created as PKCS\#1 PEM. Format for this is PEM WITH `-----BEGIN PRIVATE KEY-----` and `-----END PRIVATE KEY-----`.
### SAML Assertion
You must to send the **Email** field in your assertion, or it doesn't work. When the email matches the existing user, it overwrites the user's username with the username value, if that is in your assertion.
You must send the **Email** field in your assertion, or it doesn't work. When the email matches the existing user, it overwrites the user's username with the username value, if that is in your assertion.
### SAML Encryption
SAML Assertions encryption on **either** site might not work and cause signature validation to fail. See [\#10556](https://github.com/RocketChat/Rocket.Chat/issues/10556) for a more up to date information to this issue.
SAML Assertions encryption on **either** site might not work and cause signature validation to fail. See [\#10556](https://github.com/RocketChat/Rocket.Chat/issues/10556) for more up to date information on this issue.
As a popular open source IdP, SimpleSAMLphp can be used to provide an authentication endpoint for Rocket.Chat and the build in SAML support. Assuming that you have a SimpleSAMLphp IdP up and running - [quickstart instructions here](https://simplesamlphp.org/docs/stable/simplesamlphp-idp), you can find the metadata for the Rocket.Chat SAML Service Provider \(SP\) here, where 'my-app' is whatever you put in the **Custom Provider** box in the Rocket.Chat SAML admin page:
As a popular open-source IdP, SimpleSAMLphp can be used to provide an authentication endpoint for Rocket.Chat and the build-in SAML support. Assuming that you have a SimpleSAMLphp IdP up and running - [quickstart instructions here](https://simplesamlphp.org/docs/stable/simplesamlphp-idp), you can find the metadata for the Rocket.Chat SAML Service Provider \(SP\) here, where 'my-app' is whatever you put in the **Custom Provider** box in the Rocket.Chat SAML admin page:
`https://my-rocketchat-domain.tld/_saml/metadata/my-app`
......
......@@ -16,7 +16,7 @@ To access the **Engagement Dashboard:**
2. Click **Engagement Dashboard**.
![](../../.gitbook/assets/image%20%28139%29%20%281%29.png)
![](../../.gitbook/assets/image%20%28139%29%20%281%29%20%281%29.png)
As an administrator, you can see your _User_, _Messages_, and _Channels_ engagement here.
......@@ -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.png)
![](../../.gitbook/assets/image%20%28129%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%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%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.png).
* Go to the Administration UI ![](../../.gitbook/assets/administrator-ui%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.png).
* Got to the Administration UI ![](../../.gitbook/assets/administrator-ui%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.png)
![Rasa bot is talking](../../../.gitbook/assets/rasa_bot_example%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.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.png)
### Additional Information
......
......@@ -93,7 +93,7 @@ Here we will show you how to customize:
![](https://lh3.googleusercontent.com/o3iotTRPf5V7C6PZiZ9SYwWR_suvnW8mflVSABFaRaRzRuKm4SBRrbLiAVceStFpj7WWGs3xNJO_2cqT7EeRxet9fQoX7MYuUWjLfOBhScEXt5HZVB1XEQxtYrH5Oh8juv1Iz0hu)
![](../../../.gitbook/assets/image%20%2835%29%20%281%29.png)
![](../../../.gitbook/assets/image%20%2835%29%20%281%29%20%281%29.png)
* Set the same keychain group on `RocketChatRN/Info.plist`, `ShareRocketChatRN/Info.plist` and `NotificationService/Info.plist`
......@@ -113,7 +113,7 @@ Here we will show you how to customize:
* Change the app icon on `Experimental.xcassets/App Icon`
![](../../../.gitbook/assets/image%20%28178%29.png)
![](../../../.gitbook/assets/image%20%28178%29%20%281%29.png)
* Change the app splash screen on `Experimental.xcassets/Launch Screen Icon`
......
......@@ -10,7 +10,7 @@ To access **Agents** settings:
Go to Omnichannel panel settings, as shown below:
![](../../../.gitbook/assets/0%20%288%29%20%282%29.png)
![](../../../.gitbook/assets/0%20%288%29%20%285%29%20%282%29.png)
Settings appear, as shown below:
......
......@@ -20,11 +20,11 @@ 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.png)
![](../../../.gitbook/assets/8%20%286%29%20%281%29%20%281%29.png)
3. Select your desired start date and end date.
![](../../../.gitbook/assets/9%20%285%29%20%281%29.png)
![](../../../.gitbook/assets/9%20%285%29%20%281%29%20%281%29.png)
### Details of conversation matrices:
......@@ -56,11 +56,11 @@ You can also see the **percentage of conversations**, an **average of chat durat
2. Select your desired department.
![](../../../.gitbook/assets/8%20%286%29.png)
![](../../../.gitbook/assets/8%20%286%29%20%281%29.png)
3. Select your desired start date and end date.
![](../../../.gitbook/assets/9%20%285%29.png)
![](../../../.gitbook/assets/9%20%285%29%20%281%29.png)
### Details of productivity matrices:
......
......@@ -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.png)
![](../../../.gitbook/assets/0%20%288%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.png)
![](../../../.gitbook/assets/0%20%288%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%284%29.png)
![](../../../.gitbook/assets/0%20%288%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%283%29.png)
![](../../../.gitbook/assets/0%20%288%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%281%29.png)
![](../../../.gitbook/assets/0%20%288%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.png)
![](../../../.gitbook/assets/0%20%288%29%20%285%29.png)
......
......@@ -22,7 +22,7 @@ Go to **Priorities** in the omnichannel panel settings, as shown below:
5. Click **Save**.
![](../../../.gitbook/assets/image%20%2847%29.png)
![](../../../.gitbook/assets/image%20%2847%29%20%281%29.png)
Your new priority is saved, as shown below:
......
......@@ -24,7 +24,7 @@ Enable `Omnichannel`. Using canned responses in regular conversations with other
Select the department. Canned responses can be created **per department** as shown below**,** or **per agent** right in an omnichannel conversation. ****Click on the canned responses icon \(top right corner\) to create a new canned response.
![](../../../.gitbook/assets/screenshot-2020-07-28-at-00.28.04%20%281%29.png)
![](../../../.gitbook/assets/screenshot-2020-07-28-at-00.28.04%20%281%29%20%281%29.png)
_If you want to use canned responses outside the Omnichannel, create an empty department. Note that you will need to define which user roles should be able to use the responses; by default this permission is assigned to livechat-agent, livechat-manager, livechat-monitor and admin roles_
......
......@@ -2,7 +2,7 @@
To get support from us, click **Support**, as shown below:
![](../../../.gitbook/assets/image%20%28115%29%20%281%29.png)
![](../../../.gitbook/assets/image%20%28115%29%20%282%29%20%281%29.png)
......
......@@ -6,7 +6,7 @@ description: You can manage your workspaces here.
As soon as you log in, you will see the list of workspaces linked to your cloud account, as shown below:
![](../../../.gitbook/assets/image%20%2895%29.png)
![](../../../.gitbook/assets/image%20%2895%29%20%281%29.png)
Click the Add button to add your self-managed workspace.
......
......@@ -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.png)
![](../.gitbook/assets/cancel_cloud_subscription%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.png)
![](../.gitbook/assets/add_payment_method%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