From 3f8191e2d84ebe521c75d6ea365796b2564ad247 Mon Sep 17 00:00:00 2001 From: Ryan Harg Date: Thu, 14 Nov 2024 11:22:14 +0100 Subject: [PATCH] Add readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..33dd974 --- /dev/null +++ b/README.md @@ -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 +