aboutsummaryrefslogtreecommitdiff
path: root/user/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'user/README.md')
-rw-r--r--user/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/user/README.md b/user/README.md
new file mode 100644
index 0000000..bede75a
--- /dev/null
+++ b/user/README.md
@@ -0,0 +1,19 @@
+# User Policies
+User policies apply to users and determine the read/write access they will have.
+This is useful to avoid needing to configure each bucket separately.
+
+## Policies
+The following policies are available:
+
+* useronly.json: Grants the user access to the bucket of their name.
+ For example, the user `foo` will be granted access to the bucket `foo` only.
+* userprefix.json: Grants the user access to buckets prefixed by their name.
+ For example, the user `foo` will be granted access to the buckets
+ `foo` and `foobar` but not `barfoo`.
+
+## Using
+Apply these policies as so:
+
+1. Download the file.
+2. `mcli admin policy add MYMINIO NAME NAME.json`
+3. `mcli admin policy set MYMINIO NAME user=USER`