Getting Started with Rails 5.x on Heroku

Last updated 26 September 2016

Ruby on Rails is a popular web framework written in Ruby. This guide covers using Rails 5 on Heroku. For information about running previous versions of Rails on Heroku, see Getting Started with Rails 4.x on Heroku or Getting Started with Rails 3.x on Heroku.

For this guide you will need:

  • Basic Ruby/Rails knowledge.
  • A locally installed version of Ruby 2.2.0+, Rubygems, Bundler, and Rails 5+.
  • Basic Git knowledge.
  • A Heroku user account: Signup is free and instant.

Local workstation setup

Install the Heroku Toolbelt on your local workstation. This ensures that you have access to the Heroku command-line client, Heroku Local, and the Git revision control system. You will also need Ruby and Rails installed.

Once installed, you’ll have access to the $ heroku command from your command shell. Log in using the email address and password you used when creating your Heroku account:

Note that $ symbol before commands indicates they should be run on the command line, prompt, or terminal with appropriate permissions. Do not copy the $ symbol.

$ heroku login
Enter your Heroku credentials.
Email: schneems@example.com
Password:
Could not find an existing public key.
Would you like to generate one? [Yn]
Generating new SSH public key.
Uploading ssh public key /Users/adam/.ssh/id_rsa.pub

Press enter at the prompt to upload your existing ssh key or create a new one, used for pushing code later on.

Write your app

To run on Heroku, your app must be configured to use the Postgres database, have all dependencies declared in your Gemfile.

If you are starting from an existing app, upgrade to Rails 5 before continuing. If not, a vanilla Rails 5 app will serve as a suitable sample app. To build a new app make sure that you’re using the Rails 5.x using $ rails -v. You can get the new version of rails by running,

$ gem install rails --no-ri --no-rdoc
Successfully installed rails-5.0.0.1
1 gem installed

Then create a new app:

$ rails new myapp --database=postgresql

Then move into your application directory.

$ cd myapp

If you experience problems or get stuck with this tutorial, your questions may be answered in a later part of this document. If you experience a problem, try reading through the entire document and then go back to your issue. It can also be useful to review your previous steps to ensure they all executed correctly.

Database

If you already have an app that was created without specifying --database=postgresql you will need to add the pg gem to your Rails project. Edit your Gemfile and change this line:

gem 'sqlite3'

To this:

gem 'pg'

We highly recommend using PostgreSQL during development. Maintaining parity between your development and deployment environments prevents subtle bugs from being introduced because of differences between your environments. Install Postgres locally now if it is not already on your system.

Now re-install your dependencies (to generate a new Gemfile.lock):

$ bundle install

To get more information on why this change is needed and how to configure your app to run Postgres locally, see why you cannot use Sqlite3 on Heroku.

In addition to using the pg gem, you’ll also need to ensure the config/database.yml is using the postgresql adapter.

The development section of your config/database.yml file should look something like this:

$ cat config/database.yml
# PostgreSQL. Versions 9.1 and up are supported.
#
# Install the pg driver:
#   gem install pg
# On OS X with Homebrew:
#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
# On OS X with MacPorts:
#   gem install pg -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
# On Windows:
#   gem install pg
#       Choose the win32 build.
#       Install PostgreSQL and put its /bin directory on your path.
#
# Configure Using Gemfile
# gem 'pg'
#
default: &default
  adapter: postgresql
  encoding: unicode
  # For details on connection pooling, see rails configuration guide
  # http://guides.rubyonrails.org/configuring.html#database-pooling
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>

development:
  <<: *default
  database: myapp_development

  # The specified database role being used to connect to postgres.
  # To create additional roles in postgres see `$ createuser --help`.
  # When left blank, postgres will use the default role. This is
  # the same name as the operating system user that initialized the database.
  #username: myapp

  # The password associated with the postgres role (username).
  #password:

  # Connect on a TCP socket. Omitted by default since the client uses a
  # domain socket that doesn't need configuration. Windows does not have
  # domain sockets, so uncomment these lines.
  #host: localhost

  # The TCP port the server listens on. Defaults to 5432.
  # If your server runs on a different port number, change accordingly.
  #port: 5432

  # Schema search path. The server defaults to $user,public
  #schema_search_path: myapp,sharedapp,public

  # Minimum log levels, in increasing order:
  #   debug5, debug4, debug3, debug2, debug1,
  #   log, notice, warning, error, fatal, and panic
  # Defaults to warning.
  #min_messages: notice

# Warning: The database defined as "test" will be erased and
# re-generated from your development database when you run "rake".
# Do not set this db to the same as development or production.
test:
  <<: *default
  database: myapp_test

