Конфигурация

  1. process-timeout
  2. use-include-path
  3. preferred-install
  4. store-auths
  5. github-protocols
  6. github-oauth
  7. gitlab-oauth
  8. gitlab-token
  9. disable-tls
  10. secure-http
  11. bitbucket-oauth
  12. cafile
  13. capath
  14. http-basic
  15. platform
  16. vendor-dir
  17. bin-dir
  18. data-dir
  19. cache-dir
  20. cache-files-dir
  21. cache-repo-dir
  22. cache-vcs-dir
  23. cache-files-ttl
  24. cache-files-maxsize
  25. bin-compat
  26. prepend-autoloader
  27. autoloader-suffix
  28. optimize-autoloader
  29. sort-packages
  30. classmap-authoritative
  31. apcu-autoloader
  32. github-domains
  33. github-expose-hostname
  34. gitlab-domains
  35. notify-on-install
  36. discard-changes
  37. archive-format
  38. archive-dir

В этой главе описывается раздел конфигурации схемы composer.json.

process-timeout #

По умолчанию 300. Процессы продолжительности, такие как git clones, могут выполняться до того, как Composer предполагает, что они вымерли. Возможно, вам придется сделать это выше, если у вас медленное соединение или огромные поставщики.

use-include-path #

По умолчанию false. Если true, автозагрузчик Composer будет также искать классы в PHP include path.

preferred-install #

По умолчанию используется auto и может быть любым из source, dist или auto. Эта опция позволяет вам установить метод установки, который предпочтет использовать Composer. Может быть опционально хэш шаблонов для более детальных настроек установки.

{
 "Config": {
 «Предпочтительная-установка»: {
 "My-organization / stable-package": "dist",
 «Моя-организация / *»: «источник»,
 «Partner-organization / *»: «auto»,
 "*": "Dist"
 }
 }
}
Примечание: порядок вопросов. Более конкретные шаблоны должны быть более ранними, чем более расслабленные шаблоны. При смешивании строковой нотации с конфигурацией хеша в глобальных и пакетных конфигурациях строковое представление преобразуется в шаблон * пакета.

store-auths #

Что делать после запроса на аутентификацию: одно из следующих: true (всегда хранить), false (не хранить) и "prompt" (спрашивать каждый раз), по умолчанию "prompt".

github-protocols #

По умолчанию используется значение ["https", "ssh", "git"]. Список протоколов, используемых при клонировании с github.com, в порядке приоритета. По умолчанию git присутствует, но только если secure-http отключен, поскольку протокол git не зашифрован. Если вы хотите, чтобы в ваших исходных URL-адресах удаленных страниц использовались https, а не ssh (git@github.com: ...), установите для списка протоколов только ["https"], а Composer прекратит переписывать push-URL Ssh URL.

github-oauth #

Список доменных имен и ключей oauth. Например, с помощью {"github.com": "oauthtoken"} в качестве значения этой опции будет использоваться oauthtoken для доступа к приватным репозиториям в github и для обхода ограничения на основе IP-адресов с низким IP. Подробнее о том, как получить токен OAuth для GitHub.

gitlab-oauth #

Список доменных имен и ключей oauth. Например, с помощью {"gitlab.com": "oauthtoken"} в качестве значения этой опции будет использоваться oauthtoken для доступа к приватным репозиториям в gitlab.

gitlab-token #

Список доменных имен и частных токенов. Например, используя {"gitlab.com": "privatetoken"}, значение этого параметра будет использовать privatetoken для доступа к приватным репозиториям на gitlab.

disable-tls #

По умолчанию false. Если установлено значение true, все URL-адреса HTTPS будут проверяться с использованием протокола HTTP, а шифрование на сетевом уровне не выполняется. Включение этого является риском безопасности и НЕ рекомендуется. Лучший способ - включить расширение php_openssl в php.ini.

secure-http #

По умолчанию используется значение true. Если установлено значение true, только URL-адреса HTTPS могут загружаться через Composer. Если вам действительно необходим HTTP-доступ к чему-либо, вы можете его отключить, но использование Let's Encrypt для получения бесплатного SSL-сертификата обычно является лучшей альтернативой.

bitbucket-oauth #

Список доменных имен и потребителей. Например, используя {"bitbucket.org": {"consumer-key": "myKey", "consumer-secret": "mySecret"}}. Узнайте, как настроить клиента на Bitbucket.

cafile #

Расположение файла центра сертификации в локальной файловой системе. В PHP 5.6+ вы должны установить это через файл openssl.cafile в php.ini, хотя PHP 5.6+ должен иметь возможность автоматически обнаруживать ваш CA файл.

capath #

Если cafile не указан или сертификат отсутствует там, в каталоге, на который указывает capath, выполняется поиск подходящего сертификата. Capath должен быть правильно хешированным каталогом сертификатов.

http-basic #

Список доменных имен и имени пользователя / паролей для их аутентификации. Например, используя {"example.org": {"username": "alice", "password": "foo"}}, поскольку значение этого параметра позволит автору Composer аутентифицироваться на example.org.

Примечание. Параметры конфигурации, связанные с аутентификацией, такие как http-basic и github-oauth, также могут быть указаны внутри файла auth.json, который идет помимо вашего composer.json. Таким образом вы можете gitignore, и каждый разработчик может разместить свои учетные данные там.

platform #

