Add readme

This commit is contained in:
Ryan Harg 2024-11-14 11:22:14 +01:00
parent f379976655
commit 3f8191e2d8

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# Woodpecker CI Deployment
This repository contains code to deploy and configure a Woodpecker CI instance using Docker Compose.
The provided compose file needs to be accompanied by a .env file in which specifics are configured.
Check the env.template file for reference and adjust to your needs.
Woodpeckers administration documentation is available here:
- https://woodpecker-ci.org/docs/administration/getting-started
You need to connect Woodpecker to a Forge (Github, GitLab, Forgejo, Gitea, Bitbucket, etc.):
- https://woodpecker-ci.org/docs/administration/forges/github
Woodpeckers general documentation is available here:
- https://woodpecker-ci.org/docs/intro