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

Process review comments

pull/9250/head
Frank Prins 2020-09-30 19:02:58 +02:00
parent 45d104ab83
commit 6a2f91a0e0
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/05-repositories.md
View File

@ -507,7 +507,7 @@ package repository definitions. It will fetch all the packages that are
`require`d and dump a `packages.json` that is your `composer` repository. `require`d and dump a `packages.json` that is your `composer` repository.
Check [the satis GitHub repository](https://github.com/composer/satis) and Check [the satis GitHub repository](https://github.com/composer/satis) and
the [Satis article](articles/handling-private-packages.md) for more the [handling private packages article](articles/handling-private-packages.md) for more
information. information.
### Artifact ### Artifact

24
doc/articles/authentication-for-private-packages.md
View File

@ -27,22 +27,22 @@ to retrieve one).
Sometimes automatic authentication is not possible, or you may want to predefine Sometimes automatic authentication is not possible, or you may want to predefine
authentication credentials. authentication credentials.
Credentials can be stored on 3 different places; in an auth.json for the project, a global Credentials can be stored on 3 different places; in an `auth.json` for the project, a global
auth.json or in the composer.json itself. `auth.json` or in the `composer.json` itself.
## Authentication in auth.json per project ## Authentication in auth.json per project
In this authentication storage method, an 'auth.json' file will be present in the same folder In this authentication storage method, an `auth.json` file will be present in the same folder
as the projects' composer.json file. You can either create and edit this file using the as the projects' `composer.json` file. You can either create and edit this file using the
command line or manually edit or create it. command line or manually edit or create it.
> **Note: Make sure the auth.json file is in the .gitignore** otherwise > **Note: Make sure the `auth.json` file is in the `.gitignore`** otherwise
> other people will be able to abuse your credentials. > other people will be able to abuse your credentials.
## Global authentication credentials ## Global authentication credentials
If you don't want to supply credentials for every project you work on, storing your credentials If you don't want to supply credentials for every project you work on, storing your credentials
globally might be a better idea. These credentials are stored in a global auth.json in your globally might be a better idea. These credentials are stored in a global `auth.json` in your
composer home directory. composer home directory.
### Command line global credential editing ### Command line global credential editing
@ -72,14 +72,14 @@ For specific authentication implementations, see their sections;
Manually editing this file instead of using the command line may result in invalid json errors. Manually editing this file instead of using the command line may result in invalid json errors.
To fix this you need to open the file in an editor and fix the error. To find the location of To fix this you need to open the file in an editor and fix the error. To find the location of
your global auth.json, execute: your global `auth.json`, execute:
```shell script ```shell script
composer config --global --list composer config --global --list
``` ```
And look for the `[home]` section. (It is by default `~/.composer` or `%APPDATA%/Composer` on Windows) And look for the `[home]` section. (It is by default `~/.composer` or `%APPDATA%/Composer` on Windows)
The folder will contain your global auth.json if it exists. The folder will contain your global `auth.json` if it exists.
You can open this file in your favorite editor and fix the error. You can open this file in your favorite editor and fix the error.
@ -90,7 +90,7 @@ You can open this file in your favorite editor and fix the error.
> a version control system like git or when an attacker gains (read) access to > a version control system like git or when an attacker gains (read) access to
> your production server files. > your production server files.
It is also possible to add credentials to a composer.json on a per-project basis in the 'config' It is also possible to add credentials to a `composer.json` on a per-project basis in the `config`
section or directly to the repository definition. section or directly to the repository definition.
# Authentication methods # Authentication methods
@ -123,7 +123,7 @@ composer config [--global] --editor --auth
## Inline http-basic ## Inline http-basic
For the inline http-basic authentication method the credentials are not stored in a separate For the inline http-basic authentication method the credentials are not stored in a separate
auth.json in the project or globally, but in the composer.json or global configuration `auth.json` in the project or globally, but in the `composer.json` or global configuration
in the same place where the composer repository definition is defined. in the same place where the composer repository definition is defined.
### Command line inline http-basic ### Command line inline http-basic
@ -178,7 +178,7 @@ composer config [--global] --editor
## gitlab-oauth ## gitlab-oauth
> **Note:** For the gitlab authentication to work on private gitlab instances, the > **Note:** For the gitlab authentication to work on private gitlab instances, the
> "gitlab-domains" section should also contain the url. > `gitlab-domains` section should also contain the url.
### Command line gitlab-oauth ### Command line gitlab-oauth
@ -203,7 +203,7 @@ composer config [--global] --editor --auth
## gitlab-token ## gitlab-token
> **Note:** For the gitlab authentication to work on private gitlab instances, the > **Note:** For the gitlab authentication to work on private gitlab instances, the
> "gitlab-domains" section should also contain the url. > `gitlab-domains` section should also contain the url.
### Command line gitlab-token ### Command line gitlab-token