框架 › Remix.js

将 Remix.js 应用程序部署到 Vercel

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

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

初始设置

创建 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 加载器包含 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 文件并重新部署即可。