Skip to content

Commit aa58fc8

Browse files
committed
add new feature documentation
Signed-off-by: Marcelo H. Bartsch <marcelo@bartsch.cl>
1 parent 2a8d34f commit aa58fc8

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

  • admin_manual/configuration_files/external_storage

admin_manual/configuration_files/external_storage/amazons3.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,21 @@ In the **Authentication** field select **Access key**.
2020

2121
In the **Bucket** field enter your *S3 bucket name*. [Note: Even if non-Amazon hosted, bucket names must meet AWS S3 naming requirements regardless of what your S3 provider/platform considers acceptable - i.e. no underscores]
2222

23+
The optional **Object key prefix** field scopes the mount to a sub-path within the bucket rather
24+
than using the entire bucket. For example, setting the prefix to ``nextcloud/`` will store all
25+
files under the ``nextcloud/`` key namespace inside the bucket, leaving the rest of the bucket
26+
untouched. This is useful when a bucket is shared between multiple services or Nextcloud instances.
27+
28+
.. note::
29+
The prefix is automatically normalized: leading slashes are stripped and a trailing slash is
30+
always added. ``myapp``, ``myapp/``, and ``/myapp/`` are all equivalent.
31+
32+
.. tip::
33+
The ``$user`` placeholder is supported in the prefix field and is substituted with the
34+
Nextcloud username at mount time. For example, setting the prefix to ``nextcloud/$user/``
35+
will store each user's files under their own namespace (e.g. ``nextcloud/alice/`` for user
36+
``alice``). This is particularly useful for global mounts shared across all users.
37+
2338
In the **Access key** field enter your *S3 access key ID*.
2439

2540
In the **Secret key** field enter your *S3 access key*.

0 commit comments

Comments
 (0)