Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for Deploying to Heroku to README #986

Merged
merged 3 commits into from
Aug 20, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@ Suspenders also comes with:

## Heroku

Read the documentation on [deploying to Heroku][heroku deploy]

You can optionally create Heroku staging and production apps:

suspenders app --heroku true
Expand All @@ -131,6 +133,7 @@ This:
* Schedules automated backups for 10AM UTC for both `staging` and `production`

[Heroku Pipeline]: https://devcenter.heroku.com/articles/pipelines
[heroku deploy]: https://github.com/thoughtbot/suspenders/blob/master/docs/heroku_deploy.md

You can optionally specify alternate Heroku flags:

Expand Down
22 changes: 22 additions & 0 deletions docs/heroku_deploy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Deploying to Heroku

## Setup

Deploying to Heroku requires two additional steps:

1. Manually add buildpacks `node.js` and `ruby` (in that order) to your Heroku
app. This is necessary because build order is important and Heroku's
auto-detection will add them in the wrong order.

2. Set the following environment variables:

- `ASSET_HOST`: `siteURL.herokuapp.com`
- `APPLICATION_HOST`: `siteURL.herokuapp.com`
- `SMTP_ADDRESS`: `smtp.example.com`
- `SMTP_DOMAIN`: `example.com`
- `SMTP_USERNAME`: `username`
- `SMTP_PASSWORD`: `password`

## Execution

- Use the `./bin/deploy` convention for deploying to Heroku