Modmail Docs
GitHubDonateSetupDiscord Server
  • Introduction
  • Installation
    • Local hosting / VPS
      • Windows
      • MacOS
      • Docker
      • Ubuntu
      • Debian
      • Fedora
      • Alma Linux
      • Logviewer
      • Patreon logviewer
    • Railway
    • Heroku
    • Community Guides
  • Setting up auto-restart
  • Updating
  • Getting Started
  • Usage
    • Plugins
    • Configuration
    • Permissions
  • Frequently Asked Questions
  • OLD DOCS
    • Installation
    • Installation (continued)
    • Color Names
    • Configuration Variables (Config Vars)
    • Configure Modmail and Logviewer
    • Frequently Asked Questions
    • Modmail Usage
    • Updating
    • Video Tutorials
Powered by GitBook
On this page
  • What is Heroku?
  • Requirements
  • Costs
  • Fork our GitHub repositories
  • Create a Heroku account
  • Updating

Was this helpful?

Edit on GitHub
  1. Installation

Heroku

Deploy Modmail on Heroku PaaS.

PreviousRailwayNextCommunity Guides

Last updated 2 years ago

Was this helpful?

What is Heroku?

Heroku is a container-based cloud Platform as a Service (PaaS). Developers use Heroku to deploy, manage, and scale modern apps.

Requirements

  • A credit card (for payment and verification).

  • An email account.

  • A account.

  • You have completed the initial steps: and .

Costs

Unfortunately, Heroku is no longer free-of-charge. You will need at least their Eco plan, which currently costs $5 USD per month. See their for more info and up-to-date prices.

If you are a higher-education student, you may be eligible for their , which grants you $13 USD of credits per month for 12 months—enough to host Modmail free for one year.

Fork our GitHub repositories

You will need to fork our repositories to deploy onto Heroku.

Make sure you're logged in to . You will need to fork two repositories.

Create a Heroku account

Updating

First we fork the Modmail repository. Head over to , leave all the settings as default, and click Create fork.

Next do the same for the Logviewer repository by heading over to , leave all the settings as default, and click Create fork.

Next, to keep your Modmail and Logviewer up to date, you will need to install the . Simply head over to , click Install, choose Only select repositories, then select both the Modmail and Logviewer repositories that you forked in the previous step.

Your GitHub should now be all set. Next step, to deploy your bot.

https://github.com/kyb3rr/modmail/fork
https://github.com/kyb3r/logviewer/fork
Pull app
https://github.com/apps/pull
create a Heroku account
GitHub
pricing page
student offer
GitHub
invited your bot
created a MongoDB database
Screenshot of creating a Modmail fork.
Create a GitHub fork for the Modmail Repository.
Screenshot of creating a Logviewer fork.
Create a GitHub fork for the Logviewer Repository.
Screenshot of installing the pull app.
Click Install to install the .
Screenshot of selecting both repositories.
Select both the Modmail and Logviewer forks, then click Install.
Pull app