config default value and better documentation

botpress · Feb 27, 2020 · 7b85f42 · 7b85f42
1 parent 3c2f669
commit 7b85f42
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/modules/channel-messenger/README.md b/modules/channel-messenger/README.md
@@ -17,8 +17,10 @@ Messenger requires you to have a Facebook App and a Facebook Page to setup your
 #### Enable the Messenger Channel
 
 - Run Botpress Server a first time to auto-generate the global configuration file
+- Enable `channel-messenger` module in the global configuration file
 - Head over to `data/global/config/channel-messenger.json`. If it doesn't exist, restart Botpress Server.
 - Set the following properties:
+  - `enabled` to `true`
   - `appSecret`. You will find this value in your Facebook App page.
   - `verifyToken`. This is a random string you need to generate and keep secret. You'll need to copy/paste this token in the Facebook App portal when setting up your webhook.
 - Make sure you have an HTTPS url pointing to your Botpress Server and set the [`EXTERNAL_URL`](https://botpress.com/docs/manage/configuration#exposing-your-bot-on-the-internet) environment variable

diff --git a/modules/channel-messenger/src/config.ts b/modules/channel-messenger/src/config.ts
@@ -15,12 +15,14 @@ export interface Config {
    * This this in the GLOBAL config (same for all bots)
    * Your app's "App Secret"
    * Find this secret in your developers.facebook.com -> your app -> Settings -> Basic -> App Secret -> Show
+   * @default app_secret
    */
   appSecret: string
   /**
    * Set this in the GLOBAL config (same for all the bots)
    * The verify token, should be a random string unique to your server. This is a random (hard to guess) string of your choosing.
    * Docs: https://developers.facebook.com/docs/messenger-platform/getting-started/webhook-setup/#verify_webhook
+   * @default verify_token
    */
   verifyToken: string
   /**