Skip to content

Commit e3482db

Browse files
paulofariadiasMartinSchoeler
authored andcommitted
(DOCS): Edit Wordpress Authentication (RocketChat#1446)
* Edit Wordpress Authentication * (DOCS): Edit Wordpress Authentication * (DOCS): Edit Wordpress Authentication Fix Ordered list item prefixes * (DOCS): Edit Wordpress Authentication Fix ordered list item prefixes * (DOCS): Edit Wordpress Authentication Correct Ordered list item prefixes * (DOCS): Edit Wordpress Authentication Fix ordered list item prefixes * (DOCS): Edit Wordpress Authentication Edit Ordered list item prefixes * (DOCS): Edit Wordpress Authentication Fix Ordered list item prefixes * (DOCS): Edit Wordpress Authentication Changed list format
1 parent 590a454 commit e3482db

File tree

1 file changed

+25
-27
lines changed
  • administrator-guides/authentication/wordpress

1 file changed

+25
-27
lines changed
Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,43 @@
11
# WordPress oAuth Setup
22

3-
The Easiest way to configure Rocket.Chat using WordPress as your identity backend is to use the MiniOrange oAuth Plugin Version 2.5.6 or higher: <https://wordpress.org/plugins/miniorange-oauth-20-server/>
3+
The easiest way to configure Rocket.Chat using WordPress as your identity backend is to use the MiniOrange oAuth Plugin Version 2.5.6 or higher: <https://wordpress.org/plugins/miniorange-oauth-20-server/>
44

5-
## Step by Step Guide
5+
## Instructions
66

7-
1) Sign into your Rocket Chat instance with an administrator account.
8-
2) procced to the oAuth section under administration.
9-
3) Click on Add custom oAuth to create a new OAuth Application (refer to image below).
7+
- Sign into your Rocket Chat instance with an administrator account.
8+
- Procced to the `oAuth` section under `Administration`.
9+
- Click on **Add custom oAuth** to create a new OAuth Application, as depicted below:
1010

1111
![alt text](https://savvymatthew.sfo2.cdn.digitaloceanspaces.com/rocketchat-docs/rct-oauth-step-03.png)
1212

13-
4) You will be shown the Application Configuration tab, copy the Callback URL (example: `http://your.domain.com/_oauth/id`) put this into notepad or another text application as we will need this in the next few steps.
14-
15-
6) Login to your WordPress site as an administrator and navigate to Add New under Plugins.
16-
17-
7) Search for "MiniOrange oAuth Server" (Red Below)
18-
19-
8) Install and activate the MiniOrange oAuth Server plugin (Purple then Green)
13+
- In the **Application Configuration** tab, copy the `Callback URL` (example: `http://your.domain.com/_oauth/id`), and put it into a notepad, or another text application, as we will need it in the next few steps.
14+
- Log into your WordPress site as an administrator and navigate to **Add New** under `Plugins`.
15+
- Search for "MiniOrange oAuth Server" (Red below).
16+
- Install and activate the `MiniOrange oAuth Server` plugin (Purple, and then Green).
2017

2118
![alt text](https://savvymatthew.sfo2.cdn.digitaloceanspaces.com/rocketchat-docs/rct-oauth-step-8.png)
2219

23-
9) Navigate to the MiniOrange oAuth Server Menu item and click though the quick guided tour.
24-
25-
10) Click add client (Red)
20+
- Navigate to the `MiniOrange oAuth Server` Menu item, and click though the quick guided tour.
21+
- Click **Add client** (Red).
2622

2723
![alt text](https://savvymatthew.sfo2.cdn.digitaloceanspaces.com/rocketchat-docs/rct-oauth-step-10.png)
2824

29-
11) Give your client a name (Red) and enter in the Callback URL we saved above (Purple) and click save client.
25+
- Give your client a name (Red), enter the Callback URL you saved before (Purple), and click **Save client**.
3026

