README.md 1.57 KB
Newer Older
1
2
3
4
5
6
7
---
description: >-
  Rocket.Chat supports several different ways to authenticate, beyond the basic
  username/password authentication. Most authentication providers require a
  clientID and a secret.
---

Sing Li's avatar
Sing Li committed
8
# OAuth
Marcelo Schmidt's avatar
Docs    
Marcelo Schmidt committed
9

10
11
12
 Below are brief descriptions of how to set up some of the most widely used provider.

To set up your desired provider:
Marcelo Schmidt's avatar
Docs    
Marcelo Schmidt committed
13

14
1. These settings are in the `Accounts` setting page under `Administration`.
Marcelo Schmidt's avatar
Docs    
Marcelo Schmidt committed
15
16
17

## Facebook

18
* Callback URL: `<<website_url>>/_oauth/facebook?close`
Marcelo Schmidt's avatar
Docs    
Marcelo Schmidt committed
19
20
21

## GitHub

22
* Callback URL: `<<website_url>>/_oauth/github?close`
Marcelo Schmidt's avatar
Docs    
Marcelo Schmidt committed
23

24
### GitHub Set up
Marcelo Schmidt's avatar
Docs    
Marcelo Schmidt committed
25

26
27
28
29
30
1. Go to your [Application Settings](https://github.com/settings/applications)
2. Under the `Developer applications` tab, click the **Register new application** button
3. Fill in the form, and make sure you use the correct callback URL.

**Note**: If your callback URL is wrong, GitHub does not display any error. Instead of logging in, you receive an error message saying "No matching login attempt found."
Marcelo Schmidt's avatar
Docs    
Marcelo Schmidt committed
31
32
33
34
35

## GitLab

## Google

36
* Callback URL: `<<website_url>>/_oauth/google?close`
Marcelo Schmidt's avatar
Docs    
Marcelo Schmidt committed
37

38
### Google Set up
Marcelo Schmidt's avatar
Docs    
Marcelo Schmidt committed
39

40
1. Go to the [Google Developer Console](https://console.developers.google.com), and create a new project
41
2. Set up your project by creating an "OAuth 2.0 client ID" \(under `APIs & Auth` and `Credentials`\)
42
3. After that, make sure you define a **Product Name** in the OAuth consent screen, and select **Web App** as application type. Otherwise, you won't be able to provide a callback URL
Marcelo Schmidt's avatar
Docs    
Marcelo Schmidt committed
43
44
45

## LinkedIn

46
* Callback URL: `<<website_url>>/_oauth/linkedin`
Marcelo Schmidt's avatar
Docs    
Marcelo Schmidt committed
47
48
49
50
51
52
53

## Meteor

TBD.

## Twitter

54
55
* Callback URL: `<<website_url>>/_oauth/twitter`