Skip to content

Commit 5bb7dec

Browse files
authored
v5.0 README updates (#854)
1 parent bd5cacb commit 5bb7dec

File tree

1 file changed

+44
-12
lines changed

1 file changed

+44
-12
lines changed

README.md

+44-12
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,66 @@ WordPress Plugin for [Auth0](https://auth0.com) Authentication
44

55
[![License](https://img.shields.io/packagist/l/auth0/auth0-php)](https://doge.mit-license.org/)
66

7-
:books: [Documentation](#documentation) - :rocket: [Getting Started](#getting-started) - :speech_balloon: [Feedback](#feedback)
8-
9-
## Documentation
10-
11-
- [Download from WordPress.org](https://wordpress.org/plugins/auth0/)
12-
- [Documentation](https://auth0.com/docs/cms/wordpress)
7+
:rocket: [Getting Started](#getting-started) - :speech_balloon: [Feedback](#feedback)
138

149
## Getting Started
1510

1611
### Requirements
1712

1813
- PHP 8.0+
1914
- Latest version of WordPress (6+)
15+
- WP configured with databases priviledges to create tables
2016

2117
### Installation
2218

23-
1. Log in to an existing WordPress site as an administrator.
24-
2. Go to Plugins → Add New in the admin menu on the left.
25-
3. Search for "Login by Auth0"
19+
#### Composer
20+
21+
Add the dependency to your application with [Composer](https://getcomposer.org/):
22+
23+
```
24+
composer require auth0/wp-auth0
25+
```
26+
27+
Then,
28+
29+
1. Log in to your WordPress site as an administrator.
30+
2. Go to Plugins menu.
31+
3. Look for "Login by Auth0" in the list.
32+
4. Click Install Now, and then Activate.
33+
34+
#### WordPress.org
35+
36+
1. Log in to your WordPress site as an administrator.
37+
2. Go to Plugins menu, then click 'Add New'.
38+
3. Search for "Login by Auth0".
2639
4. Click Install Now, and then Activate.
2740

28-
Addition information can be found in the [installation docs](https://auth0.com/docs/cms/wordpress/installation).
41+
### Configure Auth0
42+
43+
Create a **Regular Web Application** in the [Auth0 Dashboard](https://manage.auth0.com/#/applications). Verify that the "Token Endpoint Authentication Method" is set to `POST`.
44+
45+
Next, configure the callback and logout URLs for your application under the "Application URIs" section of the "Settings" page:
46+
47+
- **Allowed Callback URLs**: The URL of your application where Auth0 will redirect to during authentication, e.g., `http://localhost:3000/callback`.
48+
- **Allowed Logout URLs**: The URL of your application where Auth0 will redirect to after user logout, e.g., `http://localhost:3000/login`.
49+
50+
Note the **Domain**, **Client ID**, and **Client Secret**. These values will be used later.
2951

3052
### Configure the SDK
3153

32-
Please see the [configuration docs](https://auth0.com/docs/cms/wordpress/configuration) for instructions on how to configure Login by Auth0 for your site.
54+
Upon activating the Auth0 WordPress plugin, you will find a new "Auth0" section on the left hand side of your administrative dashboard. This section enables you to configure the plugin.
55+
56+
At a minimum, you will need to configure the Domain, Client ID and Client Secret sections for the plugin to function.
57+
58+
We recommend testing on a staging/development site first using a separate Auth0 Application before putting the plugin live on your production site. Be sure to enable the plugin from the Auth0's plugins admin settings page for authentication with Auth0 to function.
59+
60+
### Plugin Database Tables
61+
62+
For performance reasons, V5 of the WordPress plugin as adopted it's own database tables. This means the WordPress database credentials [you have configured](https://wordpress.org/support/article/creating-database-for-wordpress/) must have appropriate priviledges to create new tables.
63+
64+
### Cron Configuration
3365

34-
We recommend testing on a staging/development site first using a separate Auth0 Application before putting the plugin live on your production site.
66+
It's important to configure your WordPress site's built-in background task system, [WP-Cron](https://developer.wordpress.org/plugins/cron/). This is the mechanism that V5 of the WordPress plugin keeps WordPress and Auth0 in sync.
3567

3668
## Feedback
3769

0 commit comments

Comments
 (0)