Skip to main content
Version: 0.15.x

Server configuration

User registrationโ€‹

Registration is closed by default. While disabled an administrator needs to add new users manually (exp. woodpecker-cli user add).

If registration is open every user with an account at the configured SCM can login to Woodpecker. This example enables open registration for users that are members of approved organizations:

# docker-compose.yml
version: '3'

services:
woodpecker-server:
[...]
environment:
- [...]
+ - WOODPECKER_OPEN=true
+ - WOODPECKER_ORGS=dolores,dogpatch

Administratorsโ€‹

Administrators should also be enumerated in your configuration.

# docker-compose.yml
version: '3'

services:
woodpecker-server:
[...]
environment:
- [...]
+ - WOODPECKER_ADMIN=johnsmith,janedoe

Filtering repositoriesโ€‹

Woodpecker operates with the user's OAuth permission. Due to the coarse permission handling of GitHub, you may end up syncing more repos into Woodpecker than preferred.

Use the WOODPECKER_REPO_OWNERS variable to filter which GitHub user's repos should be synced only. You typically want to put here your company's GitHub name.

# docker-compose.yml
version: '3'

services:
woodpecker-server:
[...]
environment:
- [...]
+ - WOODPECKER_REPO_OWNERS=mycompany,mycompanyossgithubuser

Global registry settingโ€‹

If you want to make available a specific private registry to all pipelines, use the WOODPECKER_DOCKER_CONFIG server configuration. Point it to your server's docker config.

# docker-compose.yml
version: '3'

services:
woodpecker-server:
[...]
environment:
- [...]
+ - WOODPECKER_DOCKER_CONFIG=/home/user/.docker/config.json

All server configuration optionsโ€‹

The following list describes all available server configuration options.

WOODPECKER_LOG_LEVELโ€‹

Default: empty

Configures the logging level. Possible values are trace, debug, info, warn, error, fatal, panic, disabled and empty.

WOODPECKER_DEBUG_PRETTYโ€‹

Default: false

Enable pretty-printed debug output.

WOODPECKER_DEBUG_NOCOLORโ€‹

Default: true

Disable colored debug output.

WOODPECKER_HOSTโ€‹

Default: empty

Server fully qualified url of the user-facing hostname.

Example: WOODPECKER_HOST=http://woodpecker.example.org

WOODPECKER_SERVER_ADDRโ€‹

Default: :8000

Configures the HTTP listener port.

WOODPECKER_SERVER_CERTโ€‹

Default: empty

Path to an SSL certificate used by the server to accept HTTPS requests.

Example: WOODPECKER_SERVER_CERT=/path/to/cert.pem

WOODPECKER_SERVER_KEYโ€‹

Default: empty

Path to an SSL certificate key used by the server to accept HTTPS requests.

Example: WOODPECKER_SERVER_KEY=/path/to/key.pem

WOODPECKER_LETS_ENCRYPTโ€‹

Default: false

Automatically generates an SSL certificate using Let's Encrypt, and configures the server to accept HTTPS requests.

WOODPECKER_GRPC_ADDRโ€‹

Default: :9000

Configures the gRPC listener port.

WOODPECKER_ADMINโ€‹

Default: empty

Comma-separated list of admin accounts.

Example: WOODPECKER_ADMIN=user1,user2

WOODPECKER_ORGSโ€‹

Default: empty

Comma-separated list of approved organizations.

Example: org1,org2

WOODPECKER_REPO_OWNERSโ€‹

Default: empty

Comma-separated list of syncable repo owners. ???

Example: user1,user2

WOODPECKER_OPENโ€‹

Default: false

Enable to allow user registration.

WOODPECKER_DOCSโ€‹

Default: https://woodpecker-ci.org/

Link to documentation in the UI.

WOODPECKER_AUTHENTICATE_PUBLIC_REPOSโ€‹

Default: false

Always use authentication to clone repositories even if they are public. Needed if the SCM requires to always authenticate as used by many companies.

