Skip to content

Commit 658cc63

Browse files
committed
Added info on various types of GitHub auth.
1 parent 9a6ddb2 commit 658cc63

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,37 @@ file to get you started. Then simply replace the appropriate fields and the
5757
**repositories** sections for all the pull sources with the repository
5858
information for the repositories you want to watch for open pull requests.
5959

60+
### GitHub Authentication
61+
62+
#### Multi-Factor Authentication
63+
64+
Sadly, at the moment `pra` doesn't support GitHub's Multi-Factor
65+
Authentication. There is a ticket for this
66+
( [\#5](https://github.com/reachlocal/pra/issues/5) ).
67+
68+
#### OAuth
69+
70+
It is also lacking support for GitHub's OAuth mechanism. There is a ticket for
71+
this ( [\#6](https://github.com/reachlocal/pra/issues/6) ).
72+
73+
#### HTTP Basic Auth
74+
75+
The HTTP Basic Auth will work as long as you don't have multi-factor
76+
authentication enabled for your account.
77+
78+
#### Personal Access Token
79+
80+
Personal Access Token authentication is currently supported and this is the
81+
recommended authentication mechanism to use right now. It is the only
82+
authentication mechanism you can use at the moment if you have multi-factor
83+
authentication enabled.
84+
85+
Simply go to your GitHub **Account Settings**, select **Applications**, click
86+
the **Create new token** button in the **Personal Access Token** section. Give
87+
it the name "Pra" and submit. This will generate your personal access token.
88+
Then simply put your personal access token in the `~/.pra.json` as your GitHub
89+
username and "x-oauth-basic" as your GitHub password.
90+
6091
## Usage
6192

6293
Once you have configured `pra` as described above you can launch it by simply

0 commit comments

Comments
 (0)