Skip to content

Commit

Permalink
docs(framework) Update node auth docs (#4160)
Browse files Browse the repository at this point in the history
Signed-off-by: Robert Steiner <[email protected]>
  • Loading branch information
Robert-Steiner authored and charlesbvll committed Sep 11, 2024
1 parent 36b9243 commit 6962610
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions doc/source/how-to-authenticate-supernodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ Use the following terminal command to start a Flower :code:`SuperNode` that has
.. code-block:: bash
flower-superlink
--ssl-ca-certfile certificates/ca.crt
--ssl-certfile certificates/server.pem
--ssl-ca-certfile certificates/ca.crt
--ssl-certfile certificates/server.pem
--ssl-keyfile certificates/server.key
--auth-list-public-keys keys/client_public_keys.csv
--auth-superlink-private-key keys/server_credentials
--auth-superlink-public-key keys/server_credentials.pub
Let's break down the authentication flags:

1. The first flag :code:`--auth-list-public-keys` expects a path to a CSV file storing all known node public keys. You need to store all known node public keys that are allowed to participate in a federation in one CSV file (:code:`.csv`).
Expand All @@ -56,8 +56,8 @@ Similar to the long-running Flower server (:code:`SuperLink`), you can easily en
Use the following terminal command to start an authenticated :code:`SuperNode`:

.. code-block:: bash
flower-client-app client:app
flower-supernode
--root-certificates certificates/ca.crt
--superlink 127.0.0.1:9092
--auth-supernode-private-key keys/client_credentials
Expand Down
10 changes: 5 additions & 5 deletions doc/source/how-to-enable-ssl-connections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Enable SSL connections
This guide describes how to a SSL-enabled secure Flower server (:code:`SuperLink`) can be started and
how a Flower client (:code:`SuperNode`) can establish a secure connections to it.

A complete code example demonstrating a secure connection can be found
A complete code example demonstrating a secure connection can be found
`here <https://github.com/adap/flower/tree/main/examples/advanced-tensorflow>`_.

The code example comes with a :code:`README.md` file which explains how to start it. Although it is
Expand Down Expand Up @@ -42,9 +42,9 @@ Use the following terminal command to start a sever (SuperLink) that uses the pr

.. code-block:: bash
flower-superlink
--ssl-ca-certfile certificates/ca.crt
--ssl-certfile certificates/server.pem
flower-superlink
--ssl-ca-certfile certificates/ca.crt
--ssl-certfile certificates/server.pem
--ssl-keyfile certificates/server.key
When providing certificates, the server expects a tuple of three certificates paths: CA certificate, server certificate and server private key.
Expand All @@ -57,7 +57,7 @@ Use the following terminal command to start a client (SuperNode) that uses the p

.. code-block:: bash
flower-client-app client:app
flower-supernode
--root-certificates certificates/ca.crt
--superlink 127.0.0.1:9092
Expand Down

0 comments on commit 6962610

Please sign in to comment.