search

pinepain / ldap-auth-proxy

A simple drop-in HTTP proxy for transparent LDAP authentication which is also a HTTP auth backend.
MIT License
75 stars 16 forks source link

Readme: Better documentation of the configuration options #21

Open neumantm opened 3 years ago

neumantm commented 3 years ago

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 commented 3 years ago

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

pinepain commented 3 years ago

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?

neumantm commented 3 years ago

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