Skip to content

Commit 9b6305b

Browse files
committed
Configuration: Document throttling settings
1 parent 41a771b commit 9b6305b

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

Configuration.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,22 @@ See the `brand` section of [settings.yml](https://github.com/pglombardo/Password
120120
| GA_ACCOUNT | The Google Analytics account id. E.g. `UA-XXXXXXXX-X` |
121121
| GA_DOMAIN | The domain where the application is hosted. E.g. `pwpush.com` |
122122

123-
# Logging
123+
# Throttling
124+
125+
Throttling enforces a minimum time interval
126+
between subsequent HTTP requests from a particular client, as
127+
well as by defining a maximum number of allowed HTTP requests
128+
per a given time period (per second, minute, hourly, or daily).
124129

130+
| Environment Variable | Description | Default Value |
131+
| --------- | ------------------ | --- |
132+
| PWP__THROTTLING__DAILY | The maximum number of allowed HTTP requests per day | `1000` |
133+
| PWP__THROTTLING__HOURLY | The maximum number of allowed HTTP requests per hour | `100` |
134+
| PWP__THROTTLING__MINUTE | The maximum number of allowed HTTP requests per minute | `30` |
135+
| PWP__THROTTLING__SECOND | The maximum number of allowed HTTP requests per second | `2` |
136+
137+
138+
# Logging
125139

126140
| Environment Variable | Description |
127141
| --------- | ------------------ |

config/settings.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ host_protocol: 'https'
156156
# Throttling enforces a minimum time interval
157157
# between subsequent HTTP requests from a particular client, as
158158
# well as by defining a maximum number of allowed HTTP requests
159-
# per a given time period (per minute, hourly, or daily).
159+
# per a given time period (per second, minute, hourly, or daily).
160160
#
161161
# See https://github.com/dryruby/rack-throttle#throttling-strategies
162162
# for a description of function.

0 commit comments

Comments
 (0)