Update documentation wrt different syntax for flags vs config options

This commit is contained in:
Elliott Friedman 2019-07-11 14:51:48 -07:00
parent a83c5eabb6
commit 2c9f87d769
2 changed files with 2 additions and 2 deletions

View File

@ -27,7 +27,7 @@ func main() {
googleGroups := StringArray{} googleGroups := StringArray{}
redisSentinelConnectionURLs := StringArray{} redisSentinelConnectionURLs := StringArray{}
config := flagSet.String("config", "", "path to config file") config := flagSet.String("config", "", "path to config file (Note when using config file, options are plural and s/-/_/: email-domain becomes email_domains and is a list)")
showVersion := flagSet.Bool("version", false, "print version string") showVersion := flagSet.Bool("version", false, "print version string")
flagSet.String("http-address", "127.0.0.1:4180", "[http://]<addr>:<port> or unix://<path> to listen on for HTTP clients") flagSet.String("http-address", "127.0.0.1:4180", "[http://]<addr>:<port> or unix://<path> to listen on for HTTP clients")

View File

@ -213,7 +213,7 @@ func (o *Options) Validate() error {
} }
if o.AuthenticatedEmailsFile == "" && len(o.EmailDomains) == 0 && o.HtpasswdFile == "" { if o.AuthenticatedEmailsFile == "" && len(o.EmailDomains) == 0 && o.HtpasswdFile == "" {
msgs = append(msgs, "missing setting for email validation: email-domain or authenticated-emails-file required."+ msgs = append(msgs, "missing setting for email validation: email-domain or authenticated-emails-file required."+
"\n use email-domain=* to authorize all email addresses") "\n use email-domain=* to authorize all email addresses. If using config file, this should be email_domains=[\"*\"].")
} }
if o.OIDCIssuerURL != "" { if o.OIDCIssuerURL != "" {