Unverified Commit 5230d372 authored by Gabriel Engel's avatar Gabriel Engel Committed by gitbook-bot
Browse files

GitBook: [master] 937 pages modified

parent 28d3e549
This diff is collapsed.
......@@ -23,7 +23,7 @@ But that doesn't mean you can't contribute! Every issue is open and any help is
Want a simple task to get you started? [We maintain a list of those](https://github.com/RocketChat/Rocket.Chat/labels/contrib%3A%20easy)! Or just search for issues tagged contrib:easy
Check our [developer guides](../../developer-guides/) for more detailed information about pull requests, workflow and API docs.
Check our [developer guides](../../guides/developer-guides/) for more detailed information about pull requests, workflow and API docs.
## Priority Features and/or Bug fixes
......
# Website
Guides on how to contribute to Rocket.Chat's website.
* [Webinars](webinars.md)
# Webinars
This is a guide on how to add a new webinar to the Rocket.Chat website.
To add a webinar to the site, you first need to create a markdown file for it.
Start by creating a file following this name model `YEAR-MONTH-DAY-YOUR-FILE-NAME` for example:
`2018-05-04-rocket-chat-android-2-1-released`
This file should be saved under [\_posts](https://github.com/RocketChat/rocketchat.github.io/tree/master/_posts) on the corresponding folder for the year and month of the post.
After that you should set your file to look like this:
```text
---
title: Rocket.Chat - iOS 3.2 release
description: On this webinar the mobile apps team talk about the new features and improvements of the version 3.2 of Rocket.Chat iOS App.
webinarID: 005
dateEvent: 2018-12-19 10:00:00
webinarURL: https://www.youtube.com/embed/PJwxVrQfgrM
bgSize: cover
bgColor: 030c1a
hosts:
- Rafael Kellermann Streit
- Matheus Cardoso
- Filipe Alvarenga
language: USA
gmt: -3
cover: https://img.youtube.com/vi/PJwxVrQfgrM/maxresdefault.jpg
categories:
- Webinars
---
```
Now we are going over relevant lines and see how to use them:
* **title:** This defines the title of the page and will be displayed on top of it;
* **description:**: This defines the description of the webinar, it is important to always add a good description on what the webinar is about. Does not have any restriction on size;
* **webinarID:** This defines the ID of the webinar, you **MUST** add a unique ID to the webinar that follows the order of the last webinar, for example if the last webinar was `007`, this one needs to be `008`. If a webinar have the same ID of an already existing one, the tests on the Pull Request will fail;
* **dateEvent:** The date that the webinar will occur, this will define if it is an upcoming or a past webinar. Uses `YEAR-MONTH-DAY HOUR:MINUTE:SECOND` format;
* **webinarURL:** If the webinar has already happened, add here the youtube embed URL. You can find this URL on the youtube video page "Share" section;
* **hosts:** This defines the speakers for the webinar, simply add the full name of the team member \(according to [this members list](webinars.md)\) to the parameter. Webinars can have as many hosts as you want, but only the 3 first will show up on the thumbnail. If you need to add someone that is out of the team, you should use the `off-team-host` parameter:
```text
off-team-host: HOST NAME
off-team-host-image: "URL-TO-HOST-IMAGE"
off-team-host-role: HOST ROLE
```
* **language:** This defines the language of the webinar, currently we only support either `Brazil` for Portuguese or `USA` for English;
* **gmt:** This defines the timezone that the webinar will be held on;
* **cover:** This defines the cover image of the webinar, it is suggested to use the youtube video's own thumbnail for webinars that has already happened. You can get this image by simply using the URL `https://img.youtube.com/vi/YOUR-VIDEO-ID/maxresdefault.jpg`
* **categories:** This must have the category `- Webinars` or else it will not show up as a webinar and only as a normal post.
......@@ -12,7 +12,7 @@ Create a client in Keycloak.
The following image shows the minimal configurations needed to setup Keycloak as an Identity Provider to Rocket.Chat.
![](../../../.gitbook/assets/client_configurations.png)
![](../../../../.gitbook/assets/client_configurations.png)
After saving the changes a new credentials tab will be created for the client. This credentials tab will provide the client secrets which will be used when configuring the Rocket.Chat
......@@ -41,7 +41,7 @@ Leave the rest of the configurations as default.
Now logout from Rocket.Chat to view the keycloak based login option visible in the login page.
![](../../../.gitbook/assets/keycloak_federation.png)
![](../../../../.gitbook/assets/keycloak_federation.png)
## Mapping non-federated keycloak user roles to Rocket.Chat roles
......@@ -51,11 +51,11 @@ For this example, we map the `admin` and `livechat-manager` role, as documented
First we add the required roles to the client
![](../../../.gitbook/assets/client_roles_configurations.png)
![](../../../../.gitbook/assets/client_roles_configurations.png)
then we have to add a mapper entry, that maps our client roles to OpenId, passing the value to Rocket.Chat
![](../../../.gitbook/assets/client_roles_mapper_roles.png)
![](../../../../.gitbook/assets/client_roles_mapper_roles.png)
Now in order to grant the Rocket.Chat role to a user, we have to modify the users Role Mappings.
......
......@@ -37,7 +37,7 @@ Set the following:
On your Okta Applications Dashboard, find the button to create a new app. It should open the following pop-up:
![](../../../.gitbook/assets/addapp.png)
![](../../../../.gitbook/assets/addapp.png)
Select **OpenID Connect** and select **Create** to open the window to create the new integration.
......
......@@ -12,18 +12,18 @@ The configuration should be done as follows:
1. Configure the entry points and the IdP path ****
![](../../../.gitbook/assets/adfs_1.png)
![](../../../../.gitbook/assets/adfs_1.png)
2. Add the private key certificate related to the ADFS server.
Important: ADFS uses .pfx certificate extensions \(widely used on Windows landscapes\) and Rocket.Chat uses .pem files. So, before setting the certificate here, it must be converted.
![](../../../.gitbook/assets/adfs_2.png)
![](../../../../.gitbook/assets/adfs_2.png)
3. Set the _Custom Authn Context_ and _User Data Field Map_ according the scenario you have on your Active Directory
![](../../../.gitbook/assets/adfs_3%20%281%29.png)
![](../../../../.gitbook/assets/adfs_3%20%281%29.png)
After that, the SAML configuration is done. The service will be available as a blue button above the login fields on Rocket.Chat login page
![](../../../.gitbook/assets/screenshot_235.png)
![](../../../../.gitbook/assets/screenshot_235.png)
......@@ -10,23 +10,23 @@ Oracle Identity Cloud Service is integrated as a SAML Identity Provider. For det
On your Oracle Cloud Applications Dashboard, find a button to add a new application. It should open the following pop-up:
![](../../../.gitbook/assets/addapplication.png)
![](../../../../.gitbook/assets/addapplication.png)
Select **SAML Application** to open the configuration wizard.
### App Details
![](../../../.gitbook/assets/appdetails.png)
![](../../../../.gitbook/assets/appdetails.png)
The only information needed on this page is the application name and URL. The URL you need to use here is the same one that is set on the _Custom Issuer_ SAML configuration field on the Rocket.Chat settings.
### SSO Configuration
![](../../../.gitbook/assets/ssoconfiguration.png)
![](../../../../.gitbook/assets/ssoconfiguration.png)
To get the values for those new settings, you need to access the same _Custom Issuer_ URL that you used on the previous page. It should show a XML file similar to the one below:
![](../../../.gitbook/assets/samplexmlconfiguration.png)
![](../../../../.gitbook/assets/samplexmlconfiguration.png)
On the **AssertionConsumerService** tag, you need to copy the value of the _Location_ attribute. Then paste this value on the _Assertion Consumer URL_ field on the Oracle Settings. On the **SingleLogoutService** tag, you need to copy the value of the _Location_ attribute, then paste it in the _Single Logout URL_ param of the Advanced Settings. On the same **SingleLogoutService** tag, you need to copy the value of the _ResponseLocation_ attribute, then paste it in the _Logout Response URL_ param of the Advanced Settings.
......@@ -36,7 +36,7 @@ Before clicking on **Finish**, click the **Download Identity Provider Metadata**
### Rocket.Chat Settings
![](../../../.gitbook/assets/rocketchatsettings.png)
![](../../../../.gitbook/assets/rocketchatsettings.png)
There are two Rocket.Chat settings that need to be copied from the IDP Metadata you just downloaded: _Custom Entry Point_ and _IDP SLO Redirect URL_. For the first one, locate the tag **SingleLogoutService** and copy the value of the _Location_ attribute. For the second param, locate the tag **md:SingleLogoutService** and copy the value of the _Location_ attribute.
......
......@@ -13,13 +13,13 @@ You can add your own image files that can be JPG, GIF, or PNG.
* Browse and choose an image file
* Press the SAVE button
![Add emoji example](../.gitbook/assets/example-add-emoji.png)
![Add emoji example](../../.gitbook/assets/example-add-emoji.png)
## Accessing custom emoji
Custom emoji can be used to add in the message, react to other messages. These emojis can be found in the emoji picker under the Rocket.Chat icon.
![Access emoji example](../.gitbook/assets/access-emoji.png)
![Access emoji example](../../.gitbook/assets/access-emoji.png)
You can also use these emojis using their name and aliases like `:hammy:` or `:savage:`
......
Supports Markdown
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