Mercurial > libervia-backend
diff doc/jp/file_share_affiliations.rst @ 3325:7ebda4b54170
jp (file/share): added commands to manage affiliations and configuration + documentation
author | Goffi <goffi@goffi.org> |
---|---|
date | Sat, 01 Aug 2020 16:25:50 +0200 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/jp/file_share_affiliations.rst Sat Aug 01 16:25:50 2020 +0200 @@ -0,0 +1,56 @@ +.. _jp-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:: + + $ jp 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:: + + $ jp 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:: + + $ jp file share affiliations set -c files.example.net -N "some_namespace" -P + "/interesting/directory" -a pierre@example.com none -a pierre@example.org member