meissa/c4k-taiga
6
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity

Update readme

Browse source
This commit is contained in:
erik 2023-10-19 11:16:07 +02:00
parent fd5197d7df
commit 6e3c522173
1 changed files with 31 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -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