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

Merge pull request #7853 from localheinz/fix/sort 

Fix: Keep environment variables sorted by name
pull/7857/head
Jordi Boggiano 2018-12-26 13:10:27 +01:00 committed by GitHub
parent ebde0bab7e 618122f897
commit 2b9fee4cd0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 78 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

156
doc/03-cli.md
View File

@ -796,58 +796,40 @@ COMPOSER=composer-other.json php composer.phar install
The generated lock file will use the same name: `composer-other.lock` in this example. The generated lock file will use the same name: `composer-other.lock` in this example.
### COMPOSER_ROOT_VERSION ### COMPOSER_ALLOW_SUPERUSER
By setting this var you can specify the version of the root package, if it can If set to 1, this env disables the warning about running commands as root/super user.
not be guessed from VCS info and is not present in `composer.json`. It also disables automatic clearing of sudo sessions, so you should really only set this
if you use Composer as super user at all times like in docker containers.
### COMPOSER_VENDOR_DIR ### COMPOSER_AUTH
By setting this var you can make Composer install the dependencies into a The `COMPOSER_AUTH` var allows you to set up authentication as an environment variable.
directory other than `vendor`. The contents of the variable should be a JSON formatted object containing http-basic,
github-oauth, bitbucket-oauth, ... objects as needed, and following the
[spec from the config](06-config.md#gitlab-oauth).
### COMPOSER_BIN_DIR ### COMPOSER_BIN_DIR
By setting this option you can change the `bin` ([Vendor Binaries](articles/vendor-binaries.md)) By setting this option you can change the `bin` ([Vendor Binaries](articles/vendor-binaries.md))
directory to something other than `vendor/bin`. directory to something other than `vendor/bin`.
### http_proxy or HTTP_PROXY ### COMPOSER_CACHE_DIR
If you are using Composer from behind an HTTP proxy, you can use the standard The `COMPOSER_CACHE_DIR` var allows you to change the Composer cache directory,
`http_proxy` or `HTTP_PROXY` env vars. Simply set it to the URL of your proxy. which is also configurable via the [`cache-dir`](06-config.md#cache-dir) option.
Many operating systems already set this variable for you.
Using `http_proxy` (lowercased) or even defining both might be preferable since By default it points to `$COMPOSER_HOME/cache` on \*nix and macOS, and
some tools like git or curl will only use the lower-cased `http_proxy` version. `C:\Users\<user>\AppData\Local\Composer` (or `%LOCALAPPDATA%/Composer`) on Windows.
Alternatively you can also define the git proxy using
`git config --global http.proxy <proxy url>`.
If you are using Composer in a non-CLI context (i.e. integration into a CMS or ### COMPOSER_CAFILE
similar use case), and need to support proxies, please provide the `CGI_HTTP_PROXY`
environment variable instead. See [httpoxy.org](https://httpoxy.org/) for further
details.
### no_proxy or NO_PROXY By setting this environmental value, you can set a path to a certificate bundle
file to be used during SSL/TLS peer verification.
If you are behind a proxy and would like to disable it for certain domains, you ### COMPOSER_DISCARD_CHANGES
can use the `no_proxy` or `NO_PROXY` env var. Simply set it to a comma separated list of
domains the proxy should *not* be used for.
The env var accepts domains, IP addresses, and IP address blocks in CIDR This env var controls the [`discard-changes`](06-config.md#discard-changes) config option.
notation. You can restrict the filter to a particular port (e.g. `:80`). You
can also set it to `*` to ignore the proxy for all HTTP requests.
### HTTP_PROXY_REQUEST_FULLURI
If you use a proxy but it does not support the request_fulluri flag, then you
should set this env var to `false` or `0` to prevent Composer from setting the
request_fulluri option.
### HTTPS_PROXY_REQUEST_FULLURI
If you use a proxy but it does not support the request_fulluri flag for HTTPS
requests, then you should set this env var to `false` or `0` to prevent Composer
from setting the request_fulluri option.
### COMPOSER_HOME ### COMPOSER_HOME
@ -873,45 +855,10 @@ This file allows you to set [repositories](05-repositories.md) and
In case global configuration matches _local_ configuration, the _local_ In case global configuration matches _local_ configuration, the _local_
configuration in the project's `composer.json` always wins. configuration in the project's `composer.json` always wins.
### COMPOSER_CACHE_DIR ### COMPOSER_HTACCESS_PROTECT
The `COMPOSER_CACHE_DIR` var allows you to change the Composer cache directory, Defaults to `1`. If set to `0`, Composer will not create `.htaccess` files in the
which is also configurable via the [`cache-dir`](06-config.md#cache-dir) option. composer home, cache, and data directories.
By default it points to `$COMPOSER_HOME/cache` on \*nix and macOS, and
`C:\Users\<user>\AppData\Local\Composer` (or `%LOCALAPPDATA%/Composer`) on Windows.
### COMPOSER_PROCESS_TIMEOUT
This env var controls the time Composer waits for commands (such as git
commands) to finish executing. The default value is 300 seconds (5 minutes).
### COMPOSER_CAFILE
By setting this environmental value, you can set a path to a certificate bundle
file to be used during SSL/TLS peer verification.
### COMPOSER_AUTH
The `COMPOSER_AUTH` var allows you to set up authentication as an environment variable.
The contents of the variable should be a JSON formatted object containing http-basic,
github-oauth, bitbucket-oauth, ... objects as needed, and following the
[spec from the config](06-config.md#gitlab-oauth).
### COMPOSER_DISCARD_CHANGES
This env var controls the [`discard-changes`](06-config.md#discard-changes) config option.
### COMPOSER_NO_INTERACTION
If set to 1, this env var will make Composer behave as if you passed the
`--no-interaction` flag to every command. This can be set on build boxes/CI.
### COMPOSER_ALLOW_SUPERUSER
If set to 1, this env disables the warning about running commands as root/super user.
It also disables automatic clearing of sudo sessions, so you should really only set this
if you use Composer as super user at all times like in docker containers.
### COMPOSER_MEMORY_LIMIT ### COMPOSER_MEMORY_LIMIT
@ -923,9 +870,62 @@ If set to 1, this env changes the default path repository strategy to `mirror` i
of `symlink`. As it is the default strategy being set it can still be overwritten by of `symlink`. As it is the default strategy being set it can still be overwritten by
repository options. repository options.
### COMPOSER_HTACCESS_PROTECT ### COMPOSER_NO_INTERACTION
Defaults to `1`. If set to `0`, Composer will not create `.htaccess` files in the If set to 1, this env var will make Composer behave as if you passed the
composer home, cache, and data directories. `--no-interaction` flag to every command. This can be set on build boxes/CI.
### COMPOSER_PROCESS_TIMEOUT
This env var controls the time Composer waits for commands (such as git
commands) to finish executing. The default value is 300 seconds (5 minutes).
### COMPOSER_ROOT_VERSION
By setting this var you can specify the version of the root package, if it can
not be guessed from VCS info and is not present in `composer.json`.
### COMPOSER_VENDOR_DIR
By setting this var you can make Composer install the dependencies into a
directory other than `vendor`.
### http_proxy or HTTP_PROXY
If you are using Composer from behind an HTTP proxy, you can use the standard
`http_proxy` or `HTTP_PROXY` env vars. Simply set it to the URL of your proxy.
Many operating systems already set this variable for you.
Using `http_proxy` (lowercased) or even defining both might be preferable since
some tools like git or curl will only use the lower-cased `http_proxy` version.
Alternatively you can also define the git proxy using
`git config --global http.proxy <proxy url>`.
If you are using Composer in a non-CLI context (i.e. integration into a CMS or
similar use case), and need to support proxies, please provide the `CGI_HTTP_PROXY`
environment variable instead. See [httpoxy.org](https://httpoxy.org/) for further
details.
### HTTP_PROXY_REQUEST_FULLURI
If you use a proxy but it does not support the request_fulluri flag, then you
should set this env var to `false` or `0` to prevent Composer from setting the
request_fulluri option.
### HTTPS_PROXY_REQUEST_FULLURI
If you use a proxy but it does not support the request_fulluri flag for HTTPS
requests, then you should set this env var to `false` or `0` to prevent Composer
from setting the request_fulluri option.
### no_proxy or NO_PROXY
If you are behind a proxy and would like to disable it for certain domains, you
can use the `no_proxy` or `NO_PROXY` env var. Simply set it to a comma separated list of
domains the proxy should *not* be used for.
The env var accepts domains, IP addresses, and IP address blocks in CIDR
notation. You can restrict the filter to a particular port (e.g. `:80`). You
can also set it to `*` to ignore the proxy for all HTTP requests.
&larr; [Libraries](02-libraries.md) | [Schema](04-schema.md) &rarr; &larr; [Libraries](02-libraries.md) | [Schema](04-schema.md) &rarr;