Merge ~pelpsi/lp-signing:update-development-documentation into lp-signing:master

Proposed by Simone Pelosi
Status: Merged
Approved by: Simone Pelosi
Approved revision: ba8176e9f889baac5d16f64d1cf80482f3e299ad
Merge reported by: Otto Co-Pilot
Merged at revision: not available
Proposed branch: ~pelpsi/lp-signing:update-development-documentation
Merge into: lp-signing:master
Diff against target: 26 lines (+15/-0)
1 file modified
README.rst (+15/-0)
Reviewer Review Type Date Requested Status
Guruprasad Approve
Review via email: mp+461650@code.launchpad.net

Commit message

Add register-client command to the documentation

To post a comment you must log in.
Revision history for this message
Jürgen Gmach (jugmac00) :
Revision history for this message
Simone Pelosi (pelpsi) :
Revision history for this message
Guruprasad (lgp171188) wrote :

LGTM 👍 Please address my review comment, squash the commits into a single logical commit with an appropriate commit message before merging this.

review: Approve
Revision history for this message
Simone Pelosi (pelpsi) :

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/README.rst b/README.rst
2index 5fc6b9b..8b40442 100644
3--- a/README.rst
4+++ b/README.rst
5@@ -38,6 +38,21 @@ Generate another key pair, and add the private half to ``private_keys``
6
7 $ env/bin/lp-signing generate-key-pair
8
9+If you want to communicate with the ``lp-signing`` service via a client application,
10+you need a keypair for it. The keypair can be generated using
11+the ``env/bin/lp-signing generate-keypair`` command, which prints the public
12+and private keys of the generated keypair.
13+The public key from that output can be registered using the
14+``env/bin/lp-signing register-client <client-name> <client-public-key>`` command,
15+where ``<client-public-key>`` is a base64-encoded NaCl public key,
16+and the private key has to be used in the client application.
17+Please check the example client code below in this document for more details.
18+
19+.. note::
20+ In the case of the Launchpad development instance acting as a client,
21+ the keypair can be obtained from ``configs/development/launchpad-lazr.conf``
22+ in the Launchpad repository and the public key registered using this command.
23+
24 Start the server::
25
26 $ make run

Subscribers

People subscribed via source and target branches