Run Hasura GraphQL engine on Heroku¶

Step 1: Clone the Hasura GraphQL engine Heroku app¶

The Hasura app with Heroku buildpack/configuration is available at:

https://github.com/hasura/graphql-engine-heroku

Step 2: Create an app with –stack=container¶

Use the Heroku CLI to create a new Heroku app from inside the cloned directory. Let’s call the app graphql-on-postgres.

# Replace graphql-on-postgres with whatever you'd like your app to be called
$ heroku create graphql-on-postgres --stack=container

Creating ⬢ graphql-on-postgres... done, stack is container
https://graphql-on-postgres.herokuapp.com/ | https://git.heroku.com/graphql-on-postgres.git

Note:

• HEROKU_GIT_REMOTE: https://git.heroku.com/graphql-on-postgres.git
• HEROKU_APP_URL: https://graphql-on-postgres.herokuapp.com/

Step 3: Create the Heroku Postgres add-on¶

Create the Postgres add-on in your Heroku app.

$ heroku addons:create heroku-postgresql:hobby-dev -a graphql-on-postgres

Creating heroku-postgresql:hobby-dev on ⬢ graphql-on-postgres... free
Database has been created and is available
 ! This database is empty. If upgrading, you can transfer
  ! data from another database with pg:copy
  Created postgresql-angular-20334 as DATABASE_URL
  Use heroku addons:docs heroku-postgresql to view documentation

Step 4: git push to deploy¶

Remember to change HEROKU_GIT_REMOTE to your git remote below. In our case: https://git.heroku.com/graphql-on-postgres.git.

$ git init && git add .
$ git commit -m "first commit"
$ git remote add heroku <HEROKU_GIT_REMOTE>
$ git push heroku master

Visit https://graphql-on-postgres.herokuapp.com (replace graphql-on-postgres with your app name) and you should see the Hasura console.

Step 1: Deploy Hasura on Heroku¶

Deploy Hasura on Heroku as described in this section.

Step 2: Remove the created Postgres add-on in the app¶

Head to your Heroku dashboard and delete the Postgres add-on created in the previous step:

Step 3: Configure environment variables¶

Now configure the DATABASE_URL with your existing Heroku Postgres database URL and a HASURA_GRAPHQL_ADMIN_SECRET if you want to secure your endpoint.

Step 4: Track tables and relationships¶

Wait for the GraphQL engine to restart and then see Setting up a GraphQL schema using an existing database to enable GraphQL over the database.

Step 1: Clone the Hasura GraphQL engine Heroku app¶

The Hasura app with Heroku buildpack/configuration is available at:

https://github.com/hasura/graphql-engine-heroku

Step 2: Configure the database URL¶

Edit the command in the Dockerfile to change which database the Hasura GraphQL engine connects to. By default, it connects to the primary database in your app which is available at DATABASE_URL.

FROM hasura/graphql-engine:latest

# Change $DATABASE_URL to your Heroku Postgres URL if you're not using
# the primary Postgres instance in your app
CMD graphql-engine \
  --database-url $DATABASE_URL \
  serve \
  --server-port $PORT \
  --enable-console

Read about more configuration options here.

(optional) Use the admin secret with the CLI¶

In case you’re using the CLI to open the Hasura console, use the admin-secret flag when you open the console:

hasura console --admin-secret=myadminsecretkey

Step 1: Clone the Hasura GraphQL engine Heroku app¶

The Hasura app with Heroku buildpack/configuration is available at: https://github.com/hasura/graphql-engine-heroku.

Clone the above repository.

git clone https://github.com/hasura/graphql-engine-heroku
cd graphql-engine-heroku

If you already have this, then pull the latest changes which will have the updated GraphQL engine Docker image.

Step 2: Attach your Heroku app¶

Let’s say your Heroku app is called hasura-heroku and is running on https://hasura-heroku.herokuapp.com.

From inside the graphql-engine-heroku directory, use the Heroku CLI to configure the git repo you cloned in Step 1 to be able to push to this app.

# Replace <hasura-heroku> with your Heroku app's name
heroku git:remote -a <hasura-heroku>
heroku stack:set container -a <hasura-heroku>

You can find your Heroku git repo in your Heroku - Settings - Info - Heroku Git URL

Step 3: git push to deploy the latest Hasura GraphQL engine¶

When you git push to deploy, the Heroku app will get updated with the latest changes:

git push heroku master