Deployment
A Woodpecker deployment consists of two parts:
- A server which is the heart of Woodpecker and ships the web interface.
- Next to one server, you can deploy any number of agents which will run the pipelines.
Each agent is able to process one pipeline step by default. If you have four agents installed and connected to the Woodpecker server, your system will process four workflows in parallel.
You can add more agents to increase the number of parallel workflows or set the agent's WOODPECKER_MAX_WORKFLOWS=1 environment variable to increase the number of parallel workflows for that agent.
Which version of Woodpecker should I use?
Woodpecker is having two different kinds of releases: stable and next.
Find more information about the different versions here.
Hardware Requirements
Below are minimal resources requirements for Woodpecker components itself:
| Component | Memory | CPU |
|---|---|---|
| Server | 200 MB | 1 |
| Agent | 32 MB | 1 |
Note, that those values do not include the operating system or workload (pipelines execution) resources consumption.
In addition you need at least some kind of database which requires additional resources depending on the selected database system.
Installation
You can install Woodpecker on multiple ways:
- Using docker-compose with the official container images
- Using Kubernetes via the Woodpecker Helm chart
- Using binaries, DEBs or RPMs you can download from latest release
Authentication
Authentication is done using OAuth and is delegated to your forge which is configured using environment variables.
See the complete reference for all supported forges here.
Database
By default Woodpecker uses a SQLite database which requires zero installation or configuration. See the database settings page to further configure it or use MySQL or Postgres.
SSL
Woodpecker supports SSL configuration by using Let's encrypt or by using own certificates. See the SSL guide. You can also put it behind a reverse proxy
Metrics
A Prometheus endpoint is exposed.
Behind a proxy
See the proxy guide if you want to see a setup behind Apache, Nginx, Caddy or ngrok.
In the case you need to use Woodpecker with a URL path prefix (like: https://example.org/woodpecker/), add the root path to WOODPECKER_HOST.
Third-party installation methods
These installation methods are not officially supported. If you experience issues with them, please open issues in the specific repositories.