heroku_san安装教程：Rails 3+、Rails 2与Sinatra三种框架如何快速接入Heroku部署

heroku_san安装教程：Rails 3+、Rails 2与Sinatra三种框架如何快速接入Heroku部署

【免费下载链接】heroku_sanHelpful stuffs for Heroku.项目地址: https://gitcode.com/gh_mirrors/he/heroku_san

heroku_san 是一款面向 Ruby 开发者的 Heroku 部署辅助工具，通过一组强大的 Rake 任务，帮你把同一份代码快速部署到多个 Heroku 应用（生产、预发、演示环境）上。本教程将手把手教你在 Rails 3+、Rails 2 和 Sinatra 三种框架中完成 heroku_san 的安装与基础配置，零基础也能一步到位。

📦 它是什么？能帮你做什么？

在接触安装之前，先花 30 秒了解 heroku_san 的核心价值：

• 多环境管理：一份代码同时对接 production、staging、demo 等多个 Heroku 应用
• 统一部署命令：rake production deploy即可推送、迁移数据库并重启服务
• 一键配置变量：批量为每个应用写入 config:vars、设置 RACK_ENV
• 开箱即用的 Rake 任务：部署、重启、看日志、远程控制台、维护模式等一应俱全

💡 前置提醒：使用 heroku_san 前，请先安装 Heroku Toolbelt 命令行工具，它是所有远程操作的基础。

✅ 安装前准备（三种框架通用）

开始之前，请确认两件事：

1. 本地项目已是 Git 仓库，并已关联好远程仓库
2. 已安装并登录 Heroku 命令行工具，能正常执行heroku apps

完成这两步后，就可以按你的框架选择对应的安装方式了。

🚀 方式一：Rails 3+ 安装（最省力）

Rails 3 及以上版本的接入是最简单的，得益于自动加载机制，只需两步。

第 1 步：添加依赖

打开项目根目录的Gemfile，在 development 分组中加入一行：

group :development do gem 'heroku_san' end

保存后执行bundle install即可完成任务。任务文件会随 Railtie 自动加载，无需任何额外配置。

第 2 步：生成配置文件

运行下面这条命令，会自动生成config/heroku.yml示例文件（由 heroku_san_generator.rb 中的生成器完成复制）：

rails generate heroku_san

✅ 完成！整个安装过程不超过 1 分钟。

🛠️ 方式二：Rails 2 安装（需要手动注册）

Rails 2 不会自动从 gem 中加载 Rake 任务，因此需要多写两段代码。

第 1 步：声明 gem 依赖

在config/environment.rb中加入：

config.gem 'heroku_san'

第 2 步：在 Rakefile 中显式加载任务

begin require 'heroku_san/tasks' rescue LoadError STDERR.puts "Run `rake gems:install` to install heroku_san" end

第 3 步：生成配置文件

Rails 2 没有生成器命令，改用 Rake 任务生成配置文件：

rake heroku:create_config

⚙️ 方式三：Sinatra 接入（指定 Sinatra 部署策略）

Sinatra 应用没有数据库迁移环节，因此 heroku_san 为它提供了专门的Sinatra 部署策略（只负责推送代码，不执行 migrate）。

第 1 步：Gemfile 添加依赖

与 Rails 3+ 相同，加入 development 分组即可。

第 2 步：配置 Rakefile

这是 Sinatra 接入的关键，需要手动创建项目对象并指定部署策略：

require "bundler/setup" begin require "heroku_san" config_file = File.join(File.expand_path(File.dirname(__FILE__)), 'config', 'heroku.yml') HerokuSan.project = HerokuSan::Project.new(config_file, :deploy => HerokuSan::Deploy::Sinatra) load "heroku_san/tasks.rb" rescue LoadError # 生产环境不安装该 gem，忽略即可 end

第 3 步：生成配置文件

同样执行rake heroku:create_config。

📄 三种框架安装方式对比

🏗️ 安装完成后：生成配置并发起首次部署

配置文件的模板结构可以参考项目自带的示例 heroku.example.yml，其格式为：

production: app: awesomeapp # 你的 Heroku 应用名 stack: cedar config: BUNDLE_WITHOUT: "development:test" staging: app: awesomeapp-staging config: BUNDLE_WITHOUT: "development:test"

对于全新项目，heroku_san 可以帮你一次性创建所有应用并设置 RACK_ENV：

rake all heroku:create heroku:rack_env

随后按配置批量写入环境变量，并执行首次部署：

rake all heroku:config rake production deploy

🧰 常用部署命令速查

安装并配置完成后，你会获得这些高频命令：

• rake demo staging restart— 同时重启 demo 和 staging 两个应用
• rake all restart— 对所有应用执行重启
• rake heroku:remotes— 为每个应用批量添加 git remote
• rake heroku:logs/rake heroku:logs:tail— 查看或实时跟踪日志
• rake heroku:console— 打开远程控制台
• rake heroku:shell— 进入应用内 bash 环境
• rake heroku:maintenance— 一键开启/关闭维护模式

任务完整定义可查看 tasks.rb，其中每个应用名还会自动注册为简写任务，比如staging等价于heroku:stage:staging。

❓ 常见问题（FAQ）

Q：加载任务时报LoadError怎么办？A：说明 gem 未安装。Rails 2 请执行rake gems:install，Bundler 项目执行bundle install。

Q：为什么我的项目部署时不想执行数据库迁移？A：可以自定义部署策略，继承默认的HerokuSan::Deploy::Base类并重写deploy方法，详细思路可参考项目自带的 deploy_strategies.md。

Q：如何在本地查看已配置的应用而不实际连接 Heroku？A：使用本地版任务：rake heroku:apps:local和rake heroku:config:list:local，不会发起任何远程请求。

🎯 写在最后

heroku_san 把 Heroku 多环境部署中最繁琐的重复劳动全部收敛为一条 Rake 命令。无论是 Rails 3+ 用户的一键接入，还是 Sinatra 用户按策略定制部署流程，10 分钟内即可完成从安装到首次部署的全过程。建议从本文「方式一」开始，跟着命令逐条执行，你的多环境部署体验会立刻变得干净利落。

【免费下载链接】heroku_sanHelpful stuffs for Heroku.项目地址: https://gitcode.com/gh_mirrors/he/heroku_san