Fix README.md
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/pr Build is passing
Details
This commit is contained in:
parent
3ea99647e2
commit
688a055c36
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.
|
||||
|
||||
```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`:
|
||||
|
||||
```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