diff --git a/README.rst b/README.rst index 64d8f74..ad9eee5 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: @@ -37,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