Updated the bbb-webhooks documentation. Ensuring the configuration file gets ignored. #11308
Conversation
There was a problem hiding this comment.
Good job @AlexJezior, would you please take a look at my comments? Thanks!
bbb-webhooks/README.md
Outdated
|
|
||
| This is a node.js application that listens for all events on BigBlueButton and sends POST requests with details about these events to hooks registered via an API. A hook is any external URL that can receive HTTP POST requests. | ||
|
|
||
| You can read the full documentation at: https://docs.bigbluebutton.org/dev/webhooks.html | ||
| You can read the full documentation at: http://docs.bigbluebutton.org/labs/webhooks.html |
There was a problem hiding this comment.
Interesting! I don't even recall making this change; should be resolved now.
| getRaw: false | ||
| } | ||
| ] | ||
| ``` |
There was a problem hiding this comment.
Two suggestions:
- permanentURLs is above the hooks attribute, so I suggest to modify the sentence to something like "Locate hooks.permanentURLs on config/default.yml and modify it as follows:"
- use the yaml syntax as follows:
permanentURLs:
- url: 'https://staging.example.com/webhook-post-route'
getRaw: false
- url: 'https://app.example.com/webhook-post-route'
getRaw: false
| sudo make install | ||
| ~~~ | ||
| If you are editing these permanent urls after they have already been committed to the application once, you may need to flush the redis database in order for adjustments to these permanent hooks to get picked up by your application. Use the following command to do so: | ||
| - `redis-cli flushall` |
There was a problem hiding this comment.
Please add a warning mentioning that all events will be wiped from redis, which means that no ongoing recording will be processed.
bbb-webhooks/.gitignore
Outdated
| config_local.coffee | ||
| config_local.js |
There was a problem hiding this comment.
Would you please remove these two, since they are no longer used?
There was a problem hiding this comment.
Almost did this originally, but wasn't sure if there would be potential lingering configurations floating around out there that we would still like to keep out of the repository.
|
@AlexJezior Thank you for your contribution! Could you please confirm you have filled out a CLA? https://docs.bigbluebutton.org/support/faq.html#why-do-i-need-to-sign-a-contributor-license-agreement-to-contribute-source-code ? |
|
@fcecagno @antobinary My pleasure to help! I did fill out and email the CLA yesterday to the ffdixon@bigbluebutton.org email address. |
The current bbb-webhooks
readme.mddocumentation doesn't accurately tell how to get the bbb-webhooks configured for custom development, and release procedures. Updates are my venture into configuring webhooks for my own personal use, while providing documentation to help others in the future from having to start a new topic in regards, on the bigbluebutton-dev group forum.