Skip to content

Commit

Permalink
Fix configuration documentation for email duration limiter (#3365)
Browse files Browse the repository at this point in the history
* init commit for fix duration zero value

* text fix
  • Loading branch information
shimi9276 authored May 22, 2022
1 parent ee4f879 commit a95295d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ This reference uses `.` to denote the nesting of values.
+ `email.password` `(string)` - A string representing the password of the account. It's recommended to provide this value at runtime from a secret vault of some sort.
+ `email.local_name` `(string)` - A string representing the hostname sent to the SMTP server with the HELO command. By default, "localhost" is sent.
+ `email.sender` `(string)` - A string representing the email account which is set as the sender.
+ `email.limit_every_duration` `(duration : 1m)` - Average time to wait between sending emails. The zero value means no duration and therefore no emails can be sent.
+ `email.burst` `(int: 10)` - Maximal burst of emails before applying `limit_every`.
+ `email.limit_every_duration` `(duration : 1m)` - The average time between sending emails. If zero is entered, there is no limit to the amount of emails that can be sent.
+ `email.burst` `(int: 10)` - Maximal burst of emails before applying `limit_every_duration`. The zero value means no burst and therefore no emails can be sent.
+ `email.lakefs_base_url` `(string : "http://localhost:8000")` - A string representing the base lakefs endpoint to be directed to when emails are sent inviting users, reseting passwords etc.
* `gateways.s3.domain_name` `(string : "s3.local.lakefs.io")` - a FQDN
representing the S3 endpoint used by S3 clients to call this server
Expand Down

0 comments on commit a95295d

Please sign in to comment.