Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clearer readme docs for values.yaml #157

Open
circular-rodrigo opened this issue Feb 21, 2025 · 0 comments
Open

Clearer readme docs for values.yaml #157

circular-rodrigo opened this issue Feb 21, 2025 · 0 comments

Comments

@circular-rodrigo
Copy link

I just wanted to leave some feedback to make the Readme docs clearer if some template examples of what the data for the values should look like could be added to the docs that would be great. I lost a couple of hours on the value for secret.htpasswd because it only says Htpasswd authentication and because this is helm and is used in k8s it wasn't very clear:

  • if I was supposed to/could pass a secret name with the htpasswd credentials inside it
  • if it was supposed to be a string containing the results of htpasswd -Bbn user password
  • if it was supposed to be a string with username and password in the dockerconfig format like user:passwd

Also upon researching this on the internet it became even more confusing since some people were saying htpasswd needed to be done by nginx or in my case traefik which sends you down yet another rabbit hole which also doesn't work.

So if the docs could be clarified to jsut iinclude soemthign simple like (on this case) secrets.htpasswd | Htpasswd command result or secrets.htpasswd | "<username>:<htpasswd encrypted password>" I think it would be helpful for other people as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant