mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-06-09 08:59:33 +00:00
Code Issues Projects Releases Wiki Activity
woodpecker/docs/docs/30-administration/11-forges/20-github.md

80 lines
2.1 KiB
Markdown
Raw Normal View History

[Docs] Migrate docs framework to Docusaurus (#282) - Replace mkdocs with docosaurus (improved menu structure, ...) - Structure docs into `Usage` and `Server Setup / Administration` - Update favicon - Create new pipeline-syntax page with all options and links to more detailed docs if available - Add ci to publish to `woodpecker-ci.github.io` - Deploy docs preview to surge for review - Update start-page Co-authored-by: 6543 <6543@obermui.de>
2021-09-11 15:10:32 +00:00
# GitHub
Administration articles moved
2019-11-13 18:50:54 +00:00
Update GH app installation instructions (#2472) - Slimify - Add required permissions (missing so far) - More detailed instructions on app settings - Align env var options to style used in k8s section (UL instead of headers) --------- Co-authored-by: Lauris BH <lauris@nix.lv>
2023-09-19 11:25:10 +00:00
Woodpecker comes with built-in support for GitHub and GitHub Enterprise.
To use Woodpecker with GitHub the following environment variables should be set for the server component:
Cleanups + prefer .yaml (#3069) Co-authored-by: Robert Kaussow <xoxys@rknet.org>
2024-01-11 17:43:54 +00:00
```ini
Update GH app installation instructions (#2472) - Slimify - Add required permissions (missing so far) - More detailed instructions on app settings - Align env var options to style used in k8s section (UL instead of headers) --------- Co-authored-by: Lauris BH <lauris@nix.lv>
2023-09-19 11:25:10 +00:00
WOODPECKER_GITHUB=true
WOODPECKER_GITHUB_CLIENT=YOUR_GITHUB_CLIENT_ID
WOODPECKER_GITHUB_SECRET=YOUR_GITHUB_CLIENT_SECRET
Readme
2019-07-05 13:30:25 +00:00
```
Update github auth install (#2499)
2023-09-25 22:03:37 +00:00
You will get these values from GitHub when you register your OAuth application.
To do so, go to Settings -> Developer Settings -> GitHub Apps -> New Oauth2 App.
:::warning
Do not use a "GitHub App" instead of an Oauth2 app as the former will not work correctly with Woodpecker right now (because user access tokens are not being refreshed automatically)
:::
Readme
2019-07-05 13:30:25 +00:00
Update GH app installation instructions (#2472) - Slimify - Add required permissions (missing so far) - More detailed instructions on app settings - Align env var options to style used in k8s section (UL instead of headers) --------- Co-authored-by: Lauris BH <lauris@nix.lv>
2023-09-19 11:25:10 +00:00
## App Settings
Readme
2019-07-05 13:30:25 +00:00
Update GH app installation instructions (#2472) - Slimify - Add required permissions (missing so far) - More detailed instructions on app settings - Align env var options to style used in k8s section (UL instead of headers) --------- Co-authored-by: Lauris BH <lauris@nix.lv>
2023-09-19 11:25:10 +00:00
- Name: An arbitrary name for your App
- Homepage URL: The URL of your Woodpecker instance
- Callback URL: `https://<your-woodpecker-instance>/authorize`
`pre-commit` fixes (#2669) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Anbraten <anton@ju60.de>
2023-10-31 08:14:09 +00:00
- (optional) Upload the Woodpecker Logo: <https://avatars.githubusercontent.com/u/84780935?s=200&v=4>
Readme
2019-07-05 13:30:25 +00:00
Update GH app installation instructions (#2472) - Slimify - Add required permissions (missing so far) - More detailed instructions on app settings - Align env var options to style used in k8s section (UL instead of headers) --------- Co-authored-by: Lauris BH <lauris@nix.lv>
2023-09-19 11:25:10 +00:00
## Client Secret Creation
Readme
2019-07-05 13:30:25 +00:00
Update GH app installation instructions (#2472) - Slimify - Add required permissions (missing so far) - More detailed instructions on app settings - Align env var options to style used in k8s section (UL instead of headers) --------- Co-authored-by: Lauris BH <lauris@nix.lv>
2023-09-19 11:25:10 +00:00
After your App has been created, you can generate a client secret.
Use this one for the `WOODPECKER_GITHUB_SECRET` environment variable.
Docs: Make Github docs same format as other forges (#2866) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-11-24 15:21:47 +00:00
## Configuration
Update GH app installation instructions (#2472) - Slimify - Add required permissions (missing so far) - More detailed instructions on app settings - Align env var options to style used in k8s section (UL instead of headers) --------- Co-authored-by: Lauris BH <lauris@nix.lv>
2023-09-19 11:25:10 +00:00
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.
Allow loading sensitive flags from files (#815) With systems like docker swarm or docker compose it is usually a little awkward to manage secrets. There is no way to directly inject them into the environment config. So you often have to write your secrets directly into the compose file There are hacky workarounds such as overriding the entry-point of the container and loading a script which then fetches secrets from /run/secrets and replaces the environment variables, but this becomes very difficult once we are using docker images built from "scratch" (which is a really great practice otherwise) as there is no shell or standard tooling available This adds a *_FILE variant of their Environment config values to work around this issue. Signed-off-by: Lukas Bachschwell <lukas@lbsfilm.at>
2022-03-01 15:09:33 +00:00
Docs: Make Github docs same format as other forges (#2866) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-11-24 15:21:47 +00:00
### `WOODPECKER_GITHUB`
Move vcs configs and hide some unstable options from docs (#755) move vcs configs to their pages, hide some unclear options
2022-02-09 19:32:38 +00:00
Docs: Make Github docs same format as other forges (#2866) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-11-24 15:21:47 +00:00
> Default: `false`
Move vcs configs and hide some unstable options from docs (#755) move vcs configs to their pages, hide some unclear options
2022-02-09 19:32:38 +00:00
Docs: Make Github docs same format as other forges (#2866) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-11-24 15:21:47 +00:00
Enables the GitHub driver.
Allow loading sensitive flags from files (#815) With systems like docker swarm or docker compose it is usually a little awkward to manage secrets. There is no way to directly inject them into the environment config. So you often have to write your secrets directly into the compose file There are hacky workarounds such as overriding the entry-point of the container and loading a script which then fetches secrets from /run/secrets and replaces the environment variables, but this becomes very difficult once we are using docker images built from "scratch" (which is a really great practice otherwise) as there is no shell or standard tooling available This adds a *_FILE variant of their Environment config values to work around this issue. Signed-off-by: Lukas Bachschwell <lukas@lbsfilm.at>
2022-03-01 15:09:33 +00:00
Docs: Make Github docs same format as other forges (#2866) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-11-24 15:21:47 +00:00
### `WOODPECKER_GITHUB_URL`
Allow loading sensitive flags from files (#815) With systems like docker swarm or docker compose it is usually a little awkward to manage secrets. There is no way to directly inject them into the environment config. So you often have to write your secrets directly into the compose file There are hacky workarounds such as overriding the entry-point of the container and loading a script which then fetches secrets from /run/secrets and replaces the environment variables, but this becomes very difficult once we are using docker images built from "scratch" (which is a really great practice otherwise) as there is no shell or standard tooling available This adds a *_FILE variant of their Environment config values to work around this issue. Signed-off-by: Lukas Bachschwell <lukas@lbsfilm.at>
2022-03-01 15:09:33 +00:00
Docs: Make Github docs same format as other forges (#2866) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-11-24 15:21:47 +00:00
> Default: `https://github.com`
Move vcs configs and hide some unstable options from docs (#755) move vcs configs to their pages, hide some unclear options
2022-02-09 19:32:38 +00:00
Docs: Make Github docs same format as other forges (#2866) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-11-24 15:21:47 +00:00
Configures the GitHub server address.
Move vcs configs and hide some unstable options from docs (#755) move vcs configs to their pages, hide some unclear options
2022-02-09 19:32:38 +00:00
Docs: Make Github docs same format as other forges (#2866) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-11-24 15:21:47 +00:00
### `WOODPECKER_GITHUB_CLIENT`
Move vcs configs and hide some unstable options from docs (#755) move vcs configs to their pages, hide some unclear options
2022-02-09 19:32:38 +00:00
Docs: Make Github docs same format as other forges (#2866) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-11-24 15:21:47 +00:00
> 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.
Reference in a new issue Copy permalink