Vercel with Rails
Learn how to make Vercel, Rails, and Dotenv Vault work together in a simple web app. This tutorial assumes you are already familiar with
.env files and know how to sync them.
You can find a complete example repo here.
First, create a Gemfile for your Rails application, if you haven’t done so already, by initializing it with
bundle init. Declare the
gem 'dotenv-vault-rails' in the Gemfile.
// Add gem reference to Gemfile gem 'dotenv-vault-rails'
// Install the gem bundle install
<h1>Welcome <%= ENV["HELLO"] %></h1>
config folder and an
application.rb file inside it. Reference the Vault package as early as possible in the file and apply the
/load parameter at the back.
// config/application.rb require 'dotenv-vault/load'
Build the Vault
Make sure you are logged in and in sync with your Vault first then run
npx dotenv-vault from CLI in your project root. This will build an encrypted .env.vault file that serves as a unique identifier for your project in Dotenv. Inside it you will find the public keys for every environment you have setup and must be committed to source.
npx dotenv-vault build
Fetch the keys
With the Vault successfully built, you now can fetch the
.env.vault decryption keys for each environment in the Vault project. Running
npx dotenv-vault keys production, for example, will return the
production key and so will
$ npx dotenv-vault keys production remote: Listing .env.vault decryption keys... done dotenv://:[email protected]/vault/.env.vault?environment=production
Now that you have access to the keys for every environment, you will have to reference them as environment variables in your Vercel project’s settings. To do that, navigate to your Project, then the Settings tab to reach the Environment Variable panel. Set as key
DOTENV_KEY and as value the decryption key returned in the previous step
Commit and push
Commit those changes safely to code and deploy to Vercel.
When the build runs, it will recognize the
DOTENV_KEY, decrypt the .env.vault file, and load the
production environment variables to
ENV. If a
DOTENV_KEY is not set when developing on local machine, for example, it will fall back to standard Dotenv functionality.