將 PM2 應用程式部署到 Heroku
將具有加密 .env.vault 檔案的 PM2 應用程式部署到 Heroku。
請在 GitHub 上找到本指南的完整程式碼範例。
初始設定
產生 ecosystem.config.js 檔案。
pm2 init
根據您的需求進行修改。類似這樣。
ecosystem.config.js
module.exports = {
apps : [{
script: 'index.js',
watch: '.'
}]
};
您的 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}/`);
});
將 pm2 新增為相依性。
npm install pm2 --save
在您的 package.json 中，修改您的啟動腳本。
package.json
{
"scripts": {
"start": "pm2-runtime start ecosystem.config.js --env production"
},
"dependencies": {
"pm2": "^5.3.0"
}
}
將其提交到程式碼並推送至 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')
...
嘗試在本地執行它。
pm2 start
➜ pm2-example git:(master) ✗ pm2 start
[PM2] Applying action restartProcessId on app [index](ids: [ 1 ])
[PM2] [index](1) ✓
┌────┬────────────────────┬──────────┬──────┬───────────┬──────────┬──────────┐
│ id │ name │ mode │ ↺ │ status │ cpu │ memory │
├────┼────────────────────┼──────────┼──────┼───────────┼──────────┼──────────┤
│ 0 │ index │ fork │ 0 │ online │ 0% │ 1.2mb │
└────┴────────────────────┴──────────┴──────┴───────────┴──────────┴──────────┘
它應該顯示 Hello World。
太棒了！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 檔案並重新部署即可。