From 688a055c369218558392df042f8ee6e16900e0f6 Mon Sep 17 00:00:00 2001 From: perf3ct Date: Wed, 11 Oct 2023 06:58:54 -0700 Subject: [PATCH] Fix README.md --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e22aaa8..fa7fe03 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,13 @@ This Helm Chart deploys both the Vikunja [frontend](https://hub.docker.com/r/vik ## Quickstart -The majority of default values defined in `values.yaml` should be compatible for your deployment. Additionally, if you utilize an Ingress for both the API and Frontend, you will be able to access the frontend out of the box. However, it won't have any default credentials, you will need to **either** enable registration, or execute `/bin/sh` on the API container and run the following command: +The majority of default values defined in `values.yaml` should be compatible for your deployment. Additionally, if you utilize an Ingress for both the API and Frontend, you will be able to access the frontend out of the box. However, it won't have any default credentials. So, you'll need to create an account using the registration button. -```bash -./vikunja user create --email --user --password -``` +That should be it! -If you do **not** wish to execute the above command in order to create a new user, you'll need to enable registration by appending +## Registration (creating users) + +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`: ```yaml api: @@ -26,10 +26,14 @@ api: data: config.yml: service: - enableregistration: true + enableregistration: false ``` -Once you've registered your user, feel free to disable registration if you don't wish for other users to register. +If you need to create another user, you could opt to execute the following command on the `api` container: + +```bash +./vikunja user create --email --user --password +``` ### Modifying Resources