diff doc/libervia-cli/file_share_affiliations.rst @ 3488:c80a0f864b5d

doc: updated doc following global renaming
author Goffi <goffi@goffi.org>
date Sun, 21 Mar 2021 18:23:58 +0100
parents doc/jp/file_share_affiliations.rst@7ebda4b54170
children 267e4987b58b
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libervia-cli/file_share_affiliations.rst	Sun Mar 21 18:23:58 2021 +0100
@@ -0,0 +1,56 @@
+.. _libervia-cli_file_share_affiliations:
+
+=============================================================
+file/share/affiliations: file sharing affiliations management
+=============================================================
+
+``affiliations`` let you manage access permission to your shared files repository, in a
+way similar as for pubsub.
+
+Affiliations with file sharing are not standard and will only work with the SàT file
+sharing component.
+
+Affiliations are similar to pubsub ones:
+
+``owner``
+  Has full permissions on the node, including changing affiliations. Owner can't be
+  changed at the moment.
+
+``publisher``
+  Can read, upload and delete files
+
+``member``
+  Can access file but can't modify them or add new ones
+
+``none``
+  Is not a member of this node, use it to remove an existing affiliation.
+
+
+get
+===
+
+Retrieve entities affiliated to this file sharing node, and their role
+
+example
+-------
+
+Get affiliations of a file sharing node::
+
+  $ li file share affiliations get -P "/some/path" louise@files.example.org
+
+set
+===
+
+Set affiliations of an entity to a file sharing node.
+
+examples
+--------
+
+Allow read access to a photo album to Louise::
+
+  $ li file share affiliations set -c files.example.net -P "/albums/holidays" -a louise@tazar2.int member
+
+Remove access to a directory from an old address of Pierre, and give it to the new one::
+
+  $ li file share affiliations set -c files.example.net -N "some_namespace" -P
+  "/interesting/directory" -a pierre@example.com none -a pierre@example.org member