框架 › Nest.js

将 Nest.js 应用程序部署到 Heroku

使用加密的 .env.vault 文件将 Nest.js 应用程序部署到 Heroku。

在此指南中，您可以在 GitHub 上找到完整的代码示例。

初始设置

安装 nestjs。

npm i -g @nestjs/cli
nest new yourapp

编辑 src/app.service.ts。将 Hello World 替换为 Hello ${process.env.HELLO}。

src/app.service.ts

import { Injectable } from '@nestjs/common';

@Injectable()
export class AppService {
  getHello(): string {
    return `Hello ${process.env.HELLO}`;
  }
}

修改 src/main.ts 以使用动态端口。

src/main.ts

await app.listen(process.env.PORT || 3000);

添加一个 Procfile 以在 Heroku 上运行您的应用程序。

Procfile

web: npm run start:prod

将这些内容提交到代码并将其推送到 Heroku。

heroku create
git push heroku

yourapp.herokuapp.com

部署后，您的应用程序将显示 'Hello undefined'，因为它还没有访问环境变量的方法。我们接下来将进行此操作。

安装

安装 dotenv。

npm install dotenv --save # Requires dotenv >= 16.1.0

在项目根目录中创建一个 .env 文件。

.env

# .env
HELLO="World"

尽早地在应用程序中导入和配置 dotenv。

src/app.module.ts

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';

import * as dotenv from "dotenv";
dotenv.config();
console.log(process.env) // remove this after you've confirmed it is working

@Module({
  imports: [],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

尝试在本地运行它。

npm run start

它应该显示 Hello World。

太好了！process.env 现在拥有您在 .env 文件中定义的键和值。这涵盖了本地开发。接下来，我们来解决生产环境问题。

构建 .env.vault

推送您最新的 .env 文件更改并编辑您的生产秘密。了解有关同步的更多信息

npx dotenv-vault@latest push
npx dotenv-vault@latest open production

使用 UI 为每个环境配置这些秘密。

www.dotenv.org

然后构建您的加密 .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。

www.heroku.com

部署

将这些更改安全地提交到代码并进行部署。

就是这样！在部署时，您的 .env.vault 文件将被解密，其生产秘密将及时作为环境变量注入。

yourapp.herokuapp.com

当您在日志中看到 'Loading env from encrypted .env.vault' 时，您就会知道操作成功。如果没有设置 DOTENV_KEY（例如，在本地机器上进行开发时），它将回退到标准 dotenv 功能。

heroku logs --tail

您成功使用新的 .env.vault 标准来加密和部署您的秘密。这比将您的秘密散布在多个第三方平台和工具中要安全得多。无论何时需要添加或更改秘密，只需重新构建您的 .env.vault 文件并重新部署。