Utilize bjw-s's common
Helm library.
#13
18
README.md
18
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.
|
||||
konrad marked this conversation as resolved
Outdated
|
||||
|
||||
```bash
|
||||
./vikunja user create --email <user@email.com> --user <user1> --password <password123>
|
||||
```
|
||||
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`:
|
||||
konrad
commented
I don't think this should belong here as it's not specific for the helm deployment. I don't think this should belong here as it's not specific for the helm deployment.
perfectra1n
commented
Understood - it was meant to be more of an example of how you can utilize the Understood - it was meant to be more of an example of how you can utilize the `values` of the Helm deployment to create the `config.yml` and make changes. Would it be adequate to perhaps rename the section to "Example of how to create `config.yml`" and move it to the bottom of the README.md?
perfectra1n
commented
Renamed the section, and bumped the "modification" examples to the bottom of the README.md in order to highlight how to use a pre-existing PVC. Let me know if you find that to be adequate! Renamed the section, and bumped the "modification" examples to the bottom of the README.md in order to highlight how to use a pre-existing PVC. Let me know if you find that to be adequate!
https://kolaente.dev/vikunja/helm-chart/commit/ce56e07518e9187f2f406a80c94dc8fddca53a87
konrad
commented
Renaming is great! Renaming is great!
|
||||
|
||||
```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@email.com> --user <user1> --password <password123>
|
||||
```
|
||||
|
||||
### Modifying Resources
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user
Registration is enabled by default, maybe change this to "you need to create an account before using it, there are no default credentials".
Not sure if we should even leave this in here as it is not specific for the helm deployment.
What do you think about this change?:
688a055c36
Looks good!