directus-labs / heroku-template

Template to deploy Directus on Heroku

Directus for Heroku

This template demonstrates building Directus for Heroku. It contains addons to let you run Directus with PostgreSQL and Redis.

Features

• Node.js (via nodejs buildpack)
• PostgreSQL (via postgresql addon)
• Redis (via redis addon)
• Email (via mailgun addon)

File uploads

Make sure to configure the storage settings for your project, otherwise you won't be able to upload files to your instance. This template has some placeholder settings to guide on how to configure storage using DigitalOcean spaces, but you can use any (non local) compatible storage service in Heroku. For more information on how to configure Directus storage, check our supported environment variables.

Post-install

Email settings

This template uses Mailgun starter addon to setup emails for you project. It's highly recommended that you configure the email to your preferred settings after provisioning your project.

Admin user

Your initial admin email and password is created based on ADMIN_EMAIL and ADMIN_PASSWORD you set on project creation. If you don't have those set, random ones are going to be provisioned for you, and you must check the deployment logs via heroku releases to get them.

After you log in for the first time, be sure to update your email and password immediately and remove those variables from your environment.

Database

This template uses PostgreSQL, but Directus supports a number of other options that can be easily substituted using other Heroku addons.

• MySQL
• PostgreSQL
• SQL Server

References

• Directus Documentation
• Heroku Documentation

heroku-template's Issues

Upgrading to premium databases fails connection

Hey there! I'm using this repository to get my own Directus Heroku app up and running, and noticed that when attaching a production-grade database (non-hobby) Directus can't connect because the connection string doesn't have SSL enabled. I was able to work around by just attaching ?ssl=true to the string in my config.js, but wanted to give a heads up to anyone who may run into the same issue.

App creation failed

Hi there,
does this template still work?
I've tried to deploy multiple times but it keeps failing - see screenshot.
Thanks for assistance.

Unable to create app

Deploying the app with default avluies on Heroku results in a failure at the Run scripts & scale dynos stage. There is an error message provided: "App creation failed. Please ensure you have valid values in the above form fields."

Can the defaults be updated to deliver the one-click deployment experience expected from a Heroku button?