ldap-auth-proxy icon indicating copy to clipboard operation
ldap-auth-proxy copied to clipboard
verified publisher icon pinepain

Readme: Better documentation of the configuration options

Open neumantm opened this issue 4 years ago • 3 comments

I feel it would help, if the various environment variables which can be set to configure the tool, were better documented in the readme.

neumantm avatar Feb 23 '21 22:02 neumantm

I acutually found the config.go just now. Maybe just link to that from the README

neumantm avatar Feb 23 '21 22:02 neumantm

Hi @neumantm, thanks for finding time to raise this concern. Indeed, the docs supposed to be better.

Do you think the regular --help output (in advance to the configuration example with env variables) would be sufficient to give a hint on how to operate this tool for newcomers? Do you have some other suggestions?

pinepain avatar Mar 09 '21 10:03 pinepain

Yeah I suppose, that would already help a lot. Maybe, addtionally add a link to the config.go, because the README might get outdated.

neumantm avatar Mar 09 '21 11:03 neumantm