Skip to main content
Version: v3.0

Deployment

This guide is an introduction to deploying Rhino

General considerations​

Rhino uses server side cookies for auth, so you must have domains that meet the auth rules

Heroku​

The default Heroku stack heroku-24 is recommended. The deployment needs the heroku/nodejs and heroku/ruby buildpack. Along with the following add-ons:

heroku-postgresql:essential-0 heroku-redis:mini papertrail:choklad rollbar:trial-5k

Redis is required only for rhino_jobs support and rollbar is required for error trapping.

The server requires the following environment variables to be set:

    FRONT_END_URL=https://<host-name>,
    LANG=en_US.UTF-8
    RAILS_ENV=production
    ROOT_URL=https://<host-name>
    SECRET_KEY_BASE=<generated-secret-key>
    SENDGRID_API_KEY=<sendgrid-api-key>
    VITE_API_ROOT_PATH=https://<server-host-name>

Any additional environment variables that need to be passed to the frontend should be prefixed with VITE_

Heroku Docker​

Rhino comes with default support for deploying to Heroku with docker for server only. This is useful if you need to deploy custom tools to the image, for instance an SDK that needs to be built and called from ActiveJob.

Rhino does not directly support Heroku for the client because of https://devcenter.heroku.com/articles/build-docker-images-heroku-yml#set-build-time-environment-variables - build time variables cannot be sourced from environment variables. The Dockerfile must altered to provide VITE_API_ROOT_PATH directly.

Rhino uses the heroku.yml method of building and deploying docker images. https://devcenter.heroku.com/articles/build-docker-images-heroku-yml

The buildpack for docker should be set to the container type heroku stack:set container -a <app-name>

Docker​

$ docker build -t .
$ docker run -it --rm -p 3002:3002 -e FRONT_END_URL="http://localhost:3002" --build-arg VITE_API_ROOT_PATH=http://localhost:3002  -e PORT=3002 -e DISABLE_SSL=1 -e ROOT_URL=http://localhost:3002

FRONT_END_URL will default to http://localhost:3000 if not specified.

PORT will default to 3000 if not specified.

DISABLE_SSL=1 is necessary for SSL termination earlier in the process.

ROOT_URL defaults to http://localhost:3000 if not specified.

DB_NAME, DB_HOST, DB_USERNAME, DB_PASSWORD are also required for the postgres db.

DEFAULT_EMAIL_SENDER defaults to from@example.com if not specified.

VITE_API_ROOT_PATH is required at build time.