Позволяет создавать поддельные пакеты платформы (PHP и расширения), чтобы можно было эмулировать производственный env или определять вашу целевую платформу в конфигурации. Пример: {"php": "5.4", "ext-something": "4.0"}.

vendor-dir #

По умолчанию vendor. Вы можете установить зависимости в другой каталог, если хотите. $HOME и ~ будет заменен на путь вашего домашнего каталога в каталоге vendor-dir и все опции *-dir ниже.

bin-dir #

По умолчанию используется vendor/bin. Если проект включает в себя бинарные файлы, они будут символически привязаны к этому каталогу.

data-dir #

По умолчанию C:\Users\<пользователь>\AppData\Roaming\Composer в Windows, $XDG_DATA_HOME/composer в системах UNIX, которые соответствуют спецификациям базовой директории XDG, и $home в других Unix-системах. Прямо сейчас он используется только для хранения прошлых файлов composer.phar, чтобы иметь возможность отката к более старым версиям. См. также COMPOSER_HOME.

cache-dir #

По умолчанию C:\Users\<пользователь>\AppData\Local\Composer в Windows, $XDG_CACHE_HOME/composer в системах UNIX, которые следуют спецификациям базовых каталогов XDG, и $home/cache на других Unix-системах. Хранит все кеши, используемые Composer. См. также COMPOSER_HOME.

cache-files-dir #

По умолчанию используется $cache-dir/files. Хранит zip-архивы пакетов.

cache-repo-dir #

По умолчанию используется $cache-dir/repo. Хранит метаданные репозитория для типа composer и репозитории VCS типа svn, fossil, github и bitbucket.

cache-vcs-dir #

По умолчанию используется $cache-dir/vcs. Хранит клоны VCS для загрузки метаданных репозитория VCS для типов git/hg и для ускорения установки.

cache-files-ttl #

По умолчанию - 15552000 (6 месяцев). Composer кэширует все пакеты dist (zip, tar, ..), которые он загружает. Они очищаются после шести месяцев неиспользования по умолчанию. Эта опция позволяет вам настроить эту продолжительность (в секундах) или полностью отключить ее, установив ее в 0.

cache-files-maxsize #

По умолчанию 300MiB. Composer кэширует все пакеты dist (zip, tar, ..), которые он загружает. Когда сборка мусора периодически выполняется, это максимальный размер, который может использовать кеш. Старые (менее используемые) файлы будут удаляться первыми до тех пор, пока кэш не подойдет.

bin-compat #

По умолчанию используется auto. Определяет совместимость устанавливаемых двоичных файлов. Если это auto, Composer устанавливает только .bat прокси-файлы, когда в Windows. Если установлено значение full, для обоих двоичных файлов будут установлены оба .bat-файла для Windows и скрипты для операционных систем на основе Unix. Это особенно полезно, если вы запускаете Composer внутри виртуальной машины Linux, но все еще хотите, чтобы прокси-серверы .bat были доступны для использования в ОС Windows.

prepend-autoloader #

По умолчанию используется значение true. Если false, автозагрузчик Composer не будет добавлен к существующим автозагрузчикам. Это иногда требуется для устранения проблем взаимодействия с другими автозагрузчиками.

autoloader-suffix #

Значение по умолчанию: null. String для использования в качестве суффикса для сгенерированного автозагрузчика Composer. При нуле генерируется случайный.

optimize-autoloader #

По умолчанию false. Если true, всегда оптимизируйте при сбросе автозагрузчика.

sort-packages #

По умолчанию false. Если true, команда require сохраняет пакеты, отсортированные по имени, в composer.json при добавлении нового пакета.

classmap-authoritative #

По умолчанию false. Если true, автозагрузчик Composer будет загружать классы только из класса. Предполагает optimize-autoloader.

apcu-autoloader #

По умолчанию false. Если true, автозагрузчик Composer будет проверять APCu и использовать его для кэширования найденных / не найденных классов, когда расширение включено.

github-domains #

По умолчанию используется ["github.com"]. Список доменов для использования в режиме github. Это используется для настроек GitHub Enterprise.

github-expose-hostname #

По умолчанию используется значение true. Если false, маркеры OAuth, созданные для доступа к API github, будут иметь дату вместо машинного имени узла.

gitlab-domains #

По умолчанию используется ["gitlab.com"]. Список доменов серверов GitLab. Это используется, если вы используете тип репозитория gitlab.

notify-on-install #

По умолчанию используется значение true. Composer позволяет репозиториям определять URL-адрес уведомления, чтобы они получали уведомление каждый раз, когда установлен пакет из этого репозитория. Эта опция позволяет вам отключить это поведение.

discard-changes #

По умолчанию false и может быть любым из true, false или "stash". Этот параметр позволяет задать стиль обработки грязных обновлений по умолчанию в неинтерактивном режиме. true всегда будет отбрасывать изменения в поставщиках, в то время как "stash" будет пытаться спрятать и повторно применить. Используйте это для серверов CI или развертывайте скрипты, если вы склонны иметь модифицированных поставщиков.

archive-format #

По умолчанию используется tar. Composer позволяет вам добавить формат архива по умолчанию, когда рабочий процесс должен создать специальный формат архивирования.

archive-dir #

По умолчанию .. Composer позволяет добавить каталог архива по умолчанию, когда рабочий процесс должен создать специальный формат архивирования. Или для более легкой разработки между модулями.

Пример:

{
 "Config": {
 "Archive-dir": "/home/user/.composer/repo"
 }
}

← РепозиторииСообщество →