From f1af43068ce6e04f061d0593aaea8608d1432ae6 Mon Sep 17 00:00:00 2001 From: Chris Smith Date: Fri, 31 Jan 2014 16:33:13 +0000 Subject: [PATCH] Change docs to reflect support for GitHub 2FA --- doc/04-schema.md | 2 +- doc/articles/troubleshooting.md | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/04-schema.md b/doc/04-schema.md index 96641e8fe..635136e2b 100644 --- a/doc/04-schema.md +++ b/doc/04-schema.md @@ -684,7 +684,7 @@ The following options are supported: `{"github.com": "oauthtoken"}` as the value of this option will use `oauthtoken` to access private repositories on github and to circumvent the low IP-based rate limiting of their API. - [Read more](articles/troubleshooting.md#api-rate-limit-and-two-factor-authentication) + [Read more](articles/troubleshooting.md#api-rate-limit-and-oauth-tokens) on how to get an oauth token for GitHub. * **vendor-dir:** Defaults to `vendor`. You can install dependencies into a different directory if you want to. diff --git a/doc/articles/troubleshooting.md b/doc/articles/troubleshooting.md index 2fc7bb487..a0b4565b6 100644 --- a/doc/articles/troubleshooting.md +++ b/doc/articles/troubleshooting.md @@ -105,12 +105,13 @@ Or, you can increase the limit with a command-line argument: or ```HKEY_CURRENT_USER\Software\Microsoft\Command Processor```. 3. Check if it contains any path to non-existent file, if it's the case, just remove them. -## API rate limit and two factor authentication +## API rate limit and oauth tokens Because of GitHub's rate limits on their API it can happen that Composer prompts for authentication asking your username and password so it can go ahead with its work. -Unfortunately this will not work if you enabled two factor authentication on -your GitHub account and to solve this issue you need to: + +If you would rather than provide your GitHub credentials to Composer you can +manually create a token using the following procedure: 1. [Create](https://github.com/settings/applications) an oauth token on GitHub. [Read more](https://github.com/blog/1509-personal-api-tokens) on this.