composer支持通过COMPOSER_AUTH环境变量配置私有仓库认证,1. 支持http-basic、github-oauth等类型;2. 可在终端、docker、CI/CD中设置;3. 优先级高于auth.json;4. 需避免明文泄露,建议使用加密secrets管理。

Composer 支持通过 COMPOSER_AUTH 环境变量来配置认证信息,用于访问私有仓库、github、gitlab 或其他需要身份验证的 Composer 包源。这种方式避免了将敏感凭据写入 auth.json 文件或项目代码中,更适合在 CI/CD 环境或容器化部署中使用。
COMPOSER_AUTH 的基本结构
COMPOSER_AUTH 是一个 JSON 格式的环境变量,包含不同类型的认证方式,如 HTTP 基本身份验证、OAuth 令牌、Bearer Token 等。它支持以下几种认证类型:
- http-basic:用于私有 HTTP 仓库(如 Satis、private Packagist)的用户名和密码。
- github-oauth:用于 GitHub API 速率限制提升或访问私有仓库。
- gitlab-token:用于 GitLab 私有仓库的访问令牌。
- bitbucket-oauth:用于 Bitbucket 的 OAuth 凭据。
示例:
COMPOSER_AUTH='{"http-basic": {"example.com": {"username": "user", "password": "pass"}}, "github-oauth": {"github.com": "your-github-token"}}'
如何设置 COMPOSER_AUTH
你可以通过多种方式设置该环境变量,取决于你的运行环境:
- 本地终端测试:
export COMPOSER_AUTH='{"http-basic": {"repo.example.com": {"username": "admin", "password": "123456"}}}' - Docker 容器:
ENV COMPOSER_AUTH='{"github-oauth": {"github.com": "abc123..."}}' - CI/CD 配置(如 GitHub Actions):
jobs: deploy: env: COMPOSER_AUTH: '{ "github-oauth": { "github.com": "${{ secrets.COMPOSER_GITHUB_TOKEN }}" } }' steps: - run: composer install
优先级与安全性说明
Composer 在读取认证信息时遵循一定的优先级顺序:
- 环境变量 COMPOSER_AUTH 的优先级高于项目目录下的
auth.json和全局的auth.json(通常位于~/.composer/auth.json)。 - 这意味着你可以在不同环境中覆盖认证方式,而无需修改文件。
- 由于包含敏感信息,不要将明文 COMPOSER_AUTH 提交到版本控制系统中。建议使用 CI 平台的加密 secrets 功能管理令牌。
Composer 会自动解析该变量并在执行 composer install、update 等命令时使用其中的凭证进行身份验证。
基本上就这些。只要正确设置 JSON 格式并确保环境变量可用,Composer 就能顺利拉取受保护的依赖包。