Skip to content

Commit 51e8a9b

Browse files
Ned Batcheldernedbat
authored andcommitted
docs: remove OAuth references in docs/install.rst
1 parent 205d68a commit 51e8a9b

File tree

1 file changed

+19
-31
lines changed

1 file changed

+19
-31
lines changed

docs/install.rst

Lines changed: 19 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -44,31 +44,25 @@ Generate a secret key for Flask, so that it can save information into the sessio
4444
$ export FLASK_SECRET_KEY=`python -c "import os; print(os.urandom(24))"`
4545
$ heroku config:set FLASK_SECRET_KEY=$FLASK_SECRET_KEY
4646
47-
Setup OAuth
48-
-----------
47+
48+
Set Up Authentication Tokens
49+
----------------------------
4950

5051
Jira
5152
~~~~
5253

5354
OAuth authentication for Jira requires a RSA keypair. To set this up:
5455

55-
1. Run ``openssl genrsa -out jira.pem``. This will generate a private key.
56-
2. Run ``openssl rsa -in jira.pem -pubout -out jira.pub``. This will generate the
57-
public key.
58-
3. Generate a random string to serve as the consumer key. For example, run
59-
``python -c "import uuid; print(uuid.uuid4().hex)" > jira.uuid``.
60-
4. Configure an Application Link in Jira. The consumer key is the contents
61-
of ``jira.uuid``, and the public key is the contents of ``jira.pub``.
62-
5. Set RSA key and consumer key in Heroku environment:
56+
#. Get a Jira access token. TODO: Explain how to do this.
57+
58+
#. Specify the Jira user email and token:
6359

6460
.. code-block:: bash
6561
66-
$ export JIRA_OAUTH_RSA_KEY="$(<jira.pem)"
67-
$ export JIRA_OAUTH_CONSUMER_KEY="$(<jira.uuid)"
68-
$ heroku config:set JIRA_OAUTH_RSA_KEY=$JIRA_OAUTH_RSA_KEY
69-
$ heroku config:set JIRA_OAUTH_CONSUMER_KEY=$JIRA_OAUTH_CONSUMER_KEY
62+
$ heroku config:set [email protected]
63+
$ heroku config:set JIRA_USER_TOKEN=94LW................51FC
7064
71-
6. Specify the JIRA server to use:
65+
#. Specify the Jira server to use:
7266

7367
.. code-block:: bash
7468
@@ -77,24 +71,15 @@ OAuth authentication for Jira requires a RSA keypair. To set this up:
7771
GitHub
7872
~~~~~~
7973

80-
1. `Register a new application on GitHub <https://github.com/settings/applications/new>`_.
81-
82-
2. The new application will give you a consumer key and consumer secret. Set
83-
these values in the Heroku environment:
84-
85-
.. code-block:: bash
86-
87-
$ heroku config:set GITHUB_OAUTH_CLIENT_ID=my-id GITHUB_OAUTH_CLIENT_SECRET=my-secret
88-
89-
3. Create a GitHub personal access token for the bot user. It will need these
74+
#. Create a GitHub personal access token for the bot user. It will need these
9075
scopes: admin:repo_hook, repo, user:email, workflow, write:org. Specify it
9176
as a Heroku setting:
9277

9378
.. code-block:: bash
9479
9580
$ heroku config:set GITHUB_PERSONAL_TOKEN=my-pat
9681
97-
4. A GitHub project will be needed for blended pull requests, and another for
82+
#. A GitHub project will be needed for blended pull requests, and another for
9883
other OSPRs. Specify them as ``org:number``:
9984

10085
.. code-block:: bash
@@ -103,14 +88,17 @@ GitHub
10388
$ heroku config:set GITHUB_BLENDED_PROJECT=edx:9
10489
10590
106-
10791
Deploy
10892
------
10993

110-
1. Set up your Heroku git remote to point to your Heroku application
111-
1. ``git push heroku``
112-
1. Visit your website -- it should load!
113-
1. Enjoy the sweet, sweet taste of API integration
94+
#. Set up your Heroku git remote to point to your Heroku application
95+
96+
#. ``git push heroku``
97+
98+
#. Visit your website -- it should load!
99+
100+
#. Enjoy the sweet, sweet taste of API integration
101+
114102

115103
Recurring Tasks
116104
---------------

0 commit comments

Comments
 (0)