Before you install, see the System Prerequisites guide to make sure you have all required system packages installed.

Install with pip

To install the Girder distribution from the python package index, simply run

pip install girder

This will install the core Girder server as a site package in your system or virtual environment. At this point, you might want to check the configuration to change your plugin and logging paths. In order to use the web interface, you must also install the web client libraries. Girder installs a python script that will automatically build and install these libraries for you. Just run the following command:

girder-install web


Installing the web client code requires the node package manager (npm). See the System Prerequisites section for instructions on installing nodejs.


If you installed Girder into your system site-packages, you may need to run the above commands as root.

Once this is done, you are ready to start using Girder as described in this section: Run.

Install from Git Checkout

Obtain the Girder source code by cloning the Git repository on GitHub:

git clone
cd girder

To run the server, you must install some external Python package dependencies:

pip install -r requirements.txt

To build the client-side code project, cd into the root of the repository and run:

npm install

This will run multiple Grunt tasks, to build all of the Javascript and CSS files needed to run the web client application.


To run the server, first make sure the Mongo daemon is running. To manually start it, run:

mongod &

If you installed with pip, you will have the girder-server executable on your path and can simply call


- or -

If you checked out the source tree, you can start the server with the following command, which will have identical behavior:

python -m girder

Then open http://localhost:8080/ in your web browser, and you should see the application.

Initial Setup

The first user to be created in the system is automatically given admin permission over the instance, so the first thing you should do after starting your instance for the first time is to register a user. After that succeeds, you should see a link appear in the navigation bar that says Admin console.

The next recommended action is to enable any plugins you want to run on your server. Click the Admin console navigation link, then click Plugins. Here, you can turn plugins on or off. Whenever you change the set of plugins that are enabled, you must restart the CherryPy server for the change to take effect. For information about specific plugins, see the Plugins section.

After you have enabled any desired plugins and restarted the server, the next recommended action is to create an Assetstore for your system. No users can upload data to the system until an assetstore is created, since all files in Girder must reside within an assetstore. See the Assetstores section for a brief overview of Assetstores.

Installing third-party plugins

Girder ships with a standard library of plugins that can be enabled in the admin console, but it’s common for Girder installations to require additional third-party plugins to be installed. If you’re using a pip installed version of Girder, you can simply use the following command:

girder-install plugin /path/to/your/plugin

That command will expose the plugin to Girder and build any web client targets associated with the plugin. You will still need to enable it in the console and then restart the Girder server before it will be active.


The girder-install plugin command can also accept a list of plugins to be installed. You may need to run it as root if you installed Girder at the system level.

For development purposes it is possible to symlink (rather than copy) the plugin directory. This is accomplished with the -s or --symlink flag:

girder-install -s plugin /path/to/your/plugin

Enabled plugins installed with -s may be edited in place and those changes will be reflected after a server restart.