Skip to content

Clearer readme docs for values.yaml #157

@circular-rodrigo

Description

@circular-rodrigo

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions