Configuring Discourse on Ghost
DoG has several configuration options which should be included in your .env file, using the {key}="{value}" syntax.
For optional values, it’s recommended to not include them in your .env file as the default value might change for improved functionality or compatibility.
You can comment out values by prefixing them with a #. (e.g. # DOG_KEY="value")
| Name | Type | Default Value (Yes=required) | Description |
|---|---|---|---|
| DOG_HOSTNAME | IP Address | 127.0.0.1 | The hostname for DoG to listen |
| DOG_PORT | Port | 3286 | The port for DoG to listen |
| DOG_GHOST_URL | URL | Yes | The URL of your Ghost installation |
| DOG_GHOST_ADMIN_URL | URL | {DOG_GHOST_URL} | The Admin URL of your Ghost installation. This is only required if your admin URL differs from your site URL (e.g. on Ghost(Pro)) |
| DOG_DISCOURSE_SHARED_SECRET | string | Yes* | The shared secret for Discourse SSO |
| DOG_GHOST_ADMIN_TOKEN | string | Yes | Admin token for your Ghost installation - Ghost Docs (needs to be an API+webhook integration) |
| DOG_DISCOURSE_URL | URL | Yes | The URL of your Discourse installation |
| DOG_DISCOURSE_API_KEY | string | Yes | The API key for your Discourse installation - create one at https://your.discourse.example/admin/api/keys. User Level: All Users, Scope: Global |
| DOG_DISCOURSE_API_USER | username | system | The username for the user that performs actions when using the Discourse API |
| DOG_LOG_DISCOURSE_REQUESTS | boolean | false | Whether to log requests made to Discourse. There could be some user-specific information in the logs |
| DOG_LOG_GHOST_REQUESTS | boolean | false | Whether to log requests made to Ghost. There could be some user-specific information in the logs |
| DOG_GHOST_MEMBER_WEBHOOKS_ENABLED | boolean | false | Whether to enable the Ghost member webhooks (used to sync membership tiers) |
| DOG_GHOST_MEMBER_WEBHOOKS_SECRET_VERSION | enum | 2 | Which version of Ghost’s webhook signing to use. This depends on your Ghost version. |
| DOG_GHOST_MEMBER_UPDATED_WEBHOOK_ID | string | Yes* | The endpoint to listen for Ghost Member Updated webhooks. |
| DOG_GHOST_MEMBER_UPDATED_WEBHOOK_SECRET | string | false | The secret for the Ghost Member Updated webhook. Must be at least 8 characters. |
| DOG_GHOST_MEMBER_DELETED_WEBHOOK_ID | string | Yes* | The endpoint to listen for Ghost Member Deleted webhooks. |
| DOG_GHOST_MEMBER_DELETED_WEBHOOK_SECRET | string | false | The secret for the Ghost Member Deleted webhook. Must be at least 8 characters. |
| DOG_GHOST_MEMBER_DELETE_DISCOURSE_ACTION | enum | Yes | The action to take on Discourse when a Ghost member is deleted |
| DOG_DISCOURSE_SSO_TYPE | enum | Yes | The type of SSO to use for Discourse (see Pick your Path) |
| DOG_JWT_GHOST_SSO_PAGE | path | /sso/ | When using JWT auth, the path to the landing page. Must be an absolute path with a trailing slash. Example landing pages are on GitHub |
| DOG_SSO_NO_AUTH_REDIRECT | URL | {ghost_url} /#/portal/account | A custom landing page to redirect to if the user is not authenticated. Example landing pages are on GitHub |
*These values are shared with either Discourse or Ghost. If you don’t specify a value, DoG will suggest one for you.
Enums
Some of the configuration options have a fixed set of values to choose how DoG behaves.
DOG_GHOST_MEMBER_WEBHOOKS_SECRET_VERSION
| Value | Description |
|---|---|
| 0 | Ghost versions before 5.11.0, when webhooks were not signed. Note: This value is only support for completeness, and you should set the secret value to "". |
| 1 | Ghost versions 5.11.0 to 5.87.0 |
| 2 | Ghost versions 5.87.1 and later |
DOG_GHOST_MEMBER_DELETE_DISCOURSE_ACTION
Configures how DoG responds to the Member Deleted Ghost event.
Note: The member won’t be signed out of any Discourse sessions, but since Ghost is the SSO provider for Discourse, they won’t be able to explicitly log in until they become a member again.
| Value | Action Taken |
|---|---|
| none | Do nothing |
| sync | Remove the member from any Discourse Groups associated with a Ghost user |
| suspend | Suspend the member’s Discourse account |
| anonymize | Anonymize the member’s Discourse account. Data will be retained, but not be associated with the member |
| delete | Delete the member’s Discourse account. All data will be deleted |
DOG_DISCOURSE_SSO_TYPE
Configures how DoG handles SSO. Refer to the Pick your Path section on the home page.
Supported values: session, or jwt