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

Merge pull request #6582 from jasonquick/patch-1 

Improve BitBucket driver usage documentation
pull/6578/merge
Jordi Boggiano 2017-08-07 11:17:58 +02:00 committed by GitHub
parent 8e20fffda5 5b6d954528
commit c2da4e0e0e
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/05-repositories.md
View File

@ -294,11 +294,14 @@ attempt to use github's zip files.
Please note: Please note:
* **To let Composer choose which driver to use** the repository type needs to be defined as "vcs" * **To let Composer choose which driver to use** the repository type needs to be defined as "vcs"
* **BitBucket driver** require the OAuth method to access to BitBucket REST APIs. * **If you already used a private repository**, this means Composer should have cloned it in cache. If you want to install the same package with drivers, remember to launch the command `composer clearcache` followed by the command `composer update` to update composer cache and install the package from dist.
If you want to know how to create a OAuth consumer using BitBucket, please refer to [this link](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html).
**Remember** to fill the callback url (even with a casual address) to makes OAuth 2 work. #### BitBucket Driver Configuration
After created an OAuth consumer, you need to setup your composer.json config section with
the requested credentials like this (more info [here](https://getcomposer.org/doc/06-config.md#bitbucket-oauth)): The BitBucket driver uses OAuth to access your private repositories via the BitBucket REST APIs and you will need to create an OAuth consumer to use the driver, please refer to [Atlassian's Documentation](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html). You will need to fill the callback url with something to satisfy BitBucket, but the address does not need to go anywhere and is not used by Composer.
After creating an OAuth consumer in the BitBucket control panel, you need to setup your auth.json file with
the credentials like this (more info [here](https://getcomposer.org/doc/06-config.md#bitbucket-oauth)):
```json ```json
{ {
"config": { "config": {
@ -312,7 +315,9 @@ the requested credentials like this (more info [here](https://getcomposer.org/do
} }
} }
``` ```
* **If you already used a private repository**, this means Composer should have cloned it in cache. If you want to install the same package with drivers, remember to launch the command `composer clearcache` followed by the command `composer update` to update composer cache and install the package from dist. **Note that the repository endpoint needs to be https rather than git.**
Alternatively if you prefer not to have your OAuth credentials on your filesystem you may export the ```bitbucket-oauth``` block above to the [COMPOSER_AUTH](https://getcomposer.org/doc/03-cli.md#composer-auth) environment variable instead.
#### Subversion Options #### Subversion Options