Skip to content
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

Fix typo in secure backend documentation #66

Merged
merged 2 commits into from
Jun 5, 2024
Merged

Fix typo in secure backend documentation #66

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e68dd1
Fix typo in secure backend documentation
mraspaud Jun 5, 2024
90ebc98
Fix another typo
mraspaud Jun 5, 2024
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
4 changes: 2 additions & 2 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ On the server side (for example a publisher), we need to define the server's sec
accepted client keys are provided::

POSTTROLL_SERVER_SECRET_KEY_FILE=/path/to/server.key_secret
POSTTROLL_PUBLIC_SECRET_KEYS_DIRECTORY=/path/to/client_public_keys/
POSTTROLL_CLIENTS_PUBLIC_KEYS_DIRECTORY=/path/to/client_public_keys/

On the client side (for example a subscriber), we need to define the server's public key file and the client's secret
key file::
Expand All @@ -173,7 +173,7 @@ key file::
These settings can also be set using the posttroll config object, for example::

>>> from posttroll import config
>>> with config.set(backend="secure_zmq", server_pubic_key_file="..."):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙈

>>> with config.set(backend="secure_zmq", server_public_key_file="..."):
...

The posttroll configuration uses donfig, for more information, check https://donfig.readthedocs.io/en/latest/.
Expand Down