From 6e3c5221739a81ef40a310a57b7c02310535a738 Mon Sep 17 00:00:00 2001 From: erik Date: Thu, 19 Oct 2023 11:16:07 +0200 Subject: [PATCH] Update readme --- README.md | 35 +++++++++++++++++++++++++++++++---- 1 file changed, 31 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2465ab5..a4c7ec9 100644 --- a/README.md +++ b/README.md @@ -22,21 +22,48 @@ Your input will stay in your browser. No server interaction is required. ## Usage -You need: +To generate your configuration: + +1. Create an auth.yaml and a config.yaml + +You can find examples in src/test/resources/taiga-test in this repository. +Please check the ```def auth?``` and ```def config?``` definitions in src/main/cljc/dda/c4k_taiga/taiga.cljc +for required and optional values. + +2. install jarwrapper + +```bash +sudo apt install jarwrapper # on debian derivatives +``` + +3. execute the c4k-taiga-standalone.jar + +```bash +java -jar c4k-taiga-standalone.jar config.yaml auth.yaml +``` + +To set up you need: * A working DNS route to the FQDN of your taiga installation * A kubernetes cluster provisioned by [provs] -* The .yaml file generated by c4k-taiga +* The .yaml file generated by c4k-taiga-standalone.jar -Apply this file on your cluster with `kubectl apply -f yourApp.yaml`. +Apply this file on your cluster with `kubectl apply -f application.yaml`. Done. +## Administration + +You can access the administration of the taiga installation via: your.taiga.url/admin/ + ## Backup +You need some form of cloud storage like AWS buckets and the respective access credentials +to make the backups work correctly. + For a working backup you need to save Taiga DB & Taiga Media as described here: https://docs.taiga.io/backup-and-restore.html -For further instruction please refer to BackupAndRestore.md in doc/. +For further instruction please refer to BackupAndRestore.md in doc/ in this repository. ## Development & mirrors