Skip to content
Snippets Groups Projects
README.md 1.48 KiB
Newer Older
Erick Hitter's avatar
Erick Hitter committed
# WP Redis User Session Storage #
Erick Hitter's avatar
Erick Hitter committed
**Contributors:** [ethitter](https://profiles.wordpress.org/ethitter/)  
Erick Hitter's avatar
Erick Hitter committed
**Donate link:** https://ethitter.com/donate/  
**Tags:** user sessions, session tokens, session storage  
**Requires at least:** 4.0  
**Tested up to:** 5.2  
**Stable tag:** 0.1  
Erick Hitter's avatar
Erick Hitter committed
**Requires PHP:** 5.3  
Erick Hitter's avatar
Erick Hitter committed
**License:** GPLv2 or later  
**License URI:** http://www.gnu.org/licenses/gpl-2.0.html  
Erick Hitter's avatar
Erick Hitter committed

Erick Hitter's avatar
Erick Hitter committed
Store WordPress session tokens in Redis rather than the usermeta table.
Erick Hitter's avatar
Erick Hitter committed

Erick Hitter's avatar
Erick Hitter committed
## Description ##
Erick Hitter's avatar
Erick Hitter committed
Store WordPress user session tokens in Redis rather than the usermeta table.
Erick Hitter's avatar
Erick Hitter committed

Erick Hitter's avatar
Erick Hitter committed
## Installation ##
Erick Hitter's avatar
Erick Hitter committed

1. Install and configure Redis. There is a good tutorial [here](http://www.saltwebsites.com/2012/install-redis-245-service-centos-6).
2. Install the [Redis PECL module](http://pecl.php.net/package/redis).
3. Activate the plugin network-wide or by placing it in `mu-plugins`.
4. By default, the script will connect to Redis at 127.0.0.1:6379. See the *Connecting to Redis* section for further options.

Erick Hitter's avatar
Erick Hitter committed
## Frequently Asked Questions ##
Erick Hitter's avatar
Erick Hitter committed

Erick Hitter's avatar
Erick Hitter committed
### Connecting to Redis ###
Erick Hitter's avatar
Erick Hitter committed
By default, the plugin uses `127.0.0.1` and `6379` as the default host and port when creating a new client instance; the default database of `0` is also used. Three constants are provided to override these default values.

Specify `WP_REDIS_USER_SESSION_HOST`, `WP_REDIS_USER_SESSION_PORT`, and `WP_REDIS_USER_SESSION_DB` to set the necessary, non-default connection values for your Redis instance.
Erick Hitter's avatar
Erick Hitter committed

## Changelog ##

### 0.1 ###
* Initial public release