Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use same format for Github docs as used for the other forges #2866

Merged
merged 6 commits into from
Nov 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/30-administration/10-server-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -570,7 +570,7 @@ Example: `WOODPECKER_LIMIT_CPU_SET=1,2`

### `WOODPECKER_CONFIG_SERVICE_ENDPOINT`

> Default: ``
> Default: empty

Specify a configuration service endpoint, see [Configuration Extension](./100-external-configuration-api.md)

Expand Down
48 changes: 39 additions & 9 deletions docs/docs/30-administration/11-forges/20-github.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,52 @@ Do not use a "GitHub App" instead of an Oauth2 app as the former will not work c
After your App has been created, you can generate a client secret.
Use this one for the `WOODPECKER_GITHUB_SECRET` environment variable.

## All GitHub Configuration Options
## 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.

- `WOODPECKER_GITHUB` - Enables the GitHub driver (Default: `false`)
### `WOODPECKER_GITHUB`

- `WOODPECKER_GITHUB_URL` - Configures the GitHub server address (Default: `https://github.com`)
> Default: `false`

- `WOODPECKER_GITHUB_CLIENT` - Configures the GitHub OAuth client id to authorize access (Default: empty)
Enables the GitHub driver.

- `WOODPECKER_GITHUB_CLIENT_FILE` - Read the value for `WOODPECKER_GITHUB_CLIENT` from the specified filepath (Default: empty)
### `WOODPECKER_GITHUB_URL`

- `WOODPECKER_GITHUB_SECRET` - Configures the GitHub OAuth client secret. This is used to authorize access. (Default: empty)
> Default: `https://github.com`

- `WOODPECKER_GITHUB_SECRET_FILE` - Read the value for `WOODPECKER_GITHUB_SECRET` from the specified filepath (Default: empty)
Configures the GitHub server address.

`WOODPECKER_GITHUB_MERGE_REF` - (Default: `true`)
### `WOODPECKER_GITHUB_CLIENT`

- `WOODPECKER_GITHUB_SKIP_VERIFY` - Configure if SSL verification should be skipped (Default: `false`)
> Default: empty

Configures the GitHub OAuth client id to authorize access.

### `WOODPECKER_GITHUB_CLIENT_FILE`

> Default: empty

Read the value for `WOODPECKER_GITHUB_CLIENT` from the specified filepath.

### `WOODPECKER_GITHUB_SECRET`

> Default: empty

Configures the GitHub OAuth client secret. This is used to authorize access.

### `WOODPECKER_GITHUB_SECRET_FILE`

> Default: empty

Read the value for `WOODPECKER_GITHUB_SECRET` from the specified filepath.

### `WOODPECKER_GITHUB_MERGE_REF`

> Default: `true`

### `WOODPECKER_GITHUB_SKIP_VERIFY`

> Default: `false`

Configure if SSL verification should be skipped.