Skip to content
This repository was archived by the owner on Aug 30, 2023. It is now read-only.

Update instruction in the README #17

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``:

Expand All @@ -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:

Expand All @@ -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
Expand Down