meissa/c4k-website
6
5
Fork 0
Code Issues Pull requests Projects Releases 8 Packages Wiki Activity

[Skip-CI] Further readme updates

Browse source
This commit is contained in:
erik 2022-11-10 13:13:55 +01:00
parent d48c9a576b
commit 6d0adc6a6a
1 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -7,18 +7,19 @@
Delivering cryogen generated static sites with the push of a few buttons.
c4k-website generates configuration files for nginx webservers, and
a cryogen static site generator build container. It automatically downloads a branch.zip from a specified
gitea API url. You need an authorization token to access the specified gitea user account.
The build container is based on clojure:lein.
c4k-website generates configuration files for multiple nginx webservers, and
corresponding cryogen static site generator build containers. This automatically downloads a branch.zip
from a specified gitea API url. You need an authorization token to access the specified gitea user
account. The build container is based on clojure:lein.
Following the example in valid-config.edn and valid-auth.edn you can add as many websites as you like (provided you have the DNS Routes set up).
One set of configmaps, deployment, services etc will be created for each element in the :websites and :auth list.
Following the example in valid-config.edn and valid-auth.edn you can add as many websites as you like (provided you have the DNS Routes set up). One set of configmaps, deployment, services etc will be created for each element in the :websites and :auth list.
c4k-website consists of the following parts:
* unique nginx webserver + service + ingress + certificate
* unique build container cron job and build secret
* unique volume claim for both
Configs generated by c4k-website consists of the following parts:
* nginx webserver + service + ingress + certificate definitions
* job definition that initially starts a build container
* cron job for building and build secret for storing auth data
* respective volume claim
## Try out
@ -50,4 +51,4 @@ Copyright © 2022 meissa GmbH
Licensed under the [Apache License, Version 2.0](LICENSE) (the "License")
Pls. find licenses of our subcomponents [here](doc/SUBCOMPONENT_LICENSE)
[provs]: https://gitlab.com/domaindrivenarchitecture/provs/-/commits/master
[provs]: https://gitlab.com/domaindrivenarchitecture/provs/