Deploy a Node.js App to Vercel
Deploy a Node.js app with an encrypted .env.vault file to Vercel.
Find a complete code example on GitHub for this guide.
Initial setup
Create an index.js file, if you haven't already done so.
index.js
const PORT = process.env.PORT || 3000
const http = require('http')
const server = http.createServer((req, res) => {
res.statusCode = 200
res.setHeader('Content-Type', 'text/plain')
res.end(`Hello ${process.env.HELLO}`)
})
server.listen(PORT, () => {
console.log(`Server running on port:${PORT}/`)
})
Add vercel.json file.
vercel.json
{
"version": 2,
"builds": [
{
"src": "index.js",
"use": "@vercel/node"
}
],
"routes": [
{
"src": "/(.*)",
"dest": "index.js"
}
]
}
Add .vercelignore file.
.vercelignore
.env*
!.env.vault
Commit that to code and deploy it to Vercel.
npx vercel@latest deploy --prod
Once deployed, your app will say 'Hello undefined' as it doesn't have a way to access the environment variable yet. Let's do that next.
Install dotenv
Install dotenv.
npm install dotenv --save # Requires dotenv >= 16.1.0
Create a .env file in the root of your project.
.env
# .env
HELLO="World"
As early as possible in your application, import and configure dotenv.
index.js
// index.js
require('dotenv').config()
console.log(process.env) // remove this after you've confirmed it is working
const PORT = process.env.PORT || 3000
const http = require('http')
...
Try running it locally.
node index.js
{
...
HELLO: 'World'
}
Server running on port:3000/
Perfect. process.env now has the keys and values you defined in your .env file.
That covers local development. Let's solve for production next.
Build .env.vault
Push your latest .env file changes and edit your production secrets. Learn more about syncing
npx dotenv-vault@latest push
npx dotenv-vault@latest open production
Use the UI to configure those secrets per environment.
Then build your encrypted .env.vault file.
npx dotenv-vault@latest build
Its contents should look something like this.
.env.vault
#/-------------------.env.vault---------------------/
#/ cloud-agnostic vaulting standard /
#/ [how it works](https://dotenv.org/env-vault) /
#/--------------------------------------------------/
# development
DOTENV_VAULT_DEVELOPMENT="/HqNgQWsf6Oh6XB9pI/CGkdgCe6d4/vWZHgP50RRoDTzkzPQk/xOaQs="
DOTENV_VAULT_DEVELOPMENT_VERSION=2
# production
DOTENV_VAULT_PRODUCTION="x26PuIKQ/xZ5eKrYomKngM+dO/9v1vxhwslE/zjHdg3l+H6q6PheB5GVDVIbZg=="
DOTENV_VAULT_PRODUCTION_VERSION=2
Set DOTENV_KEY
Fetch your production DOTENV_KEY.
npx dotenv-vault@latest keys production
# outputs: dotenv://:[email protected]/vault/.env.vault?environment=production
Set DOTENV_KEY on Vercel using the CLI.
npx vercel@latest env add DOTENV_KEY
? What’s the value of DOTENV_KEY? dotenv://:[email protected]/vault/.env.vault?environment=production
✅ Added Environment Variable DOTENV_KEY to Project nodejs-vercel [94ms]
Or use Vercel's UI.
Deploy
Commit those changes safely to code and deploy.
That's it! On deploy, your .env.vault file will be decrypted and its production secrets injected as environment variables – just in time.
You succesfully used the new .env.vault standard to encrypt and deploy your secrets. This is much safer than scattering your secrets across multiple third-party platforms and tools. Whenever you need to add or change a secret, just rebuild your .env.vault file and redeploy.