OPG Incident Response is a Django app based on Monzo's Response tool, with some additional integrations with tools we use and a reskin to meet GOV.UK design standards.
To start the application locally, copy env.dev.example to .env and configure the environment variables inside. All environment variables need to be set, but some can be set to nonsense values (i.e. ENV_VAR=...) as detailed in the table below.
You will need to configure a Slack app following the instructions below, and can then start the application with docker-compose up -d. The app will be served by nginx on http://localhost:80/
Note if you are using ngrok, they have now introduced auth tokens. You can add an NGROK_AUTHTOKEN to your local .env file and it will be passed down to the container so you don't risk commiting it.
This project uses SemVer for versoning.
By default, any merge to main will be a MINOR release. You can control which version number to increment by add #major, #minor or #patch to the commit message that goes into main.
In order to avoid polluting our real Slack workspace, and to give you full control over permissions, you should configure your local copy of the app with your own Slack workspace.
You now need to create a Slack app and configure it. Note that you'll need your public ngrok URL to configure endpoints for Slack to use, which you can find by visiting the ngrok admin page which is visible on localhost:4040 once you have run docker-compose up.
After you've configured your app, Slack will provide you with bot OAuth token (starting xoxb-) and a signing secret, which should be used for the SLACK_TOKEN and SLACK_SIGNING_SECRET environment variables, respectively. You'll also need to set SLACK_TEAM_ID to the team ID of your Slack workspace.
Finally, you'll need to set INCIDENT_BOT_ID and INCIDENT_BOT_NAME to your bot's ID and public name; and INCIDENT_CHANNEL_NAME and INCIDENT_REPORT_CHANNEL_NAME to the central channel that you want to report all incidents to (e.g. opg-incident).
If you restart ngrok, it will generate a new public URL and you'll have to reconfigure the Slack app to reference that.
GitHub signin is turned off in dev mode, but you can enable it by enabling the RESPONSE_LOGIN_REQUIRED setting in dev.py.
To connect to GitHub, you'll need to create a GitHub OAuth App and set the environment variables SOCIAL_AUTH_GITHUB_KEY and SOCIAL_AUTH_GITHUB_SECRET to its the app's key and secret respectively. There is already an app called "opg-response-development" which is set up in the ministryofjustice organization for local development.
| Variable | Real value required? | Details |
|---|---|---|
| SECRET_KEY | Yes | Used by Django, can be set to anything |
| DJANGO_SETTINGS_MODULE | Yes | Specifies which settings to use. Should be opgincidentresponse.settings.dev in local environments |
| SOCIALAUTH* | Only if testing authentication | There's already a dev/localhost and production GitHub app you can use |
| SLACK_TOKEN | Yes | Provided when you create a Slack app |
| SLACK_SIGNING_SECRET | Yes | Provided when you create a Slack app |
| SLACK_TEAM_ID | Yes | You should test in a private team, not MOJD&T |
| INCIDENT_BOT_ID | Yes | The ID of your test app |
| INCIDENT_BOT_NAME | Yes | The name of your test app |
| INCIDENT_CHANNEL_NAME | Yes | The channel to post new live incidents to |
| INCIDENT_REPORT_CHANNEL_NAME | Yes | The channel to post new incident reports to |
| PAGERDUTY_API_KEY | Only if testing PagerDuty | Provided by Pagerduty |
| PAGERDUTY_EMAIL | Only if testing PagerDuty | Provided by Pagerduty |
| PAGERDUTY_SERVICE | Only if testing PagerDuty | Provided by Pagerduty |
https://docs.djangoproject.com/en/3.1/ref/django-admin/#createsuperuser
https://slack.com/get-started#/create
https://github.com/monzo/response/blob/master/docs/slack_app_create.md
https://github.com/monzo/response/blob/master/docs/slack_app_config.md