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

Merge pull request #2599 from dlondero/document-oauth-token 

Add API rate limit and two factor authentication doc
pull/2614/head
Jordi Boggiano 2014-01-19 17:08:09 -08:00
parent b20021cc6a e776294616
commit 8e1d7de93b
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/04-schema.md
View File

@ -684,6 +684,8 @@ 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)
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.
* **bin-dir:** Defaults to `vendor/bin`. If a project includes binaries, they * **bin-dir:** Defaults to `vendor/bin`. If a project includes binaries, they

14
doc/articles/troubleshooting.md
View File

@ -104,3 +104,17 @@ Or, you can increase the limit with a command-line argument:
2. Search for an ```AutoRun``` key inside ```HKEY_LOCAL_MACHINE\Software\Microsoft\Command Processor``` 2. Search for an ```AutoRun``` key inside ```HKEY_LOCAL_MACHINE\Software\Microsoft\Command Processor```
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
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:
1. [Create](https://github.com/settings/applications) an oauthtoken on GitHub.
[Read more](https://github.com/blog/1509-personal-api-tokens) on this.
2. Add it to the configuration running `composer config -g github-oauth.github.com <oauthtoken>`
Now Composer should install/update without asking for authentication.