Mercurial > libervia-backend
diff doc/conf.py @ 3975:c4418949aa37
doc (encryption, cli): document Pubsub Targeted Encryption:
a small section has been added to `encryption` to explain the difference with OXPS, and
the `--encrypt-for` arguments are explained.
fix 382
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Mon, 31 Oct 2022 13:50:12 +0100 |
| parents | 9f85369294f3 |
| children | 3b72743b92db |
line wrap: on
line diff
--- a/doc/conf.py Mon Oct 31 13:48:31 2022 +0100 +++ b/doc/conf.py Mon Oct 31 13:50:12 2022 +0100 @@ -48,6 +48,11 @@ share secrets with :ref:`libervia-cli_pubsub_secret`. Please read :ref:`pubsub-encryption` for more details. +.. |pte_arg| replace:: + You can encrypt a single item to targeted entities with the ``--encrypt-for`` flag (not + to be confused with ``--encrypt`` which is used when a whole node is encrypted). Please + read :ref:`pubsub-encryption` for more details. + .. |sign_arg| replace:: To cryptographically sign an item, you can use the ``-X, --sign`` flag (a mnemonic way to remember the short option is to think of a cross made as a signature on a document).