将 Node.js 应用部署到 Heroku
使用加密的 .env.vault 文件将 Node.js 应用部署到 Heroku。
在本指南中,您可以在 GitHub 上找到一个完整的 代码示例。
初始设置
添加 Procfile
来运行您的 Node.js 应用。
Procfile
web: node index.js
您的 index.js
文件应该看起来像这样。
index.js
// 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}/`);
});
添加一个 package.json
文件。
package.json
{}
将其提交到代码并推送到 Heroku。
heroku create
git push heroku
部署后,您的应用会显示 'Hello undefined'
,因为它还没有访问环境变量的方式。接下来,我们将解决这个问题。
安装 dotenv
安装 dotenv
。
npm install dotenv --save # Requires dotenv >= 16.1.0
在项目的根目录中创建一个 .env
文件。
.env
# .env
HELLO="World"
尽早地在您的应用程序中导入并配置 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')
...
尝试在本地运行它。
node index.js
{
...
HELLO: 'World'
}
Server running on port:3000/
完美。process.env
现在拥有您在 .env
文件中定义的键和值。
这涵盖了本地开发。接下来,我们将解决生产环境的问题。
构建 .env.vault
推送您最新的 .env
文件更改,并编辑您的生产密钥。 了解有关同步的更多信息
npx dotenv-vault@latest push
npx dotenv-vault@latest open production
使用 UI 为每个环境配置这些密钥。
然后构建您的加密 .env.vault
文件。
npx dotenv-vault@latest build
其内容应该看起来像这样。
.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
设置 DOTENV_KEY
获取您的生产 DOTENV_KEY
。
npx dotenv-vault@latest keys production
# outputs: dotenv://:[email protected]/vault/.env.vault?environment=production
使用 CLI 在 Heroku 上设置 DOTENV_KEY
。
heroku config:set DOTENV_KEY='dotenv://:key_1234…@dotenv.org/vault/.env.vault?environment=production'
或者使用 Heroku 的 UI。
部署
将这些更改安全地提交到代码并部署。
就是这样!在部署时,您的 .env.vault
文件将被解密,其生产密钥将被注入为环境变量 - 恰逢其时。
当您在日志中看到 'Loading env from encrypted .env.vault'
时,您将知道一切正常。如果未设置 DOTENV_KEY
(例如在本地机器上进行开发时),它将回退到标准的 dotenv 功能。
您已成功使用新的 .env.vault 标准来加密和部署您的密钥。这比将您的密钥分散到多个第三方平台和工具中要安全得多。无论何时需要添加或更改密钥,只需重建您的 .env.vault 文件并重新部署即可。