# As with config/secrets.yml, you never want to store sensitive information,
# like your database password, in your source code. If your source code is
# ever seen by anyone, they now have access to your database.
#
# Instead, provide the password as a unix environment variable when you boot
# the app. Read http://guides.rubyonrails.org/configuring.html#configuring-a-database
# for a full rundown on how to provide these environment variables in a
# production deployment.
#
# On Heroku and other platform providers, you may have a full connection URL
# available as an environment variable. For example:
#
#   DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
#
# You can use this database configuration with:
#
#   production:
#     url: <%= ENV['DATABASE_URL'] %>
#
production:
  <<: *default
  database: myapp_production
  username: myapp
  password: <%= ENV['MYAPP_DATABASE_PASSWORD'] %>

Be careful here. If you omit the sql at the end of postgresql in the adapter section, your application will not work.

$ rails generate controller welcome

Welcome page

Rails 5 no longer has a static index page in production. When you’re using a new app, there will not be a root page in production, so we need to create one. We will first create a controller called welcome for our home page to live:

Next we’ll add an index page.

In file app/views/welcome/index.html.erb write:

<h2>Hello World</h2>
<p>
  The time is now: <%= Time.now %>
</p>

Now we need to make Rails route to this action. We’ll edit config/routes.rb to set the index page to our new method:

In file config/routes.rb, on line 2 add:

  root 'welcome#index'

You can verify that the page is there by running your server:

$ rails server

And visiting http://localhost:3000 in your browser. If you do not see the page, use the logs that are output to your server to debug.

Heroku gems

Previous versions of Rails required you toadd a gem to your project rails_12factor to enable static asset serving and logging on Heroku. If you are deploying a new application this gem is not needed. If you are upgrading an existing application you can remove this gem provided you have the apprpriate configuration in your config/environments/production.rb file:

# config/environments/production.rb
config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
if ENV["RAILS_LOG_TO_STDOUT"].present?
  logger           = ActiveSupport::Logger.new(STDOUT)
  logger.formatter = config.log_formatter
  config.logger = ActiveSupport::TaggedLogging.new(logger)
end

Specify Ruby version in app

Rails 5 requires Ruby 2.2.0 or above. Heroku has a recent version of Ruby installed, however you can specify an exact version by using the ruby DSL in your Gemfile.

At the end of Gemfile add:

ruby "2.3.1"

You should also be running the same version of Ruby locally. You can check this by running $ ruby -v. You can get more information on specifying your Ruby version on Heroku here.

Store your app in Git

Heroku relies on Git, a distributed source control management tool, for deploying your project. If your project is not already in Git, first verify that git is on your system:

