diff --git a/README.md b/README.md index bf42855c096..78ebc5823f1 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,16 @@ For information on how to install for use with the cloud environment, please see 10. Wheeeee! You're up and running! Log in with test usernames "user", "moderator", or "admin", and password "password". 11. Run `rails test` to confirm that your install is working properly. Or `rails test:system` for system tests. +## Redis Installation + +Public Lab uses Redis and may be required for some functionality when running the application locally. +1. Install Redis if you haven't already: + * Using **MacOS**: `brew install redis` +2. Run Redis server: + * Using **MacOS**: `brew services start redis` +3. Run SideKiq: `bundle exec sidekiq` +4. If SideKiq started correctly Redis is now configured and working! + ## SSL in Development We, at Public Lab use [openssl](https://github.com/ruby/openssl) gem to provide SSL for the secure connection in the development mode. You can run the https connection on the localhost by following following steps: