Readd Removed Documentation #19

Merged
konrad merged 4 commits from xeruf/helm-chart:readme-new into main 2024-02-09 18:14:49 +00:00
Showing only changes of commit 450db45e43 - Show all commits

View File

@ -11,7 +11,7 @@ This Helm Chart deploys both the Vikunja [frontend](https://hub.docker.com/r/vik
## Quickstart
Define ingress settings according to your controller (for both API and Frontend) to access the application.
You can set all Vikunja API options as yaml under `api.configMaps.config.data`: https://vikunja.io/docs/config-options
You can set all Vikunja API options as yaml under `api.configMaps.config.data.config.yml`: https://vikunja.io/docs/config-options
For example, you can disable registration (if you do not with to allow others to register on your Vikunja), by providing the following values in your `values.yaml`:
konrad marked this conversation as resolved
Review

Didn't we already had this and removed it?

Didn't we already had this and removed it?
Review

I think we should keep both changes

I think we should keep both changes
Review

I just moved it up because specifying API config options is one of the first things you usually want to do, and made the text more understandable and compact.

I just moved it up because specifying API config options is one of the first things you usually want to do, and made the text more understandable and compact.
Review

Makes sense.

Makes sense.
@ -38,7 +38,7 @@ You can still create new users by executing the following command in the `api` c
To effectively run multiple replicas of the API,
make sure to set up the redis cache as well
by setting `api.configMaps.config.data.keyvalue.type` to `redis`,
by setting `api.configMaps.config.data.config.yml.keyvalue.type` to `redis`,
configuring the redis subchart (see [values.yaml](./values.yaml#L119))
and the connection to Vikunja:
https://vikunja.io/docs/config-options/#redis
xeruf marked this conversation as resolved
Review

Please do something like

and the connection [in Vikunja](https://vikunja.io/docs/config-options/#redis)
``
Please do something like ``` and the connection [in Vikunja](https://vikunja.io/docs/config-options/#redis) ``