Skip to content

Commit 8179bed

Browse files
committed
Started to add config reference on RateLimiter
1 parent 064bb18 commit 8179bed

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

rate_limiter.rst

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Symfony uses these rate limiters in built-in features like "login throttling",
1616
which limits how many failed login attempts a user can make in a given period of
1717
time, but you can use them for your own features too.
1818

19+
.. _rate-limiter-policies:
20+
1921
Rate Limiting Policies
2022
----------------------
2123

reference/configuration/framework.rst

+32
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,13 @@ Configuration
211211

212212
* :ref:`enabled <reference-property-info-enabled>`
213213

214+
* `rate_limiter`_:
215+
216+
* :ref:`name <reference-rate-limiter-name>`
217+
218+
* `lock_factory`_
219+
* `policy`_
220+
214221
* `request`_:
215222

216223
* `formats`_
@@ -1220,6 +1227,31 @@ dsn
12201227

12211228
The DSN where to store the profiling information.
12221229

1230+
rate_limiter
1231+
~~~~~~~~~~~~
1232+
1233+
.. _reference-rate-limiter-name:
1234+
1235+
name
1236+
""""
1237+
1238+
**type**: ``prototype``
1239+
1240+
Name of the rate limiter you want to create.
1241+
1242+
lock_factory
1243+
""""""""""""
1244+
1245+
The service that is used to create a lock. The service has to implement the
1246+
:class:`Symfony\\Component\\Lock\\LockFactoryInterface`.
1247+
1248+
policy
1249+
""""""
1250+
1251+
The name of the rate limiting algorithm to use. Example names are ``fixed_window``,
1252+
``sliding_window`` and ``no_limit``. See :ref:`Rate Limiter Policies <rate-limiter-policies>`)
1253+
for more information.
1254+
12231255
request
12241256
~~~~~~~
12251257

0 commit comments

Comments
 (0)