Configuring Self-Hosted Canonic

THIS PAGE
Environment Variables

You can configure the application in a variety of ways to add support for your services and their related authentication credentials.

Environment Variables

All configuration is done through environment variables passed to docker when running the image. You can configure authentication keys for all the services you would like to enable on Canonic.


LICENSE

This is the key used by Canonic to authenticate your license. Limits are based on the plan that you buy. To generate a license key, head over to your profile settings. Create an access token with all the permission checkboxes selected. This key acts like your license.


APP_URL

Example: https://my-canonic.com

When you're hosting Canonic anywhere except your dev environment, you want it accessible on a publicly accessible url. This can either be the public IP address or the hostname.


MONGO_URL

Example: mongodb://username+password@localhost:27017

Mongodb URI. If you want to persist your mongodb data, you can use your own mongodb database instead of persisting it on the container instance.


MAILGUN_USERNAME

Example: self-hosted@mg.canonic.dev

We use default smtp credentials to deliver emails. If you want to use your own mailgun account, you can specify the username here.

MAILGUN_PASSWORD

The password for the mailgun account specified in MAILGUN_USERNAME


AUTH_GOOGLE_CALLBACK_URL

Example: https://my-canonic.com/auth/google

If you want to add login with Google to your self-hosted app, you can specify the callback url here.

AUTH_GOOGLE_CLIENT_ID

The client ID for sign in with Google

AUTH_GOOGLE_SECRET

The client secret for sign in with Google


Did you find what you were looking for?
👍
👎
What went wrong?
Need more help?We have a thriving Discordcommunity that can help you with all things Canonic. →