Dependencies

Supplejack requires the following to run the full stack. Please review this page carefully as some of these dependencies are version specific and failure to use the correct versions will cause problems.

Note for OSX users We recommend OSX users use the Homebrew package manager to manage the installation of Ruby, MongoDB and Redis. If you’re new to Homebrew, here is an introduction.

  • We recommend performing brew update to update your Homebrew formula list. This does not update your installed packages. It simply updates the versions and availability of packages you could install. Although brew update is listed for each installation, you probably only need to run the command at the start of an installation session.
  • Use brew doctor after system changes or if you need to troubleshoot your Homebrew installation.

Ruby

Version: 3.0.x

Description: Ruby is a general purpose programming language. The Rails web framework and all Supplejack components are written in Ruby.

Installation instructions OSX/Linux/Unix:

We strongly recommend using rbenv to manage your ruby versions. OSX and *nix users can install rbenv from Github checkout: https://github.com/sstephenson/rbenv#installation

Once rbenv is installed, you should install Ruby 2.3.0.

$ rbenv install 3.0.x

Alternative rbnenv installation for OSX using Homebrew:

OSX users should consider an alternative mode of installation using the Homebrew package manager. The rbenv github page describes this process, but the key commands are:

$ brew update
$ brew doctor
$ brew install rbenv ruby-build
$ echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile

Once rbenv is installed, you should install Ruby 2.3.0.

$ rbenv install 3.0.x

Installation instructions Windows:

You can use RubyInstaller to set up a full Ruby development environment on Windows.

For more information on how to install ruby, you can refer to official ruby guide.

Rails

Version: 7.0.2.2

Description: Rails is a full-stack open source web application framework.

Installation instructions: http://rubyonrails.org/download/

If you are using rbenv, simply enter the following command:

gem install rails -v '7.0.2.2'

MongoDB

Version: 4.0 or greater

Description: Supplejack uses MongoDB as a data store. You can learn about MongoDB on its website or on the Wikipedia page.

Installation instructions: https://docs.mongodb.com/v3.4/installation/.

Alternative installation for OSX using Homebrew:

If you are using Mac OSX we recommend installing MongoDB with Homebrew.

$ brew update
$ brew doctor
$ brew install mongodb

Redis

Version: 2.4 or greater

Description: Supplejack uses Sidekiq for background processing and queue management. Sidekiq requires Redis as a concurrency safe data store.

Installation instructions: http://redis.io/download

Alternative installation for OSX using Homebrew:

If you are using Mac OSX we recommend using Homebrew to install Redis:

$ brew update
$ brew doctor
$ brew install redis

Java

Version: 7 or greater

Description: Java is a general purpose programming language. The Solr search platform is written in Java.

Installation instructions: https://www.java.com/en/download/help/download_options.xml

Installation instructions for OSX: http://support.apple.com/kb/DL1572

Apache Solr

Version: 6.4

Description: Solr is the full-text search platform that underpins the Supplejack Records API.

Installation instructions:

A development version of Solr is automatically installed during Supplejack installation.

For production installation see Production Install.