forked from oncokb/oncokb-public
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added testing slack section in the README
- Loading branch information
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -223,3 +223,39 @@ For more information refer to [Using Docker and Docker-Compose][], this page als | |
[definitelytyped]: https://definitelytyped.org/ | ||
[puppeteer]: https://developers.google.com/web/tools/puppeteer | ||
[cdp]: https://chromedevtools.github.io/devtools-protocol/ | ||
|
||
## Testing Slack Integration | ||
|
||
1. Ensure you can access the MSK secret server | ||
2. Ensure you can access the [Slack API Manager](https://api.slack.com/apps/AQC1QUJQK/interactive-messages) | ||
3. Install [ngrok](https://ngrok.com/download) | ||
4. Update the `/src/main/resources/config/application-dev.yml` file | ||
|
||
- Change `spring.mail.username` to [email protected] | ||
- Change `spring.mail.password` to the password for [email protected] found in the secret server | ||
- Check your `application.api-proxy-url` points to a running instance of OncoKB core | ||
- Change `application.slack.user-registration-webhook` to the slack hook. | ||
- Change `application.slack.slack-base-url` to https://oncokb.slack.com | ||
- Change `application.slack.user-registration-channel-id` to C03EASPQ8AZ | ||
- If you need to use a slack endpoint that requires a token, update | ||
`application.slack.slack-bot-oauth-token` with the token get from this [page](https://api.slack.com/apps/AQC1QUJQK/oauth). | ||
|
||
5. Start up ngrok | ||
|
||
```sh | ||
ngrok http http://localhost:9090 | ||
``` | ||
|
||
6. Copy the forwarding URL generated by ngrok. | ||
|
||
- Should be something like https://xxxx-xxx-xxx-xx-xx.ngrok-free.app | ||
|
||
7. Update the Request URL in the slack message configuration [in the Request URL](https://api.slack.com/apps/AQC1QUJQK/interactive-messages) to https://xxxx-xxx-xxx-xx-xx.ngrok-free.app/api/slack | ||
|
||
- Replace the base URL with the URL generated by grok for forwarding | ||
|
||
8. Register an account in your local instance of OncoKB public | ||
|
||
- Ensure the email you use is one you have access to | ||
|
||
9. Check the slack-app-dev channel for a message and approve it |