From 95eb86696a413f4c4886f13818413f1ec99caf5b Mon Sep 17 00:00:00 2001 From: Tino de Bruijn Date: Sun, 23 Apr 2017 15:18:39 +0200 Subject: [PATCH 1/2] Make setup instructions more clear --- README.rst | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 64d8f74..891917f 100644 --- a/README.rst +++ b/README.rst @@ -13,13 +13,9 @@ Install Setup ----- -Create a new application under your organization in GitHub. Enter the **Authorization -callback URL** as the prefix to your Sentry installation: - -:: - - https://example.sentry.com - +Create a new application under your organization in GitHub. In the **Authorization +callback URL** field, enter the prefix to your Sentry installation, for example: +``https://sentry.yourdomain.com``. Once done, grab your API keys and drop them in your ``sentry.conf.py``: @@ -28,7 +24,7 @@ Once done, grab your API keys and drop them in your ``sentry.conf.py``: GITHUB_APP_ID = "" GITHUB_API_SECRET = "" - + Verified email addresses can optionally be required: From 7d62aecd0442fd45a047441a835895ea5325de3e Mon Sep 17 00:00:00 2001 From: Tino de Bruijn Date: Sun, 23 Apr 2017 15:21:55 +0200 Subject: [PATCH 2/2] Add statement about GITHUB_ORGANIZATION --- README.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.rst b/README.rst index 891917f..ad9eee5 100644 --- a/README.rst +++ b/README.rst @@ -33,6 +33,13 @@ Verified email addresses can optionally be required: GITHUB_REQUIRE_VERIFIED_EMAIL = True +If you want to limit access to users of a single GitHub organization, add: + +.. code-block:: python + + GITHUB_ORGANIZATION = 'myorg' + + Optionally you may also specify the domain (for GHE users): .. code-block:: python