框架 › Remix.js

將 Remix.js 應用程式部署到 Vercel

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

初始設定

建立 Remix.js 應用程式。

npx create-remix@latest

這會建立一些檔案。

ls -1
README.md
app/
build/
node_modules/
package-lock.json
package.json
public/
remix.config.js
remix.env.d.ts
tsconfig.json

編輯 app/routes/_index.tsx 以使用 Remix loader 包含 process.env.HELLO。

app/routes/_index.tsx

import type { V2_MetaFunction } from "@remix-run/node";
import { json } from "@remix-run/node";
import { useLoaderData } from "@remix-run/react";

export const meta: V2_MetaFunction = () => {
  return [
    { title: "New Remix App" },
    { name: "description", content: "Welcome to Remix!" },
  ];
};

export async function loader() {
  require('dotenv').config()

  return json({
    ENV: {
      HELLO: process.env.HELLO, // HELLO="World" in .env file
    },
  });
}

export default function Index() {
  const data = useLoaderData()

  return (
    <div>
      Hello {data.ENV.HELLO}.
    </div>
  );
}

新增 .vercelignore 檔案。

.vercelignore

.env*
!.env.vault

將其提交到程式碼並部署到 Vercel。

npx vercel@latest deploy --prod

yourapp.vercel.app

部署後，您的應用程式會顯示 'Hello .'，因為它還沒有方法存取環境變數。接下來我們來處理這個問題。

預先載入 dotenv

安裝 dotenv。

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

在專案根目錄中建立 .env 檔案。

.env

# .env
HELLO="World"

使用 dotenv 預先載入 Remix.js 指令碼。這會在 Remix.js 之前注入環境變數。

package.json

"scripts": {
  "build": "node -r dotenv/config ./node_modules/.bin/remix build",
  "dev": "node -r dotenv/config ./node_modules/.bin/remix dev",
  "start": "node -r dotenv/config ./node_modules/.bin/remix-serve build",
},

嘗試在本地執行它。

npm run dev
# Visit https://127.0.0.1:3000

它會顯示「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 在 Vercel 上設定 DOTENV_KEY。

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]

或使用 Vercel 的 UI。

vercel.com

部署

將這些變更安全地提交到程式碼並部署。

npx vercel@latest deploy --prod

就是這樣！在部署時，您的 .env.vault 檔案將被解密，其生產機密將作為環境變數注入 - 恰好及時。

yourapp.vercel.app

您已成功使用新的 .env.vault 標準來加密和部署您的機密。這比將您的機密分散到多個第三方平台和工具中安全得多。每當您需要新增或變更機密時，只需重建您的 .env.vault 檔案並重新部署即可。