框架 › Sinatra

将 Sinatra 应用部署到 Heroku

将使用加密 .env.vault 文件的 Sinatra 应用部署到 Heroku。

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

初始设置

在您的 Gemfile 中安装 sinatra 和 rackup。

bundle add sinatra rackup

您的 Gemfile 应该类似于以下内容。

Gemfile

source "https://rubygems.org.cn"

gem "sinatra", "~> 3.0"
gem "rackup", "~> 1.0"

创建一个包含 Web 服务器代码的 index.rb 文件。

index.rb

require "sinatra"

get "/" do
  "Hello #{ENV["HELLO"]}."
end

创建 config.ru 文件。

config.ru

require "./index"
run Sinatra::Application

添加 Procfile 以在 Heroku 上运行您的应用。

Procfile

web: APP_ENV=production bundle exec rackup -p "$PORT"

将更改提交到代码并将其推送到 Heroku。

heroku create
git push heroku

yourapp.herokuapp.com

部署后，您的应用将显示 'Hello .'，因为它还没有访问环境变量的方法。接下来我们进行此操作。

安装 dotenv-vault

安装 dotenv-vault。

bundle add dotenv-vault

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

.env

# .env
HELLO="World"

在您的应用程序中尽早地需要并加载 dotenv-vault。

index.rb

require "dotenv-vault/load"
require "sinatra"

get "/" do
  "Hello #{ENV["HELLO"]}."
end

尝试在本地运行它。

ruby index.rb
== Sinatra (v3.0.6) has taken the stage on 4567 for development with backup from Puma
* Listening on http://127.0.0.1:4567

它应该显示 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

如果没有设置 DOTENV_KEY（例如在本地机器上开发时），它将回退到标准 dotenv 功能。

您已成功使用新的 .env.vault 标准来加密和部署您的密钥。这比将您的密钥散布在多个第三方平台和工具中安全得多。无论何时需要添加或更改密钥，只需重建 .env.vault 文件并重新部署。