# Self-host Woodpecker CI

> A simple, container-native CI engine with a server and an agent, driven by pipelines in your repo.

- Page: https://levelrail.com/templates/woodpecker/
- JSON: https://levelrail.com/templates/woodpecker.json
- Category: Developer Tools
- Licence: Apache-2.0 (Permissive license)
- Source: https://github.com/woodpecker-ci/woodpecker
- Upstream docs: https://woodpecker-ci.org/docs

## Requirements
- Memory: about 512 MiB
- amd64: published, arm64: published
- Needs configuration before start: no
- Pinned image tag: v3.18.1

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| woodpecker-agent | woodpeckerci/woodpecker-agent | v3.18.1 | none | none |
| woodpecker-server | woodpeckerci/woodpecker-server | v3.18.1 | 8000 | woodpecker_data -> /var/lib/woodpecker |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| woodpecker-agent | WOODPECKER_AGENT_SECRET | generated |
| woodpecker-agent | WOODPECKER_SERVER | preset |
| woodpecker-server | WOODPECKER_ADMIN | preset |
| woodpecker-server | WOODPECKER_AGENT_SECRET | generated |
| woodpecker-server | WOODPECKER_GITEA | preset |
| woodpecker-server | WOODPECKER_GITEA_CLIENT | preset |
| woodpecker-server | WOODPECKER_GITEA_SECRET | preset |
| woodpecker-server | WOODPECKER_GITEA_URL | preset |
| woodpecker-server | WOODPECKER_HOST | preset |
| woodpecker-server | WOODPECKER_OPEN | preset |

## Deploy

### CLI

```bash
levelrail-cli templates deploy woodpecker --name my-woodpecker
```

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/woodpecker/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## Questions

### Can I deploy Woodpecker CI on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Woodpecker CI, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image woodpeckerci/woodpecker-agent:v3.18.1, woodpeckerci/woodpecker-server:v3.18.1 is what you deploy there.

Self-host Woodpecker CI, Woodpecker CI docker compose file, deploy Woodpecker CI on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
