框架 › Rails

将 Rails 应用部署到 Heroku

将带有加密 .env.vault 文件的 Rails 应用部署到 Heroku。

在本指南中找到一个完整的 GitHub 上的代码示例。

初始设置

安装 Rails。

gem install rails

创建一个新的 Rails 项目。

rails new yourapp

编辑 config/routes.rb 并将根路径设置为 www#index。

config/routes.rb

Rails.application.routes.draw do
  get "up" => "rails/health#show", as: :rails_health_check
  root "www#index"
end

创建 app/controllers/www_controller.rb。

app/controllers/www_controller.rb

class WwwController < ApplicationController
  def index
  end
end

创建 app/views/www/index.html.erb。

app/views/www/index.html.erb

Hello <%= ENV["HELLO"] %>.

将代码提交并推送到 Heroku。

heroku create
git push heroku

yourapp.herokuapp.com

部署后，您的应用会显示 'Hello .'，因为它还没有访问环境变量的方法。我们接下来将解决这个问题。

安装 dotenv-vault-rails

将 dotenv-vault-rails 添加到 Gemfile 的顶部。

Gemfile

source "https://rubygems.org.cn"
ruby "3.1.3"
gem "dotenv-vault-rails", require: "dotenv-vault/rails-now"
gem "rails", "~> 7.1.1"
...

bundle install

在项目根目录中创建一个 .env 文件。

.env

# .env
HELLO="World"

尝试在本地运行它。

bin/rails server
=> Booting Puma
=> Rails 7.1.1 application starting in development
* Listening on http://127.0.0.1:3000
* Listening on http://[::1]:3000

它应该显示 Hello World。

太棒了！现在 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 文件并重新部署即可。