Configuration options

🚧 Docs in-progress

Some of these are specific to Co-op Cloud hosting

Basic

• TYPE, SITE_URL, LETS_ENCRYPT_ENV - leave as-is
• DOMAIN - this is the domain name which resolves to karrot. Should be set to the same as app name
• SITE_NAME - what you want your Karrot instance to be called. This will appear i.e. in registration mails.
• SITE_LOGO - set to Karrot project logo by default, point it to a .png image reachable via http(s)

GeoIP

• MAXMIND_ACCOUNT_ID and MAXMIND_LICENSE_KEY are API credentials from maxmind.com. You need an account there to get GeoIP data for Karrot. You only need the free account and then generate the license key.

Email

Karrot uses both outgoing and incoming email.

• EMAIL_BACKEND:
  • if set to console, no e-mails will be sent to users, instead they will be logged to app service logs and accessible by running abra app logs <karrot app name> app. Useful for debugging!
  • if set to smtp you have to configure an e-mail server using the SMTP_* options
  • if you set to postal you will need a postal instance and then configure the POSTAL_* options below
• EMAIL_FROM - the sender e-mail address

SMTP settings

• SMTP_USER - login to the SMTP server. Often the same as EMAIL_FROM.
• SMTP_PASSWORD - password for the SMTP server
• SMTP_HOST - domain (or IP address) of the SMTP server
• SMTP_USE_SSL - leave commented. If you want to use SSL instead of TLS set SMTP_USE_TLS to false and this to true
• SMTP_USE_TLS - set to true to enable encryption
• SMTP_PORT - set to 587 which is default TLS SMTP port.

Postal settings

If you're using postal, you'll also need to configure that appropriately, which is out of the scope of this document. You're welcome to contact us about that, we use postal ourselves.

• POSTAL_API_URL - a URL to a postal server
• POSTAL_API_KEY - postal API key
• POSTAL_WEBHOOK_KEY - postal webhook key (for incoming email)