Installation Quickstart

This process will install Girder’s prerequisites for a Python 2 environment on common systems.

Basic System Prerequisites

To install basic system prerequisites, run the command:

sudo apt-get install -y python-pip python-virtualenv git

To install system prerequisites for Girder’s ldap plugin, run the command:

sudo apt-get install -y libldap2-dev libsasl2-dev

To install basic system prerequisites, run the command:

sudo apt-get install -y python-pip python-virtualenv python-dev git

To install system prerequisites for Girder’s ldap plugin, run the command:

sudo apt-get install -y libldap2-dev libsasl2-dev

To install basic system prerequisites:

First, enable the Extra Packages for Enterprise Linux YUM repository:

sudo yum -y install epel-release

Then, run the command:

sudo yum -y install python2-pip python-virtualenv gcc python-devel curl git

To install system prerequisites for Girder’s ldap plugin, run the command:

sudo yum -y install openldap-devel cyrus-sasl-devel

Install Homebrew.

To install all the prerequisites at once just use:

brew install python

Note

OS X ships with Python in /usr/bin, so you might need to change your PATH or explicitly run /usr/local/bin/python when invoking the server so that you use the version with the correct site packages installed.

Python Virtual Environment (optional)

To create and enable a Python virtual environment, run the commands:

virtualenv girder_env
source girder_env/bin/activate
pip install -U pip setuptools

Note

You will need to re-run

source girder_env/bin/activate

in any other shell where you want to install or run Girder.

MongoDB

To install, run the commands:

sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 2930ADAE8CAF5059EE73BB4B58712A2291FA4AD5
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu xenial/mongodb-org/3.6 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.6.list
sudo apt-get update
sudo apt-get install -y mongodb-org-server mongodb-org-shell

MongoDB server will register itself as a systemd service (called mongod). To start it immediately and on every reboot, run the commands:

sudo systemctl start mongod
sudo systemctl enable mongod

To install, run the commands:

sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 2930ADAE8CAF5059EE73BB4B58712A2291FA4AD5
echo "deb [ arch=amd64 ] https://repo.mongodb.org/apt/ubuntu trusty/mongodb-org/3.6 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.6.list
sudo apt-get update
sudo apt-get install -y mongodb-org-server mongodb-org-shell

MongoDB server will register itself as an Upstart service (called mongod), and will automatically start immediately and on every reboot.

To install, create a file at /etc/yum.repos.d/mongodb-org-3.6.repo, with:

[mongodb-org-3.6]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/3.6/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-3.6.asc

then run the command:

sudo yum -y install mongodb-org-server mongodb-org-shell

MongoDB server will register itself as a systemd service (called mongod), and will automatically start on every reboot. To start it immediately, run the command:

sudo systemctl start mongod

To install, run the command:

brew install mongodb

MongoDB does not run automatically as a service on macOS, so you’ll need to either configure it as a service yourself, or just ensure it’s running manually via the following command:

mongod -f /usr/local/etc/mongod.conf

Node.js

Node.js v8.0 is the active LTS release, though later versions can also be used instead.

To install, run the commands:

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs

To install, run the commands:

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs

To install, run the commands:

curl --silent --location https://rpm.nodesource.com/setup_8.x | sudo bash -
sudo yum -y install nodejs

To install, run the command:

brew install node

Girder

Proceed to the installation guide to install Girder itself.