$ git --help
usage: git [--version] [--help] [-C <path>] [-c name=value]
           [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
           [-p | --paginate | --no-pager] [--no-replace-objects] [--bare]
           [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
           <command> [<args>]

If you don’t see any output or get command not found you will need to install it on your system. Verify that the Heroku toolbelt is installed.

Once you’ve verified that Git works, first make sure you are in your Rails app directory by running $ ls:

The output should look like this:

$ ls
Gemfile
Gemfile.lock
README.md
Rakefile
app
bin
config
config.ru
db
lib
log
public
test
tmp
vendor

Now run these commands in your Rails app directory to initialize and commit your code to Git:

$ git init
$ git add .
$ git commit -m "init"

You can verify everything was committed correctly by running:

$ git status
On branch master
nothing to commit, working directory clean

Now that your application is committed to Git you can deploy to Heroku.

Deploy your application to Heroku

Make sure you are in the directory that contains your Rails app, then create an app on Heroku:

$ heroku create
Creating app... done, infinite-scrubland-50119
https://infinite-scrubland-50119.herokuapp.com/ | https://git.heroku.com/infinite-scrubland-50119.git

You can verify that the remote was added to your project by running:

$ git config --list | grep heroku
remote.heroku.url=https://git.heroku.com/infinite-scrubland-50119.git
remote.heroku.fetch=+refs/heads/*:refs/remotes/heroku/*

If you see fatal: not in a git directory then you are likely not in the correct directory. Otherwise you may deploy your code. After you deploy your code, you will need to migrate your database, make sure it is properly scaled, and use logs to debug any issues that come up.

Deploy your code:

$ git push heroku master
remote: Compressing source files... done.
remote: Building source:
remote:
remote: -----> Ruby app detected
remote: -----> Compiling Ruby/Rails
remote: -----> Using Ruby version: ruby-2.3.1
remote: -----> Installing dependencies using bundler 1.11.2
remote:        Running: bundle install --without development:test --path vendor/bundle --binstubs vendor/bundle/bin -j4 --deployment
remote:        Warning: the running version of Bundler is older than the version that created the lockfile. We suggest you upgrade to the latest version of Bundler by running `gem install bundler`.
remote:        Fetching gem metadata from https://rubygems.org/..........
remote:        Fetching version metadata from https://rubygems.org/...
remote:        Fetching dependency metadata from https://rubygems.org/..
remote:        Installing rake 11.3.0
remote:        Installing concurrent-ruby 1.0.2
remote:        Installing i18n 0.7.0
remote:        Installing thread_safe 0.3.5
remote:        Installing minitest 5.9.1
remote:        Installing builder 3.2.2
remote:        Installing erubis 2.7.0
remote:        Installing mini_portile2 2.1.0
remote:        Installing pkg-config 1.1.7
remote:        Installing rack 2.0.1
remote:        Installing websocket-extensions 0.1.2
remote:        Installing nio4r 1.2.1 with native extensions
remote:        Installing mime-types-data 3.2016.0521
remote:        Installing arel 7.1.2
remote:        Installing coffee-script-source 1.10.0
remote:        Installing execjs 2.7.0
remote:        Installing method_source 0.8.2
remote:        Installing thor 0.19.1
remote:        Installing multi_json 1.12.1
remote:        Installing pg 0.19.0 with native extensions
remote:        Installing puma 3.6.0 with native extensions
remote:        Using bundler 1.11.2
remote:        Installing sass 3.4.22
remote:        Installing tilt 2.0.5
remote:        Installing turbolinks-source 5.0.0
remote:        Installing tzinfo 1.2.2
remote:        Installing nokogiri 1.6.8 with native extensions
remote:        Installing websocket-driver 0.6.4 with native extensions
remote:        Installing rack-test 0.6.3
remote:        Installing sprockets 3.7.0
remote:        Installing mime-types 3.1
remote:        Installing coffee-script 2.4.1
remote:        Installing uglifier 3.0.2
remote:        Installing turbolinks 5.0.1
remote:        Installing activesupport 5.0.0.1
remote:        Installing mail 2.6.4
remote:        Installing globalid 0.3.7
remote:        Installing activemodel 5.0.0.1
remote:        Installing jbuilder 2.6.0
remote:        Installing activejob 5.0.0.1
remote:        Installing activerecord 5.0.0.1
remote:        Installing loofah 2.0.3
remote:        Installing rails-dom-testing 2.0.1
remote:        Installing rails-html-sanitizer 1.0.3
remote:        Installing actionview 5.0.0.1
remote:        Installing actionpack 5.0.0.1
remote:        Installing actionmailer 5.0.0.1
remote:        Installing actioncable 5.0.0.1
remote:        Installing railties 5.0.0.1
remote:        Installing sprockets-rails 3.2.0
remote:        Installing coffee-rails 4.2.1
remote:        Installing jquery-rails 4.2.1
remote:        Installing rails 5.0.0.1
remote:        Installing sass-rails 5.0.6
remote:        Bundle complete! 15 Gemfile dependencies, 54 gems now installed.
remote:        Gems in the groups development and test were not installed.
remote:        Bundled gems are installed into ./vendor/bundle.
remote:        Bundle completed (31.24s)
remote:        Cleaning up the bundler cache.
remote:        Warning: the running version of Bundler is older than the version that created the lockfile. We suggest you upgrade to the latest version of Bundler by running `gem install bundler`.
remote: -----> Preparing app for Rails asset pipeline
remote:        Running: rake assets:precompile
remote:        I, [2016-09-26T03:01:38.942438 #1126]  INFO -- : Writing /tmp/build_4d8f5efc72950386614e8eb901709d0a/public/assets/application-ea005870b2299ed0464e134ab4079aa8856885e9ffd3d81e60417322f2fa0a97.js
remote:        I, [2016-09-26T03:01:38.943047 #1126]  INFO -- : Writing /tmp/build_4d8f5efc72950386614e8eb901709d0a/public/assets/application-ea005870b2299ed0464e134ab4079aa8856885e9ffd3d81e60417322f2fa0a97.js.gz
remote:        I, [2016-09-26T03:01:38.955861 #1126]  INFO -- : Writing /tmp/build_4d8f5efc72950386614e8eb901709d0a/public/assets/application-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.css
remote:        I, [2016-09-26T03:01:38.956050 #1126]  INFO -- : Writing /tmp/build_4d8f5efc72950386614e8eb901709d0a/public/assets/application-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.css.gz
remote:        Asset precompilation completed (3.87s)
remote:        Cleaning assets
remote:        Running: rake assets:clean
remote:
remote: ###### WARNING:
remote:        No Procfile detected, using the default web server.
remote:        We recommend explicitly declaring how to boot your server process via a Procfile.
remote:        https://devcenter.heroku.com/articles/ruby-default-web-server
remote:
remote: -----> Discovering process types
remote:        Procfile declares types     -> (none)
remote:        Default types for buildpack -> console, rake, web, worker
remote:
remote: -----> Compressing...
remote:        Done: 29.4M
remote: -----> Launching...
remote:        Released v5
remote:        https://infinite-scrubland-50119.herokuapp.com/ deployed to Heroku
remote:
remote: Verifying deploy... done.
To https://git.heroku.com/infinite-scrubland-50119.git
 * [new branch]      master -> master

It is always a good idea to check to see if there are any warnings or errors in the output. If everything went well you can migrate your database.

Migrate your database

If you are using the database in your application you need to manually migrate the database by running:

$ heroku run rake db:migrate

Any commands after the heroku run will be executed on a Heroku dyno. You can obtain an interactive shell session by running $ heroku run bash.

Visit your application

You’ve deployed your code to Heroku. You can now instruct Heroku to execute a process type. Heroku does this by running the associated command in a dyno, which is a lightweight container that is the basic unit of composition on Heroku.

Let’s ensure we have one dyno running the web process type:

$ heroku ps:scale web=1

You can check the state of the app’s dynos. The heroku ps command lists the running dynos of your application:

$ heroku ps
=== web (Standard-1X): bin/rails server -p $PORT -e $RAILS_ENV (1)
web.1: starting 2016/09/25 22:01:48 -0500 (~ 2s ago)

Here, one dyno is running.

We can now visit the app in our browser with heroku open.

$ heroku open

You should now see the “Hello World” text we inserted above.

Heroku gives you a default web URL for simplicity while you are developing. When you are ready to scale up and use Heroku for production you can add your own custom domain.

View the logs

If you run into any problems getting your app to perform properly, you will need to check the logs.

You can view information about your running app using one of the logging commands, heroku logs:

$ heroku logs
2016-09-26T03:00:55.758775+00:00 heroku[api]: Enable Logplex by developer@example.com
2016-09-26T03:00:55.758891+00:00 heroku[api]: Release v2 created by developer@example.com
2016-09-26T03:01:46.381291+00:00 heroku[api]: Set LANG, RACK_ENV, RAILS_ENV, RAILS_LOG_TO_STDOUT, RAILS_SERVE_STATIC_FILES, SECRET_KEY_BASE config vars by developer@example.com
2016-09-26T03:01:46.381363+00:00 heroku[api]: Release v3 created by developer@example.com
2016-09-26T03:01:47.316077+00:00 heroku[api]: Attach DATABASE (@ref:postgresql-lively-89835) by developer@example.com
2016-09-26T03:01:47.316191+00:00 heroku[api]: Release v4 created by developer@example.com
2016-09-26T03:01:47.869728+00:00 heroku[api]: Scale to web=1 by developer@example.com
2016-09-26T03:01:47.870311+00:00 heroku[api]: Deploy a00a888 by developer@example.com
2016-09-26T03:01:47.870408+00:00 heroku[api]: Release v5 created by developer@example.com
2016-09-26T03:01:48.481407+00:00 heroku[slug-compiler]: Slug compilation started
2016-09-26T03:01:48.481412+00:00 heroku[slug-compiler]: Slug compilation finished
2016-09-26T03:01:50.745055+00:00 heroku[web.1]: Starting process with command `bin/rails server -p 48308 -e production`

You can also get the full stream of logs by running the logs command with the --tail flag option like this:

$ heroku logs --tail

Dyno sleeping and scaling

By default, new applications are deployed to a free dyno. Free apps will “sleep” to conserve resources. You can find more information about this behavior by reading about free dyno behavior.

To avoid dyno sleeping, you can upgrade to a hobby or professional dyno type as described in the Dyno Types article. For example, if you migrate your app to a professional dyno, you can easily scale it by running a command telling Heroku to execute a specific number of dynos, each running your web process type.

Rails console

Heroku allows you to run commands in a one-off dyno - scripts and applications that only need to be executed when needed - using the heroku run command. Use this to launch a Rails console process attached to your local terminal for experimenting in your app’s environment:

$ heroku run rails console
irb(main):001:0> puts 1+1
2

Another useful command for debugging is $ heroku run bash which will spin up a new dyno and give you access to a bash session.

Rake

Rake can be run as an attached process exactly like the console:

$ heroku run rake db:migrate

Webserver

By default, your app’s web process runs rails server, which uses Puma in Rails 5. If you are upgrading an app you’ll need to add puma to your application Gemfile:

gem 'puma'

Then run

$ bundle install

Now you are ready to configure your app to use Puma. For this tutorial we will use the default settings of Puma, but we recommend generating a config/puma.rb file and reading more about configuring your application for maximum performance by reading the Puma documentation

Finally you will need to tell Heroku how to run your Rails app by creating a Procfile in the root of your application directory.

Procfile

Change the command used to launch your web process by creating a file called Procfile and entering this:

In file Procfile write:

web: bundle exec puma -t 5:5 -p ${PORT:-3000} -e ${RACK_ENV:-development}

Note: The case of Procfile matters, the first letter must be uppercase.

We recommend generating a Puma config file based on our Puma documentation for maximum performance.

To use the Procfile locally you can use foreman.

$ gem install foreman

In addition to running commands in your Procfile foreman can also help you manage environment variables locally through a .env file. Set the local RACK_ENV to development in your environment and a PORT to connect to. Before pushing to Heroku you’ll want to test with the RACK_ENV set to production since this is the environment your Heroku app will run in.

$ echo "RACK_ENV=development" >>.env
$ echo "PORT=3000" >> .env

Note: Another alternative to using environment variables locally with a .env file is the dotenv gem.

You’ll also want to add .env to your .gitignore since this is for local environment setup.

$ echo ".env" >> .gitignore
$ git add .gitignore
$ git commit -m "add .env to .gitignore"

Test your Procfile locally using Foreman. You can now start your web server by running:

$ foreman start
18:24:56 web.1  | I, [2013-03-13T18:24:56.885046 #18793]  INFO -- : listening on addr=0.0.0.0:3000 fd=7
18:24:56 web.1  | I, [2013-03-13T18:24:56.885140 #18793]  INFO -- : worker=0 spawning...
18:24:56 web.1  | I, [2013-03-13T18:24:56.885680 #18793]  INFO -- : master process ready
18:24:56 web.1  | I, [2013-03-13T18:24:56.886145 #18795]  INFO -- : worker=0 spawned pid=18795
18:24:56 web.1  | I, [2013-03-13T18:24:56.886272 #18795]  INFO -- : Refreshing Gem list
18:24:57 web.1  | I, [2013-03-13T18:24:57.647574 #18795]  INFO -- : worker=0 ready

Looks good, so press Ctrl+C to exit and you can deploy your changes to Heroku:

$ git add .
$ git commit -m "use puma via procfile"
$ git push heroku master

Check ps. You’ll see that the web process uses your new command specifying Puma as the web server.

$ heroku ps
=== web (Standard-1X): bundle exec puma -t 5:5 -p ${PORT:-3000} -e ${RACK_ENV:-development} (1)
web.1: starting 2016/09/25 22:02:15 -0500 (~ 2s ago)

The logs also reflect that we are now using Puma.

$ heroku logs

Rails asset pipeline

There are several options for invoking the Rails asset pipeline when deploying to Heroku. For general information on the asset pipeline please see the Rails 3.1+ Asset Pipeline on Heroku Cedar article.

The config.assets.initialize_on_precompile option has been removed is and not needed for Rails 5. Also, any failure in asset compilation will now cause the push to fail. For Rails 5 asset pipeline support see the Ruby Support page.

Troubleshooting

If you push up your app and it crashes (heroku ps shows state crashed), check your logs to find out what went wrong. Here are some common problems.

Runtime dependencies on development/test gems

If you’re missing a gem when you deploy, check your Bundler groups. Heroku builds your app without the development or test groups, and if you app depends on a gem from one of these groups to run, you should move it out of the group.

One common example is using the RSpec tasks in your Rakefile. If you see this in your Heroku deploy:

$ heroku run rake -T
Running `bundle exec rake -T` attached to terminal... up, ps.3
rake aborted!
no such file to load -- rspec/core/rake_task

Then you’ve hit this problem. First, duplicate the problem locally:

$ bundle install --without development:test
…
$ bundle exec rake -T
rake aborted!
no such file to load -- rspec/core/rake_task

Now you can fix it by making these Rake tasks conditional on the gem load. For example:

Rakefile

begin
  require "rspec/core/rake_task"
  desc "Run all examples"
  RSpec::Core::RakeTask.new(:spec) do |t|
    t.rspec_opts = %w[--color]
    t.pattern = 'spec/**/*_spec.rb'
  end
rescue LoadError
end

Confirm it works locally, then push to Heroku.

Done

You have deployed your first application to Heroku. The next step is to deploy your own application. You can read more about Ruby on Heroku at the Dev Center.

bundler rails ruby

Feedback

Log in to submit feedback.