Skip to content
On this page

Gem server authentication

Avo comes in a few tiers. The Community tier which comes as a free gem available on and a few paid tiers which come in private gems hosted on our own private gems server (

In order to have access to the paid gems you must authenticate using the Gem Server Token found on your license page.

There are a few ways to do that, but we will focus on the most important and secure ones for on the server and CI systems and on your local development environment.


We'll use the xxx notiation instead of the actual gem server token.

On the server and CI systems


This is the recommended way for most use cases.

The best way to do it is to register this environment variable so bundler knows to use it when pulling packages from

# or
BUNDLE_PACKAGER__DEV=xxx bundle install

Each hosting service will have their own way to add environment variables. Check out how to do it on Heroku or Hatchbox.

Warning about using the .env file

You might be tempted to add the token to your .env file, as you might do with your Rails app. That will not work because bundler will not automatically load those environment variables.

You should add the environment variable through the service dedicated page or by running the export command before bundle install.

On your local development environment

For your local development environment you should add the toke to the default bundler configuration. This way bundler is aware of it without having to specify it in the Gemfile.

bundle config set --global xxx

Add Avo to your Gemfile

Now you are ready to add Avo to your Gemfile.

# Aadd one of the following in your Gemfile depending on the tier you are on.

# Avo Community
gem 'avo', '~> 3.0', '>= 3.0.2'

# Avo Pro
gem "avo-pro", source: ""

# Avo Advanced
gem "avo-advanced", source: ""

Now you can run bundle install and bundler will pick it up and use it to authenticate on the server.

Configure Heroku

If you're using heroku, you can set the environment variable using the following command. This way bundler will use it when authenticating to

heroku config:set BUNDLE_PACKAGER__DEV=xxx

Configure Hatchbox

If you're using Hatchbox, you can set the environment variable in your apps "Environment" tab. This way bundler will use it when authenticating to