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

*: add useful --help output #34

Open
mccutchen opened this issue Aug 24, 2018 · 1 comment
Open

*: add useful --help output #34

mccutchen opened this issue Aug 24, 2018 · 1 comment
Labels
good first issue Good for newcomers papercuts frustrations to fix but not necessarily a bug

Comments

@mccutchen
Copy link
Contributor

We should add a --help CLI flag to both sso-auth and sso-proxy that outputs documentation about configuration, for anyone exploring or debugging the apps at the command line.

At the moment, the --help flag is ignored and instead the user is greeted with a big error message about a bunch of invalid settings (see also #33):

$ docker run --rm buzzfeed/sso:latest sso-proxy --help
{"error":"Invalid configuration:\n  missing setting: cluster\n  missing setting: provider-url\n  missing setting: upstream-configs\n  missing setting: cookie-secret\n  missing setting: client-id\n  missing setting: client-secret\n  missing setting: email-domain\n  missing setting: statsd-host\n  missing setting: statsd-port","level":"error","msg":"error validing options","service":"sso-proxy","time":"2018-08-24 23:49:58.82411"}
@mccutchen mccutchen added good first issue Good for newcomers papercuts frustrations to fix but not necessarily a bug labels Aug 24, 2018
@mreiferson
Copy link
Contributor

Isn't --help a builtin feature of Go's CLI flag library? Are we not using that under-the-hood?

@mreiferson mreiferson changed the title Add useful --help output sso-{auth,proxy}: add useful --help output Nov 26, 2018
@mreiferson mreiferson changed the title sso-{auth,proxy}: add useful --help output *: add useful --help output Nov 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers papercuts frustrations to fix but not necessarily a bug
Projects
None yet
Development

No branches or pull requests

2 participants