mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2025-01-09 17:15:31 +00:00
Improve bitbucket docs (#2066)
This commit is contained in:
parent
264f12fb54
commit
4731eeb5db
3 changed files with 16 additions and 11 deletions
|
@ -12,8 +12,8 @@ services:
|
||||||
environment:
|
environment:
|
||||||
- [...]
|
- [...]
|
||||||
+ - WOODPECKER_BITBUCKET=true
|
+ - WOODPECKER_BITBUCKET=true
|
||||||
+ - WOODPECKER_BITBUCKET_CLIENT=95c0282573633eb25e82
|
+ - WOODPECKER_BITBUCKET_CLIENT=... # called "Key" in Bitbucket
|
||||||
+ - WOODPECKER_BITBUCKET_SECRET=30f5064039e6b359e075
|
+ - WOODPECKER_BITBUCKET_SECRET=...
|
||||||
|
|
||||||
woodpecker-agent:
|
woodpecker-agent:
|
||||||
[...]
|
[...]
|
||||||
|
@ -21,24 +21,29 @@ services:
|
||||||
|
|
||||||
## Registration
|
## 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.
|
You must register an OAuth application at Bitbucket in order to get a key and secret combination for woodpecker. Navigate to your workspace settings and choose `OAuth consumers` from the menu, and finally click `Add Consumer` (the url should be like: `https://bitbucket.org/[your-project-name]/workspace/settings/api`).
|
||||||
|
|
||||||
Please use the Authorization callback URL:
|
Please set a name and set the `Callback URL` like this:
|
||||||
|
|
||||||
```nohighlight
|
```nohighlight
|
||||||
http://woodpecker.mycompany.com/authorize
|
https://<your-woodpecker-address>/authorize
|
||||||
```
|
```
|
||||||
|
|
||||||
|
![bitbucket oauth setup](bitbucket_oauth.png)
|
||||||
|
|
||||||
Please also be sure to check the following permissions:
|
Please also be sure to check the following permissions:
|
||||||
|
|
||||||
```nohighlight
|
```nohighlight
|
||||||
Account:Email
|
Account: Email, Read
|
||||||
Account:Read
|
Workspace membership: Read
|
||||||
Team Membership:Read
|
Projects: Read
|
||||||
Repositories:Read
|
Repositories: Read
|
||||||
Webhooks:Read and Write
|
Pull requests: Read
|
||||||
|
Webhooks: Read and Write
|
||||||
```
|
```
|
||||||
|
|
||||||
|
![bitbucket permissions](bitbucket_permissions.png)
|
||||||
|
|
||||||
## Configuration
|
## 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.
|
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.
|
||||||
|
@ -51,7 +56,7 @@ Enables the Bitbucket driver.
|
||||||
### `WOODPECKER_BITBUCKET_CLIENT`
|
### `WOODPECKER_BITBUCKET_CLIENT`
|
||||||
> Default: empty
|
> Default: empty
|
||||||
|
|
||||||
Configures the Bitbucket OAuth client id. This is used to authorize access.
|
Configures the Bitbucket OAuth client key. This is used to authorize access.
|
||||||
|
|
||||||
### `WOODPECKER_BITBUCKET_CLIENT_FILE`
|
### `WOODPECKER_BITBUCKET_CLIENT_FILE`
|
||||||
> Default: empty
|
> Default: empty
|
||||||
|
|
BIN
docs/docs/30-administration/11-forges/bitbucket_oauth.png
Normal file
BIN
docs/docs/30-administration/11-forges/bitbucket_oauth.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 29 KiB |
BIN
docs/docs/30-administration/11-forges/bitbucket_permissions.png
Normal file
BIN
docs/docs/30-administration/11-forges/bitbucket_permissions.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 20 KiB |
Loading…
Reference in a new issue