将 Next.js 应用部署到 Netlify
将带有加密 .env.vault 文件的 Next.js 应用部署到 Netlify。
在本指南中,您可以找到一个完整的GitHub 代码示例。
初始设置
生成一个 **next.js** 应用。
npx create-next-app@latest --example hello-world .
这将创建一些文件。
ls -1
README.md
next-env.d.ts
node_modules
package-lock.json
package.json
pages
tsconfig.json
编辑 pages/index.tsx
以包含 process.env.NEXT_PUBLIC_HELLO
。
pages/index.tsx
export default function IndexPage() {
return (
<div>
Hello {process.env.NEXT_PUBLIC_HELLO}.
</div>
)
}
添加 netlify.toml
。
netlify.toml
[build]
command = "npm run build"
publish = ".next"
将这些提交到代码并将其部署到 Netlify。
npx netlify-cli@latest deploy --build --prod
部署后,您的应用将显示 Hello .
,因为它还没有方法访问环境变量。接下来让我们进行设置。
安装 dotenv
安装 dotenv
。
npm install dotenv --save # Requires dotenv >= 16.1.0
在您的项目根目录中创建一个 .env
文件。
.env
# .env
NEXT_PUBLIC_HELLO="World"
使用 dotenv 预加载 前缀您的 npm package.json scripts
。
package.json
"scripts": {
"dev": "node -r dotenv/config ./node_modules/.bin/next",
"build": "node -r dotenv/config ./node_modules/.bin/next build",
"start": "node -r dotenv/config ./node_modules/.bin/next start"
}
尝试在本地运行它。
npm run dev
started server on 0.0.0.0:3000, url: https://127.0.0.1:3000
完美。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 在 Netlify 上设置 DOTENV_KEY
。
npx netlify-cli@latest env:set DOTENV_KEY "dotenv://:[email protected]/vault/.env.vault?environment=production"
或者使用 Netlify 的 UI。
部署
将这些更改安全地提交到代码,然后重新部署到 Netlify。
npx netlify-cli@latest deploy --build --prod
就是这样!在部署时,您的 .env.vault
文件将被解密,其生产机密将作为环境变量注入 - 恰逢其时。
当您在日志中看到 'Loading env from encrypted .env.vault'
时,您就知道一切正常。如果未设置 DOTENV_KEY
(例如在本地机器上开发时),它将回退到标准 dotenv 功能。
您已成功使用新的 .env.vault 标准来加密和部署您的机密。这比将机密散布在多个第三方平台和工具中安全得多。无论何时需要添加或更改机密,只需重建您的 .env.vault 文件并重新部署即可。