woodpecker/docs/docs/30-administration/20-vcs/50-bitbucket.md
6543 d11b2bb8e5
Mention Matrix Space & Rooms in Readme & Docs (#646)
* Mention Matrix Space & Rooms in Readme & Docs

* custom labels

Co-authored-by: John Olheiser <john.olheiser@gmail.com>

Co-authored-by: John Olheiser <john.olheiser@gmail.com>
2021-12-30 11:53:52 -06:00

58 lines
1.7 KiB
Markdown

# Bitbucket
Woodpecker comes with built-in support for Bitbucket Cloud. To enable Bitbucket Cloud you should configure the Woodpecker container using the following environment variables:
```diff
# docker-compose.yml
version: '3'
services:
woodpecker-server:
[...]
environment:
- [...]
+ - WOODPECKER_BITBUCKET=true
+ - WOODPECKER_BITBUCKET_CLIENT=95c0282573633eb25e82
+ - WOODPECKER_BITBUCKET_SECRET=30f5064039e6b359e075
woodpecker-agent:
[...]
```
## Registration
You must register your application with Bitbucket in order to generate a client and secret. Navigate to your account settings and choose OAuth from the menu, and click Add Consumer.
Please use the Authorization callback URL:
```nohighlight
http://woodpecker.mycompany.com/authorize
```
Please also be sure to check the following permissions:
```nohighlight
Account:Email
Account:Read
Team Membership:Read
Repositories:Read
Webhooks:Read and Write
```
## Configuration
This is a full list of configuration options. Please note that many of these options use default configuration values that should work for the majority of installations.
```shell
WOODPECKER_BITBUCKET=true # Set to true to enable the Bitbucket driver
WOODPECKER_BITBUCKET_CLIENT=... # Bitbucket oauth2 client id
WOODPECKER_BITBUCKET_SECRET=... # Bitbucket oauth2 client secret
```
## Missing Features
Merge requests are not currently supported. We are interested in patches to include this functionality.
If you are interested in contributing to Woodpecker and submitting a patch please **contact us** via [Discord](https://discord.gg/fcMQqSMXJy) or [Matrix](https://matrix.to/#/#WoodpeckerCI-Develop:obermui.de).