Deploying

Environments

Jumpstart Pro is preconfigured with two environments for deploying: staging and production.

Background workers will be configured to run in all environments so you will have the same experience in development as you will in staging and production.

Email providers will only be configured for production by Jumpstart Pro, so you don't accidentally send emails to real users in staging.

Databases

Rails now ships with the Solid gems by default which means deploying requires 4 databases: Your primary database, solid queue, solid cache, and solid cable.

If you've switched to SQLite, you're good to go. Otherwise, make sure to provision databases for each of these and assign the matching environment variables to point to them.

• DATABASE_URL
• QUEUE_DATABASE_URL
• CACHE_DATABASE_URL
• CABLE_DATABASE_URL

Credentials

You will need to take the contents of config/credentials/staging.key or config/credentials/production.key (depending on what environment you're deploying) and set the RAILS_MASTER_KEY environment variable to the contents of this file. This will allow staging or production to decrypt your credentials for the correct environment.

Deploy to Hatchbox.io

Hatchbox.io is built by the makers of Jumpstart Pro and GoRails. It's a fantastically simple and cheap option for deploying apps to your own servers.

Deploy to Render.com

Jumpstart Pro comes with a render.yaml file that helps Render pre-configure your application.

Simply copy this URL and paste it into your browser, then change the GitHub URL to point to your private repository.

https://dashboard.render.com/blueprint/new?repo=https://github.com/jumpstart-pro/jumpstart-pro-rails

Deploy to Heroku

Deploying your Jumpstart Pro application to Heroku is simple since Jumpstart Pro includes a Procfile to help automatically configure your Heroku processes.

Deploy using Heroku Deploy Button

Jumpstart Pro comes with an app.json file that helps Heroku pre-configure your application if you use GitHub to host your Jumpstart Pro repo.

Heroku will use your connected GitHub account to access the private repo and find the app.json file to pre-configure your new app. You can read more about the Heroku Deploy Button for private repos here.

Simply copy this URL and paste it into your browser, then change the GitHub URL to point to your private repository.

https://www.heroku.com/deploy?template=https://github.com/username/jumpstart-pro-rails

You'll also need to configure databases for the Solid gems or Redis as needed.

Deploy using Heroku CLI

First, you'll need to install the Heroku CLI and login with heroku login

Now you can create a Heroku app by running heroku create myapp

We also need to tell Heroku which buildpacks to use:

heroku buildpacks:set heroku/ruby
heroku buildpacks:add --index 1 heroku/nodejs

You'll additionally need to setup the PostgreSQL and Redis addons to run your app as needed.

heroku addons:create heroku-postgresql

# If you're using Solid gems, create databases for them
heroku addons:create heroku-postgresql --as QUEUE_DATABASE
heroku addons:create heroku-postgresql --as CACHE_DATABASE
heroku addons:create heroku-postgresql --as CABLE_DATABASE

# If you're using Redis
heroku addons:create heroku-redis

Afterwards, you need to add the RAILS_MASTER_KEY environment variable and set it equal to the key inside config/credentials/production.key.

Then you can deploy your code to Heroku and run migrations.

git push heroku master
heroku run rails db:migrate

Docker

Rails provides an example Dockerfile for production deployments which is included in Jumpstart Pro.

Kamal

Jumpstart and Rails 8+ also includes Kamal by default. Replace IP addresses in the deploy.yml with that of your application and consult the Kamal documentation for configuring databases, environment variables, etc.

Production Admin Users

To create an admin user in production, you can either generate one using db/seeds.rb or run the following code in the rails console in production.

user = User.create!(
  name: "Steve Jobs",
  email: "steve@apple.com",
  password: "password",
  password_confirmation: "password",
  terms_of_service: true
)

Jumpstart.grant_system_admin! user