README.md

Redis Utilities for VVV

This package is meant to automate the installation and configuration of Redis and phpredis in Varying Vagrant Vagrants (VVV) environments.

The latest version of Redis will be built and installed from source, providing your VVV environment with a powerful in-memory data store and queuing system. Additionally, phpredis will be installed, exposing access to Redis from within your PHP applications.

For more information on how to use Redis, please see the Redis documentation.

Installation

The package registers Redis as a custom utility, making it easy to install via the vvv-custom.yml file:

1. Add the following line under utility-sources: (or create the node if it doesn't yet exist):

   utility-sources:
     redis: https://github.com/stevegrunwell/vvv-redis.git

2. Under the utilities: section, add a new node at the same level as the core: node:

   utilities:
     core:
       # Any core utilities you're using go here (e.g. phpmyadmin, php72, etc.)
     redis:
       - redis

3. (Re-) provision Vagrant using vagrant up --provision

Testing Redis

Once VVV has provisioned, you can verify that Redis is up and running by ping-ing the Redis server:

vagrant@vvv:$ redis-cli ping
PONG

Support

This package has been designed to work with the latest versions of VVV, adhering to the instructions provided in the official Redis Quick Start Guide, using setup scripts that ship with Redis itself. Meanwhile, phpredis is configured to install the latest stable release via PECL.

That being said, bugs do happen from time to time in software. If you run into trouble, please open an issue on GitHub and we'll try to help you through it!

License

This package is licensed under the MIT License, while Redis itself is released under the BSD 3-Clause "New" or "Revised" License and phpredis is available under the PHP License, version 3.01.