框架 › Nest.js

將 Nest.js 應用程式部署到 Heroku

將帶有加密 .env.vault 檔案的 Nest.js 應用程式部署到 Heroku。

初始設定

安裝 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 檔案並重新部署即可。