76 lines
2.1 KiB
Markdown
76 lines
2.1 KiB
Markdown
# Wordpress Identity store
|
|
This Identity store allows you to use user accounts registered on your Wordpress setup.
|
|
Two types of connections are required for full support:
|
|
- [REST API](https://developer.wordpress.org/rest-api/) with JWT authentication
|
|
- Direct SQL access
|
|
|
|
## Features
|
|
| Name | Supported |
|
|
|-------------------------------------------------|-----------|
|
|
| [Authentication](../features/authentication.md) | Yes |
|
|
| [Directory](../features/directory.md) | Yes |
|
|
| [Identity](../features/identity.md) | Yes |
|
|
| [Profile](../features/profile.md) | No |
|
|
|
|
## Requirements
|
|
- [Wordpress](https://wordpress.org/download/) >= 4.4
|
|
- Permalink structure set to `Post Name`
|
|
- [JWT Auth plugin for REST API](https://wordpress.org/plugins/jwt-authentication-for-wp-rest-api/)
|
|
- SQL Credentials to the Wordpress Database
|
|
|
|
## Configuration
|
|
### Wordpress
|
|
#### JWT Auth
|
|
Set a JWT secret into `wp-config.php` like so:
|
|
```php
|
|
define('JWT_AUTH_SECRET_KEY', 'your-top-secret-key');
|
|
```
|
|
`your-top-secret-key` should be set to a randomly generated value which is kept secret.
|
|
|
|
#### Rewrite of `index.php`
|
|
Wordpress is normally configured with rewrite of `index.php` so it does not appear in URLs.
|
|
If this is not the case for your installation, the ma1sd URL will need to be appended with `/index.php`
|
|
|
|
### ma1sd
|
|
Enable in the configuration:
|
|
```yaml
|
|
wordpress:
|
|
enabled: true
|
|
```
|
|
Configure the URL to your Wordpress installation - see above about added `/index.php`:
|
|
```yaml
|
|
wordpress:
|
|
rest:
|
|
base: 'http://localhost:8080'
|
|
```
|
|
Configure the SQL connection to your Wordpress database:
|
|
```yaml
|
|
wordpress:
|
|
sql:
|
|
connection: '//127.0.0.1/wordpress?user=root&password=example'
|
|
```
|
|
|
|
---
|
|
|
|
By default, MySQL database is expected. If you use another database, use:
|
|
```yaml
|
|
wordpress:
|
|
sql:
|
|
type: <string>
|
|
```
|
|
With possible values:
|
|
- `mysql`
|
|
- `mariadb`
|
|
- `postgresql`
|
|
- `sqlite`
|
|
|
|
---
|
|
|
|
To configure the tables prefix for default queries, in case a custom value was set during Wordpress install:
|
|
```yaml
|
|
wordpress:
|
|
sql:
|
|
tablePrefix: <string>
|
|
```
|
|
By default, the value is set to `wp_`.
|