public-mirrors
/
composer
mirror of https://github.com/composer/composer
1
0
Fork 0
Code

Change docs to reflect support for GitHub 2FA

pull/2577/head
Chris Smith 2014-01-31 16:33:13 +00:00
parent bcee7a04ee
commit f1af43068c
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/04-schema.md
View File

@ -684,7 +684,7 @@ The following options are supported:
`{"github.com": "oauthtoken"}` as the value of this option will use `oauthtoken` `{"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 to access private repositories on github and to circumvent the low IP-based
rate limiting of their API. 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. on how to get an oauth token for GitHub.
* **vendor-dir:** Defaults to `vendor`. You can install dependencies into a * **vendor-dir:** Defaults to `vendor`. You can install dependencies into a
different directory if you want to. different directory if you want to.

7
doc/articles/troubleshooting.md
View File

@ -105,12 +105,13 @@ Or, you can increase the limit with a command-line argument:
or ```HKEY_CURRENT_USER\Software\Microsoft\Command Processor```. 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. 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 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. 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. 1. [Create](https://github.com/settings/applications) an oauth token on GitHub.
[Read more](https://github.com/blog/1509-personal-api-tokens) on this. [Read more](https://github.com/blog/1509-personal-api-tokens) on this.