WOODPECKER_DEFAULT_CLONE_IMAGEโ€‹

Default: woodpeckerci/plugin-git:latest

The default docker image to be used when cloning the repo

WOODPECKER_SESSION_EXPIRESโ€‹

Default: 72h

Configures the session expiration time.

WOODPECKER_ESCALATEโ€‹

Default: plugins/docker,plugins/gcr,plugins/ecr,woodpeckerci/plugin-docker,woodpeckerci/plugin-docker-buildx

Docker images to run in privileged mode. Only change if you are sure what you do!

WOODPECKER_DOCKER_CONFIGโ€‹

Default: empty

Configures a specific private registry config for all pipelines.

Example: WOODPECKER_DOCKER_CONFIG=/home/user/.docker/config.json

WOODPECKER_AGENT_SECRETโ€‹

Default: empty

A shared secret used by server and agents to authenticate communication. A secret can be generated by openssl rand -hex 32.

WOODPECKER_KEEPALIVE_MIN_TIMEโ€‹

Default: empty

Server-side enforcement policy on the minimum amount of time a client should wait before sending a keepalive ping.

Example: WOODPECKER_KEEPALIVE_MIN_TIME=10s

WOODPECKER_DATABASE_DRIVERโ€‹

Default: sqlite3

The database driver name. Possible values are sqlite3, mysql or postgres.

WOODPECKER_DATABASE_DATASOURCEโ€‹

Default: woodpecker.sqlite

The database connection string. The default value is the path of the embedded sqlite database file.

Example:

# MySQL
# https://github.com/go-sql-driver/mysql#dsn-data-source-name
WOODPECKER_DATABASE_DATASOURCE=root:password@tcp(1.2.3.4:3306)/woodpecker?parseTime=true

# PostgreSQL
# https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING
WOODPECKER_DATABASE_DATASOURCE=postgres://root:password@1.2.3.4:5432/woodpecker?sslmode=disable

WOODPECKER_PROMETHEUS_AUTH_TOKENโ€‹

Default: empty

Token to secure the Prometheus metrics endpoint.

WOODPECKER_STATUS_CONTEXTโ€‹

Default: ci/woodpecker

Context prefix Woodpecker will use to publish status messages to SCM. You probably will only need to change it if you run multiple Woodpecker instances for a single repository.


WOODPECKER_LIMIT_MEM_SWAPโ€‹

Default: 0

The maximum amount of memory a single pipeline container is allowed to swap to disk, configured in bytes. There is no limit if 0.

WOODPECKER_LIMIT_MEMโ€‹

Default: 0

The maximum amount of memory a single pipeline container can use, configured in bytes. There is no limit if 0.

WOODPECKER_LIMIT_SHM_SIZEโ€‹

Default: 0

The maximum amount of memory of /dev/shm allowed in bytes. There is no limit if 0.

WOODPECKER_LIMIT_CPU_QUOTAโ€‹

Default: 0

The number of microseconds per CPU period that the container is limited to before throttled. There is no limit if 0.

WOODPECKER_LIMIT_CPU_SHARESโ€‹

Default: 0

The relative weight vs. other containers.

WOODPECKER_LIMIT_CPU_SETโ€‹

Default: empty

Comma-separated list to limit the specific CPUs or cores a pipeline container can use.

Example: WOODPECKER_LIMIT_CPU_SET=1,2


WOODPECKER_GITHUB_...โ€‹

See GitHub configuration

WOODPECKER_GOGS_...โ€‹

See Gogs configuration

WOODPECKER_GITEA_...โ€‹

See Gitea configuration

WOODPECKER_BITBUCKET_...โ€‹

See Bitbucket configuration

WOODPECKER_STASH_...โ€‹

See Bitbucket server configuration

WOODPECKER_GITLAB_...โ€‹

See Gitlab configuration

WOODPECKER_CODING_...โ€‹

See Coding configuration