-
Notifications
You must be signed in to change notification settings - Fork 96
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[SDK-3712] Update README design (#852)
Co-authored-by: Ewan Harris <[email protected]>
- Loading branch information
1 parent
9b38c33
commit 8e0daa8
Showing
1 changed file
with
37 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,79 +1,63 @@ | ||
| # Auth0 WordPress Plugin | ||
|  | ||
|
|
||
| > ⚠️ **Version 5.0 of our plugin is now available in Beta.** This release adds a number of features. Do not use this in production yet, as there are a considerable number of breaking changes and some functionality remaining to be implemented. The migration sync processed is not fully functional in this release. As we move toward General Availability, please be aware that releases may contain breaking changes. | ||
| WordPress Plugin for [Auth0](https://auth0.com) Authentication | ||
|
|
||
|  | ||
| [](https://doge.mit-license.org/) | ||
|
|
||
| This plugin replaces the standard WordPress login process with one powered by Auth0 that enables social, passwordless, and enterprise connection login as well as additional security, multifactor auth, and user statistics. | ||
| :books: [Documentation](#documentation) - :rocket: [Getting Started](#getting-started) - :speech_balloon: [Feedback](#feedback) | ||
|
|
||
| Please see the [WP.org plugin page](https://wordpress.org/plugins/auth0/) for more details on functionality. | ||
| ## Documentation | ||
|
|
||
| ## Table of Contents | ||
| - [Download from WordPress.org](https://wordpress.org/plugins/auth0/) | ||
| - [Documentation](https://auth0.com/docs/cms/wordpress) | ||
|
|
||
| - [Documentation](#documentation) | ||
| - [Installation](#installation) | ||
| - [Getting Started](#getting-started) | ||
| - [Contribution](#contribution) | ||
| - [Support + Feedback](#support--feedback) | ||
| - [Vulnerability Reporting](#vulnerability-reporting) | ||
| - [What is Auth0](#what-is-auth0) | ||
| - [License](#license) | ||
| ## Getting Started | ||
|
|
||
| ## Documentation | ||
| ### Requirements | ||
|
|
||
| - [Installation](https://auth0.com/docs/cms/wordpress/installation) | ||
| - [Configuration](https://auth0.com/docs/cms/wordpress/configuration) | ||
| - [Troubleshooting](https://auth0.com/docs/cms/wordpress/troubleshoot) | ||
| - [Extending](https://auth0.com/docs/cms/wordpress/extending) | ||
| - PHP 8.0+ | ||
| - Latest version of WordPress (6+) | ||
|
|
||
| ## Installation | ||
| ### Installation | ||
|
|
||
| Please see the [installation docs](https://auth0.com/docs/cms/wordpress/installation) for detailed instructions on how to get started with Login by Auth0. | ||
| 1. Log in to an existing WordPress site as an administrator. | ||
| 2. Go to Plugins → Add New in the admin menu on the left. | ||
| 3. Search for "Login by Auth0" | ||
| 4. Click Install Now, and then Activate. | ||
|
|
||
| ## Getting Started | ||
| Addition information can be found in the [installation docs](https://auth0.com/docs/cms/wordpress/installation). | ||
|
|
||
| ### Configure the SDK | ||
|
|
||
| Please see the [configuration docs](https://auth0.com/docs/cms/wordpress/configuration) for instructions on how to configure Login by Auth0 for your site. Once configured, you'll want to test: | ||
| Please see the [configuration docs](https://auth0.com/docs/cms/wordpress/configuration) for instructions on how to configure Login by Auth0 for your site. | ||
|
|
||
| - Existing user login | ||
| - New user signup (if allowed) | ||
| - SSO login (if used) | ||
| - Additional features like MFA, user migration, etc. | ||
| We recommend testing on a staging/development site first using a separate Auth0 Application before putting the plugin live on your production site. | ||
|
|
||
| We recommend testing on a staging/development site first using a separate Auth0 Application before putting the plugin live on your production site. See the **[Support](#support--feedback)** section below if you have any questions or issues during setup. | ||
| ## Feedback | ||
|
|
||
| ## Contribution | ||
| ### Contributing | ||
|
|
||
| We appreciate feedback and contribution to this plugin! Before you get started, please see the following: | ||
| We appreciate feedback and contribution to this repo! Before you get started, please see the following: | ||
|
|
||
| - [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md) | ||
| - [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md) | ||
| - [This repo's contribution guidelines](CONTRIBUTION.md) | ||
|
|
||
| ## Support + Feedback | ||
|
|
||
| Include information on how to get support. Consider adding: | ||
|
|
||
| - Use [Issues](https://github.com/auth0/wp-auth0/issues) for code-level support | ||
| - Use [Community](https://community.auth0.com/tags/wordpress) for usage, questions, and specific cases | ||
| - You can also use the [WP.org support forum](https://wordpress.org/support/plugin/auth0) for questions | ||
|
|
||
| ## Vulnerability Reporting | ||
| ### Raise an issue | ||
| To provide feedback or report a bug, [please raise an issue on our issue tracker](https://github.com/auth0/wp-auth0/issues). | ||
|
|
||
| ### Vulnerability Reporting | ||
| Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues. | ||
|
|
||
| ## What is Auth0? | ||
|
|
||
| Auth0 helps you to easily: | ||
|
|
||
| - implement authentication with multiple identity providers, including social (e.g., Google, Facebook, Microsoft, LinkedIn, GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD, Google Apps, Active Directory, ADFS, SAML, etc.) | ||
| - log in users with username/password databases, passwordless, or multi-factor authentication | ||
| - link multiple user accounts together | ||
| - generate signed JSON Web Tokens to authorize your API calls and flow the user identity securely | ||
| - access demographics and analytics detailing how, when, and where users are logging in | ||
| - enrich user profiles from other data sources using customizable JavaScript rules | ||
| --- | ||
|
|
||
| [Why Auth0?](https://auth0.com/why-auth0) | ||
| <p align="center"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: light)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150"> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_dark_mode.png" width="150"> | ||
| <img alt="Auth0 Logo" src="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150"> | ||
| </picture> | ||
| </p> | ||
|
|
||
| ## License | ||
| <p align="center">Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout <a href="https://auth0.com/why-auth0">Why Auth0?</a></p> | ||
|
|
||
| Login by Auth0 is licensed under GPLv2 - [LICENSE](LICENSE) | ||
| <p align="center">This project is licensed under the MIT license. See the <a href="./LICENSE"> LICENSE</a> file for more info.</p> |