From 0826d867864a679a1ae51322d7eb0e355d7d5c90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20T=C3=B6lle?= Date: Sat, 21 Nov 2020 15:37:56 +0100 Subject: [PATCH] docs: add sentry config to readme --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 2b9cd21..270db85 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,13 @@ All configuration must be set as environment variables. Default values are added - `DB_PASSWORD`: _Required_, Database password - `DB_DATABASE`: _Required_, Database database +#### Sentry + +You can use Sentry to automatically detect and report any exceptions thrown. + +- `SENTRY_ENABLED`: **false**, Set to `true` to enable Sentry. +- `SENTRY_DSN`: _Required_, but only if `SENTRY_ENABLED` is `true`. The [DSN](https://docs.sentry.io/product/sentry-basics/dsn-explainer/) for your Sentry project. + ## Development ### Configure Spotify API Access