From 3332a1b2e82fd5b8e85a6c76e211a01ca98837b4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Greg=20Kar=C3=A9kinian?= <greg@karekinian.com>
Date: Tue, 26 May 2020 15:21:07 +0200
Subject: [PATCH] Write initial README

---
 site-cookbooks/kosmos_gitea/README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/site-cookbooks/kosmos_gitea/README.md b/site-cookbooks/kosmos_gitea/README.md
index c521348..09cb8bb 100644
--- a/site-cookbooks/kosmos_gitea/README.md
+++ b/site-cookbooks/kosmos_gitea/README.md
@@ -1,4 +1,18 @@
 # kosmos_gitea
 
-TODO: Enter the cookbook description here.
+## Recipes
 
+### default
+
+Deploys the gitea binary, generates a config file and our custom Kosmos label
+set. The service runs as a Systemd unit.
+
+### backup
+
+Back up the `/var/lib/gitea` directory using the
+[backup](https://backup.github.io/backup/) tool and our backup cookbook
+
+### pg_db
+
+Should be executed on the primary PostgreSQL server (`postgresql_primary` role)
+to create the user, database and access rules