3127
![alt text](https://savvymatthew.sfo2.cdn.digitaloceanspaces.com/rocketchat-docs/rct-oauth-step-11.png)
3228

33-
12) This will now show your Client ID (Red) and Client Secret (Purple) copy these into the same notepad or another text application where you have your Callback URL.
29+
- It now shows your `Client ID` (Red) and `Client Secret` (Purple). Copy them into the same notepad, or another text application where you have your Callback URL.
3430

3531
![alt text](https://savvymatthew.sfo2.cdn.digitaloceanspaces.com/rocketchat-docs/rct-oauth-step-12.png)
3632

37-
13) Click the Endpoints tab and copy Each line under in the purple box to your notepad as well noting what endpoint it is.
33+
- Click the **Endpoints** tab, and copy each line from the purple box to your notepad. Don't forget to note the endpoint each line represents.
3834

3935
![alt text](https://savvymatthew.sfo2.cdn.digitaloceanspaces.com/rocketchat-docs/rct-oauth-step-13.png)
4036

41-
14) Go back to your already created custom oAuth in Rocket Chat and match up everything in the notepad into the correct fields listed below and in the screenshot.
37+
- Go back to the custom oAuth you already created in Rocket Chat, and match the information saved in the notepad into the correct fields listed below and in the screenshot:
4238

4339
- **Enable** = True
44-
- **URL** = `https://your.domain.com` (Do not include a trailing “/”)
40+
- **URL** = `https://your.domain.com` (do not include a trailing “/”)
4541
- **Token Path** = Access Token Endpoint
4642
- **Token Sent Via** = Payload
4743
- **Identity Token Sent Via** = Payload
@@ -50,24 +46,26 @@ The Easiest way to configure Rocket.Chat using WordPress as your identity backen
5046
- **Scope** = Profile
5147
- **Id** = Client ID
5248
- **Secret** = Client Secret
53-
- **Login Style** = Redirect (You can use any of them really but redirect is really the only one that plays nice with the mobile and desktop apps.)
54-
- **Username field** = username ( Note WordPress’s normal hook for a username is user_login but the plugin rewrites this in the json response to Rocket to username)
49+
- **Login Style** = Redirect (you can use any of them, but redirect is really the only one that plays nice with mobile and desktop apps)
50+
- **Username field** = username (a normal hook for a WordPress username is user_login, but the plugin rewrites this in the JSON response to Rocket for username)
5551
- **Merge users** = true
5652

5753
![alt text](https://savvymatthew.sfo2.cdn.digitaloceanspaces.com/rocketchat-docs/rct-oauth-step-14.png)
5854

5955
### Button Customization
6056

61-
In regards to the customization of the login button you can customize it without affecting oAuth working. One thing to note though is when using the mobile and desktop apps they will not display your imputed Button text, they will display your custom oAuth name at the top.
57+
In regards to the customization of the **Log in** button, you can customize it without affecting oAuth working.
58+
59+
**Note**: When using mobile and desktop apps, your imputed **Button** text is not displayed. Instead, the apps will display your custom oAuth name at the top.
6260

6361
### Troubleshooting oAuth
6462

65-
First thing to do when having an issue with oAuth is to enable Level 2 Logging to see whats going on:
66-
Administration > Logs > Log Level then you can Click View Logs.
63+
The first thing to do when having an issue with oAuth is to enable `Level 2 Logging` to see what's going on:
64+
`Administration > Logs > Log Level > View Logs`.
6765

68-
When looking at the logs you want may want to open an incognito mode browser window for the log in screen and have the logs and your login screen side by side. When you attempt a login, the log will display the oAuth response in Realtime giving you valuable information to help your troubleshoot your issue.
66+
When looking at the logs, you may want to open an incognito mode browser window for the log in screen, and have the logs and your login screen side-by-side. When you attempt a login, the log displays the oAuth response in real time, which gives you valuable information to help you troubleshoot your issue.
6967

70-
Here are some forum threads that provide some issues others have had:
68+
Here are some forum threads that provide issues experienced by others:
7169

7270
**The redirect URI provided is missing or does not match**
7371
<https://wordpress.org/support/topic/rocketchat-wordpress-the-redirect-uri-provided-is-missing-or-does-not-match/>

0 commit comments

Comments
 (0)