From 35afd0a78e21857c17b8872b497a3c7351ca8005 Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Sat, 8 Dec 2012 20:53:24 +0100 Subject: [PATCH] Add github-oauth config documentation, fixes #1405 --- doc/04-schema.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/04-schema.md b/doc/04-schema.md index 7fbb9bb47..b777416ed 100644 --- a/doc/04-schema.md +++ b/doc/04-schema.md @@ -593,6 +593,10 @@ The following options are supported: * **github-protocols:** Defaults to `["git", "https", "http"]`. A list of protocols to use for github.com clones, in priority order. Use this if you are behind a proxy or have somehow bad performances with the git protocol. +* **github-oauth:** A list of domain names and oauth keys. For example using + `{"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. * **cache-dir:** Defaults to `$home/cache` on unix systems and `C:\Users\\AppData\Local\Composer` on Windows. Stores all the caches used by composer. See also [COMPOSER_HOME](03-cli.md#composer-home).