There are many ways to deploy Girder into production. Here is a set of guides on how to deploy Girder to several different platforms.


This guide assumes you have a Heroku account and have installed the Heroku toolbelt.

Girder contains the requisite Procfile, buildpacks, and other configuration to be deployed on Heroku. To deploy Girder to your Heroku space, run the following commands. We recommend doing this on your own fork of Girder to keep any customization separate.

$ cd /path/to/girder/tree
$ heroku apps:create your_apps_name_here
$ heroku config:add BUILDPACK_URL=
$ heroku addons:add mongolab
$ git remote add heroku
$ git push heroku
$ heroku open

You should now see your Girder instance running on Heroku. Congratulations!

Apache Reverse Proxy

In many cases, it is useful to route multiple web services from a single server. You can configure Apache’s mod_proxy to route traffic to these services using a reverse proxy. For example, if you have an Apache server accepting requests at, and you want to forward requests to to a Girder instance listening on port 9000. You can add the following section to your Apache config:

<VirtualHost *:80>
    ProxyPass /girder http://localhost:9000
    ProxyPassReverse /girder http://localhost:9000

In such a scenario, Girder must be configured properly in order to serve content correctly. Fortunately, this can be accomplished by setting a few parameters in your local configuration file at girder/conf/girder.local.cfg. In this example, we have the following:

server.socket_host: ""
server.socket_port: 9000
tools.proxy.on: True
tools.proxy.base: ""
tools.proxy.local: ""

api_root: "/girder/api/v1"
static_root: "/girder/static"

After modifying the configuration, always remember to rebuild Girder by changing to the main Girder directory and issuing the following command:

$ grunt init && grunt

Docker Container

Every time a new commit is pushed to master, Docker Hub is updated with a new image of a docker container running Girder. This container exposes girder at port 8080 and requires the database URL to be passed in as an option. For more information, see the Docker Hub Page. Since the container does not run a databse, you’ll need to run a command in the form:

$ docker run -p 8080:8080 girder/girder -d mongodb://db-server-external-ip:27017/girder