diff --git a/docs/docs/30-administration/10-server-config.md b/docs/docs/30-administration/10-server-config.md index 2085102ad..80663029b 100644 --- a/docs/docs/30-administration/10-server-config.md +++ b/docs/docs/30-administration/10-server-config.md @@ -174,12 +174,14 @@ Configures the session expiration time. Docker images to run in privileged mode. Only change if you are sure what you do! + ### `WOODPECKER_DOCKER_CONFIG` > Default: empty @@ -188,6 +190,7 @@ Configures a specific private registry config for all pipelines. Example: `WOODPECKER_DOCKER_CONFIG=/home/user/.docker/config.json` + ### `WOODPECKER_AGENT_SECRET` > Default: empty @@ -279,224 +283,30 @@ Example: `WOODPECKER_LIMIT_CPU_SET=1,2` --- -### `WOODPECKER_GITHUB` -> Default: `false` +### `WOODPECKER_GITHUB_...` -Enables the GitHub driver. +See [Github configuration](vcs/github/#configuration) -### `WOODPECKER_GITHUB_URL` -> Default: `https://github.com` +### `WOODPECKER_GOGS_...` -Configures the GitHub server address. +See [Gogs configuration](vcs/gogs/#configuration) -### `WOODPECKER_GITHUB_CLIENT` -> Default: empty +### `WOODPECKER_GITEA_...` -Configures the GitHub OAuth client id. This is used to authorize access. +See [Gitea configuration](vcs/gitea/#configuration) -### `WOODPECKER_GITHUB_SECRET` -> Default: empty +### `WOODPECKER_BITBUCKET_...` -Configures the GitHub OAuth client secret. This is used to authorize access. +See [Bitbucket configuration](vcs/bitbucket/#configuration) -### `WOODPECKER_GITHUB_MERGE_REF` -> Default: `true` +### `WOODPECKER_STASH_...` -TODO +See [Bitbucket server configuration](vcs/bitbucket_server/#configuration) -### `WOODPECKER_GITHUB_SKIP_VERIFY` -> Default: `false` +### `WOODPECKER_GITLAB_...` -Configure if SSL verification should be skipped. +See [Gitlab configuration](vcs/gitlab/#configuration) ---- +### `WOODPECKER_CODING_...` -### `WOODPECKER_GOGS` -> Default: `false` - -Enables the Gogs driver. - -### `WOODPECKER_GOGS_URL` -> Default: `https://github.com` - -Configures the Gogs server address. - -### `WOODPECKER_GOGS_GIT_USERNAME` -> Default: empty - -This username is used to authenticate and clone all private repositories. - -### `WOODPECKER_GOGS_GIT_PASSWORD` -> Default: empty - -The password is used to authenticate and clone all private repositories. - -### `WOODPECKER_GOGS_PRIVATE_MODE` -> Default: `false` - -TODO - -### `WOODPECKER_GOGS_SKIP_VERIFY` -> Default: `false` - -Configure if SSL verification should be skipped. - ---- - -### `WOODPECKER_GITEA` -> Default: `false` - -Enables the Gitea driver. - -### `WOODPECKER_GITEA_URL` -> Default: `https://try.gitea.io` - -Configures the Gitea server address. - -### `WOODPECKER_GITEA_CLIENT` -> Default: empty - -Configures the Gitea OAuth client id. This is used to authorize access. - -### `WOODPECKER_GITEA_SECRET` -> Default: empty - -Configures the Gitea OAuth client secret. This is used to authorize access. - -### `WOODPECKER_GITEA_SKIP_VERIFY` -> Default: `false` - -Configure if SSL verification should be skipped. - ---- - -### `WOODPECKER_BITBUCKET` -> Default: `false` - -Enables the Bitbucket driver. - -### `WOODPECKER_BITBUCKET_CLIENT` -> Default: empty - -Configures the Bitbucket OAuth client id. This is used to authorize access. - -### `WOODPECKER_BITBUCKET_SECRET` -> Default: empty - -Configures the Bitbucket OAuth client secret. This is used to authorize access. - ---- - -### `WOODPECKER_GITLAB` -> Default: `false` - -Enables the GitLab driver. - -### `WOODPECKER_GITLAB_URL` -> Default: `https://gitlab.com` - -Configures the GitLab server address. - -### `WOODPECKER_GITLAB_CLIENT` -> Default: empty - -Configures the GitLab OAuth client id. This is used to authorize access. - -### `WOODPECKER_GITLAB_SECRET` -> Default: empty - -Configures the GitLab OAuth client secret. This is used to authorize access. - -### `WOODPECKER_GITLAB_SKIP_VERIFY` -> Default: `false` - -Configure if SSL verification should be skipped. - ---- - -### `WOODPECKER_STASH` -> Default: `false` - -Enables the Bitbucket Server driver. - -### `WOODPECKER_STASH_URL` -> Default: empty - -Configures the Bitbucket Server address. - -### `WOODPECKER_STASH_CONSUMER_KEY` -> Default: empty - -Configures your Bitbucket Server consumer key. - -### `WOODPECKER_STASH_CONSUMER_RSA` -> Default: empty - -Configures the path to your Bitbucket Server private key file. - -### `WOODPECKER_STASH_CONSUMER_RSA_STRING` -> Default: empty - -Configures your Bitbucket Server private key. - -### `WOODPECKER_STASH_GIT_USERNAME` -> Default: empty - -This username is used to authenticate and clone all private repositories. - -### `WOODPECKER_STASH_GIT_PASSWORD` -> Default: empty - -The password is used to authenticate and clone all private repositories. - -### `WOODPECKER_STASH_SKIP_VERIFY` -> Default: `false` - -Configure if SSL verification should be skipped. - ---- - -### `WOODPECKER_CODING` -> Default: `false` - -Enables the Coding driver. - -### `WOODPECKER_CODING_URL` -> Default: `https://coding.net` - -Configures the Coding server address. - -### `WOODPECKER_CODING_CLIENT` -> Default: empty - -Configures the Coding OAuth client id. This is used to authorize access. - -### `WOODPECKER_CODING_SECRET` -> Default: empty - -Configures the Coding OAuth client secret. This is used to authorize access. - -### `WOODPECKER_CODING_SCOPE` -> Default: `user, project, project:depot` - -Comma-separated list of OAuth scopes. - -### `WOODPECKER_CODING_GIT_MACHINE` -> Default: `git.coding.net` - -TODO - -### `WOODPECKER_CODING_GIT_USERNAME` -> Default: empty - -This username is used to authenticate and clone all private repositories. - -### `WOODPECKER_CODING_GIT_PASSWORD` -> Default: empty - -The password is used to authenticate and clone all private repositories. - -### `WOODPECKER_CODING_SKIP_VERIFY` -> Default: `false` - -Configure if SSL verification should be skipped. +See [Coding configuration](vcs/coding/#configuration) diff --git a/docs/docs/30-administration/20-vcs/10-overview.md b/docs/docs/30-administration/11-vcs/10-overview.md similarity index 80% rename from docs/docs/30-administration/20-vcs/10-overview.md rename to docs/docs/30-administration/11-vcs/10-overview.md index 7ffd93a2c..a57aa43de 100644 --- a/docs/docs/30-administration/20-vcs/10-overview.md +++ b/docs/docs/30-administration/11-vcs/10-overview.md @@ -2,7 +2,7 @@ ## Supported features -| Feature | [GitHub](github/) | [Gitea](gitea/) | [Gitlab](gitlab/) | [Bitbucket](bitbucket/) | [Bitbucket Server](bitbucket_server/) | Gogs | Coding | +| Feature | [GitHub](github/) | [Gitea](gitea/) | [Gitlab](gitlab/) | [Bitbucket](bitbucket/) | [Bitbucket Server](bitbucket_server/) | [Gogs](gogs/) | [Coding](coding/) | | --- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | | Event: Push | :white_check_mark: | :white_check_mark: | :white_check_mark: | | Event: Tag | :white_check_mark: | :white_check_mark: | :white_check_mark: | @@ -10,6 +10,6 @@ | Event: Deploy | :white_check_mark: | :x: | :x: | | OAuth | :white_check_mark: | :white_check_mark: | :white_check_mark: | | [Multi pipeline](/docs/usage/multi-pipeline) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :x: | :x: | :x: | -| [when-path filter](/docs/usage/conditional-execution#path) | :white_check_mark: | :white_check_mark:¹ | :white_check_mark: | :x: | :x: | :x: | :x: | +| [when.path filter](/docs/usage/conditional-execution#path) | :white_check_mark: | :white_check_mark:¹ | :white_check_mark: | :x: | :x: | :x: | :x: | -¹(except for pull requests) +¹) [except for pull requests](https://github.com/woodpecker-ci/woodpecker/issues/754) diff --git a/docs/docs/30-administration/20-vcs/20-github.md b/docs/docs/30-administration/11-vcs/20-github.md similarity index 63% rename from docs/docs/30-administration/20-vcs/20-github.md rename to docs/docs/30-administration/11-vcs/20-github.md index e64f27254..6f8d41e2e 100644 --- a/docs/docs/30-administration/20-vcs/20-github.md +++ b/docs/docs/30-administration/11-vcs/20-github.md @@ -31,16 +31,32 @@ Please use this screenshot for reference: 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_GITHUB=true # Set to true to enable the GitHub driver +### `WOODPECKER_GITHUB` +> Default: `false` -WOODPECKER_GITHUB_URL=https://github.com # GitHub server address +Enables the GitHub driver. -WOODPECKER_GITHUB_CLIENT=... # GitHub oauth2 client id +### `WOODPECKER_GITHUB_URL` +> Default: `https://github.com` -WOODPECKER_GITHUB_SECRET=... # GitHub oauth2 client secret. +Configures the GitHub server address. -WOODPECKER_GITHUB_MERGE_REF=true # Set to true to use the `refs/pulls/%d/merge` vs `refs/pulls/%d/head` +### `WOODPECKER_GITHUB_CLIENT` +> Default: empty -WOODPECKER_GITHUB_SKIP_VERIFY=false # Set to true to disable SSL verification -``` +Configures the GitHub OAuth client id. This is used to authorize access. + +### `WOODPECKER_GITHUB_SECRET` +> Default: empty + +Configures the GitHub OAuth client secret. This is used to authorize access. + +### `WOODPECKER_GITHUB_MERGE_REF` +> Default: `true` + +TODO + +### `WOODPECKER_GITHUB_SKIP_VERIFY` +> Default: `false` + +Configure if SSL verification should be skipped. diff --git a/docs/docs/30-administration/20-vcs/30-gitea.md b/docs/docs/30-administration/11-vcs/30-gitea.md similarity index 74% rename from docs/docs/30-administration/20-vcs/30-gitea.md rename to docs/docs/30-administration/11-vcs/30-gitea.md index dd743411e..7c34b0994 100644 --- a/docs/docs/30-administration/20-vcs/30-gitea.md +++ b/docs/docs/30-administration/11-vcs/30-gitea.md @@ -39,14 +39,27 @@ For reference see [Configuration Cheat Sheet](https://docs.gitea.io/en-us/config 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_GITEA=true # Set to true to enable the Gitea driver +### `WOODPECKER_GITEA` +> Default: `false` -WOODPECKER_GITEA_URL=https://try.gitea.io # Gitea server address +Enables the Gitea driver. -WOODPECKER_GITEA_CLIENT=... # Gitea oauth2 client id +### `WOODPECKER_GITEA_URL` +> Default: `https://try.gitea.io` -WOODPECKER_GITEA_SECRET=... # Gitea oauth2 client secret +Configures the Gitea server address. -WOODPECKER_GITEA_SKIP_VERIFY=false # Set to true to disable SSL verification. -``` +### `WOODPECKER_GITEA_CLIENT` +> Default: empty + +Configures the Gitea OAuth client id. This is used to authorize access. + +### `WOODPECKER_GITEA_SECRET` +> Default: empty + +Configures the Gitea OAuth client secret. This is used to authorize access. + +### `WOODPECKER_GITEA_SKIP_VERIFY` +> Default: `false` + +Configure if SSL verification should be skipped. diff --git a/docs/docs/30-administration/20-vcs/40-gitlab.md b/docs/docs/30-administration/11-vcs/40-gitlab.md similarity index 72% rename from docs/docs/30-administration/20-vcs/40-gitlab.md rename to docs/docs/30-administration/11-vcs/40-gitlab.md index 4aee654c4..14a5d01cc 100644 --- a/docs/docs/30-administration/20-vcs/40-gitlab.md +++ b/docs/docs/30-administration/11-vcs/40-gitlab.md @@ -11,9 +11,9 @@ services: [...] environment: + - WOODPECKER_GITLAB=true ++ - WOODPECKER_GITLAB_URL=http://gitlab.mycompany.com + - WOODPECKER_GITLAB_CLIENT=95c0282573633eb25e82 + - WOODPECKER_GITLAB_SECRET=30f5064039e6b359e075 -+ - WOODPECKER_GITLAB_URL=http://gitlab.mycompany.com woodpecker-agent: [...] @@ -31,14 +31,27 @@ If you run the Woodpecker CI server on the same host as the GitLab instance, you 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_GITLAB=true # Set to true to enable the GitLab driver +### `WOODPECKER_GITLAB` +> Default: `false` -WOODPECKER_GITLAB_URL=https://gitlab.com # GitLab Server address +Enables the GitLab driver. -WOODPECKER_GITLAB_CLIENT=... # GitLab oauth2 client id +### `WOODPECKER_GITLAB_URL` +> Default: `https://gitlab.com` -WOODPECKER_GITLAB_SECRET=... # GitLab oauth2 client secret. +Configures the GitLab server address. -WOODPECKER_GITLAB_SKIP_VERIFY=false # Set to true to disable SSL verification -``` +### `WOODPECKER_GITLAB_CLIENT` +> Default: empty + +Configures the GitLab OAuth client id. This is used to authorize access. + +### `WOODPECKER_GITLAB_SECRET` +> Default: empty + +Configures the GitLab OAuth client secret. This is used to authorize access. + +### `WOODPECKER_GITLAB_SKIP_VERIFY` +> Default: `false` + +Configure if SSL verification should be skipped. diff --git a/docs/docs/30-administration/20-vcs/50-bitbucket.md b/docs/docs/30-administration/11-vcs/50-bitbucket.md similarity index 81% rename from docs/docs/30-administration/20-vcs/50-bitbucket.md rename to docs/docs/30-administration/11-vcs/50-bitbucket.md index be013b061..5065e2e31 100644 --- a/docs/docs/30-administration/20-vcs/50-bitbucket.md +++ b/docs/docs/30-administration/11-vcs/50-bitbucket.md @@ -43,13 +43,20 @@ Webhooks:Read and Write 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` +> Default: `false` -WOODPECKER_BITBUCKET_CLIENT=... # Bitbucket oauth2 client id +Enables the Bitbucket driver. -WOODPECKER_BITBUCKET_SECRET=... # Bitbucket oauth2 client secret -``` +### `WOODPECKER_BITBUCKET_CLIENT` +> Default: empty + +Configures the Bitbucket OAuth client id. This is used to authorize access. + +### `WOODPECKER_BITBUCKET_SECRET` +> Default: empty + +Configures the Bitbucket OAuth client secret. This is used to authorize access. ## Missing Features diff --git a/docs/docs/30-administration/20-vcs/60-bitbucket_server.md b/docs/docs/30-administration/11-vcs/60-bitbucket_server.md similarity index 80% rename from docs/docs/30-administration/20-vcs/60-bitbucket_server.md rename to docs/docs/30-administration/11-vcs/60-bitbucket_server.md index b1d7d0159..58b24307e 100644 --- a/docs/docs/30-administration/20-vcs/60-bitbucket_server.md +++ b/docs/docs/30-administration/11-vcs/60-bitbucket_server.md @@ -96,23 +96,46 @@ You must register your application with Bitbucket Server in order to generate a Please use http://woodpecker.mycompany.com/authorize as the Authorization callback URL. - ## 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_STASH=true # Set to true to enable the Bitbucket Server (Stash) driver +### `WOODPECKER_STASH` +> Default: `false` -WOODPECKER_STASH_URL # Bitbucket Server address. +Enables the Bitbucket Server driver. -WOODPECKER_STASH_CONSUMER_KEY=... # Bitbucket Server oauth1 consumer key +### `WOODPECKER_STASH_URL` +> Default: empty -WOODPECKER_STASH_CONSUMER_RSA=... # Bitbucket Server oauth1 private key file +Configures the Bitbucket Server address. -WOODPECKER_STASH_CONSUMER_RSA_STRING=... # Bibucket Server oauth1 private key as a string +### `WOODPECKER_STASH_CONSUMER_KEY` +> Default: empty -WOODPECKER_STASH_GIT_USERNAME=... # Machine account username used to clone repositories +Configures your Bitbucket Server consumer key. -WOODPECKER_STASH_GIT_PASSWORD=... # Machine account password used to clone repositories -``` +### `WOODPECKER_STASH_CONSUMER_RSA` +> Default: empty + +Configures the path to your Bitbucket Server private key file. + +### `WOODPECKER_STASH_CONSUMER_RSA_STRING` +> Default: empty + +Configures your Bitbucket Server private key. + +### `WOODPECKER_STASH_GIT_USERNAME` +> Default: empty + +This username is used to authenticate and clone all private repositories. + +### `WOODPECKER_STASH_GIT_PASSWORD` +> Default: empty + +The password is used to authenticate and clone all private repositories. + +### `WOODPECKER_STASH_SKIP_VERIFY` +> Default: `false` + +Configure if SSL verification should be skipped. diff --git a/docs/docs/30-administration/11-vcs/70-gogs.md b/docs/docs/30-administration/11-vcs/70-gogs.md new file mode 100644 index 000000000..a165bea6d --- /dev/null +++ b/docs/docs/30-administration/11-vcs/70-gogs.md @@ -0,0 +1,35 @@ +# Gogs + +## 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_GOGS` +> Default: `false` + +Enables the Gogs driver. + +### `WOODPECKER_GOGS_URL` +> Default: `https://github.com` + +Configures the Gogs server address. + +### `WOODPECKER_GOGS_GIT_USERNAME` +> Default: empty + +This username is used to authenticate and clone all private repositories. + +### `WOODPECKER_GOGS_GIT_PASSWORD` +> Default: empty + +The password is used to authenticate and clone all private repositories. + +### `WOODPECKER_GOGS_PRIVATE_MODE` +> Default: `false` + +TODO + +### `WOODPECKER_GOGS_SKIP_VERIFY` +> Default: `false` + +Configure if SSL verification should be skipped. diff --git a/docs/docs/30-administration/11-vcs/80-coding.md b/docs/docs/30-administration/11-vcs/80-coding.md new file mode 100644 index 000000000..751c09020 --- /dev/null +++ b/docs/docs/30-administration/11-vcs/80-coding.md @@ -0,0 +1,50 @@ +# Coding + +## 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_CODING` +> Default: `false` + +Enables the Coding driver. + +### `WOODPECKER_CODING_URL` +> Default: `https://coding.net` + +Configures the Coding server address. + +### `WOODPECKER_CODING_CLIENT` +> Default: empty + +Configures the Coding OAuth client id. This is used to authorize access. + +### `WOODPECKER_CODING_SECRET` +> Default: empty + +Configures the Coding OAuth client secret. This is used to authorize access. + +### `WOODPECKER_CODING_SCOPE` +> Default: `user, project, project:depot` + +Comma-separated list of OAuth scopes. + +### `WOODPECKER_CODING_GIT_MACHINE` +> Default: `git.coding.net` + +TODO + +### `WOODPECKER_CODING_GIT_USERNAME` +> Default: empty + +This username is used to authenticate and clone all private repositories. + +### `WOODPECKER_CODING_GIT_PASSWORD` +> Default: empty + +The password is used to authenticate and clone all private repositories. + +### `WOODPECKER_CODING_SKIP_VERIFY` +> Default: `false` + +Configure if SSL verification should be skipped. diff --git a/docs/docs/30-administration/20-vcs/_category_.yml b/docs/docs/30-administration/11-vcs/_category_.yml similarity index 100% rename from docs/docs/30-administration/20-vcs/_category_.yml rename to docs/docs/30-administration/11-vcs/_category_.yml diff --git a/docs/docs/30-administration/20-vcs/gitea_oauth.gif b/docs/docs/30-administration/11-vcs/gitea_oauth.gif similarity index 100% rename from docs/docs/30-administration/20-vcs/gitea_oauth.gif rename to docs/docs/30-administration/11-vcs/gitea_oauth.gif diff --git a/docs/docs/30-administration/20-vcs/github_oauth.png b/docs/docs/30-administration/11-vcs/github_oauth.png similarity index 100% rename from docs/docs/30-administration/20-vcs/github_oauth.png rename to docs/docs/30-administration/11-vcs/github_oauth.png diff --git a/docs/docs/30-administration/11-agent-config.md b/docs/docs/30-administration/15-agent-config.md similarity index 100% rename from docs/docs/30-administration/11-agent-config.md rename to docs/docs/30-administration/15-agent-config.md