diff doc/libervia-cli/file_share_configuration.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_configuration.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_configuration.rst	Sun Mar 21 18:23:58 2021 +0100
@@ -0,0 +1,38 @@
+.. _libervia-cli_file_share_configuration:
+
+=========================================================
+file/share/configuration: file sharing node configuration
+=========================================================
+
+``configuration`` commands are use to check or modify settings of a file sharing node.
+This is not standard and specific to SàT file sharing component.
+
+The configuration is similar as pubsub one.
+
+Only ``access_model`` can be used so far, with the ``open`` or ``whitelist`` values.
+
+
+get
+===
+
+Retrieve file sharing node configuration.
+
+example
+-------
+
+Get configuration of a file sharing node::
+
+  $ li file share configuration get -P "/some/path" louise@files.example.org
+
+set
+===
+
+Set configuration of a file sharing node.
+
+example
+-------
+
+Make a repository public::
+
+  $ li file share configuration set -c files.example.net -P "/public_files" -f
+  access_model open