Skip to content

Fix typos in installation instructions #35

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.

Sign up for GitHub

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

Open
PeraltaTK wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix typos in installation instructions #35

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7e2469
Fix typo in psycopg2 installation instructions
PeraltaTK Oct 20, 2025
d10cb0a
Fix typos in README.rst for default values
PeraltaTK Oct 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Depending of the backend storage you planning to use, you may need to install ad
* `mysqldb <https://pypi.org/project/mysqlclient/>`_
(``sudo apt-get install python3-mysqldb`` on debian like systems) for the mysql backend.
* `psycopg2 <https://pypi.python.org/pypi/psycopg2>`_
(``sudo apt-get install python3-psycopg2`` on debian like systems) fot the postgresql backend
(``sudo apt-get install python3-psycopg2`` on debian like systems) for the postgresql backend

Install with pip::

Expand Down Expand Up @@ -78,7 +78,7 @@ The ``.yaml`` are the new configuration format using the YAML syntax.
* ``user``: The user ``policyd-rate-limit`` will use to drop privileges.
The default is ``"policyd-rate-limit"``.
* ``group``: The group ``policyd-rate-limit`` will use to drop privileges.
The defaut is ``"policyd-rate-limit"``.
The default is ``"policyd-rate-limit"``.
* ``pidfile``: path where the program will try to write its pid to.
The default is ``"/var/run/policyd-rate-limit/policyd-rate-limit.pid"``.
``policyd-rate-limit`` will try to create the parent directory and chown it if it do not exists.
Expand All @@ -100,7 +100,7 @@ The ``.yaml`` are the new configuration format using the YAML syntax.
Ids are sasl usernames or ip addresses. The default is ``{}``.
* ``limit_by_sasl``: Apply limits by sasl usernames. The default is ``True``.
* ``limit_by_sender``: Apply limits by sender addresses if sasl username is not found.
The defaut is ``False``.
The default is ``False``.
* ``limit_by_ip``: Apply limits by ip addresses if sasl username and sender address are not found.
The default is ``False``.
* ``limited_networks``: A list of ip networks in cidr notation on which limits are applied. An empty
Expand Down