updated documentation

- added ACL administration
- updated screenshots

Signed-off-by: Sascha Wiswedel <sascha.wiswedel@nextcloud.com>
This commit is contained in:
Sascha Wiswedel 2019-08-29 20:45:35 +02:00
parent cd8664679f
commit 00304ca013
No known key found for this signature in database
GPG Key ID: DC336C0F05DBA0CD
4 changed files with 20 additions and 22 deletions

View File

@ -1,12 +1,12 @@
# Group folders
Admin configured folders shared by everyone in a group.
Admin configured folders accessible by everyone in a group.
## Configure folders
Folders can be configured from *Group folders* in the admin settings.
After a folder is created, the admin can give access to the folder to one or more groups and a quota can be assigned for the folder.
After a folder is created, the admin can give access to the folder to one or more groups, a quota can be assigned for the folder and advanced permissions can be activated and configured.
![edit](screenshots/edit.png)
@ -23,17 +23,17 @@ Once configured, the folders will show up in the home folder for each user in th
## Advanced Permissions
Starting with Groupfolders 2.1.0 and Nextcloud 16 you can enable "Advanced Permissions", this allows admins to configure permissions
inside groupfolders on a per file and folder basis
_Advanced Permissions_ allows entitled users to configure permissions inside groupfolders on a per file and folder basis.
Permissions are configured by setting one or more of "Read", "Write", "Create", "Delete" or "Share" permissions to "allow" or "deny". Any permission not explicitly set will inherit the permissions from the parent folder. If multiple configured permissions for a single file or folder apply for a single user (such as when a user belongs to multiple groups), the "allow" permission will overwrite any "deny" permission.
![advanced permissions](screenshots/acl.png)
Advanced permissions have to be enabled for each groupfolder separably, after which an administrator can configure permissions for files and folders
trough the web interface under the share options (if the administrator has access to the groupfolder) or trough an occ command.
Users or whole groups can be entitled to set advanced permissions for each group folder separately on the group folders admin page.
For entitlements, only users from those groups are selectable which have to be configured selected in the Groups column.
![advanced permission entitlement](screenshots/aclAdmin.png)
Permissions are configure by setting one or more of "Read", "Write", "Create", "Delete" or "Share" permissions to "allow" or "deny", any permission not set
will inherit the permissions from the parent folder. If multiple configured permissions for a single file or folder apply for a single user
(such as when a user belongs to multiple groups), the "allow" permission will overwrite any "deny" permission.
### Configuring advanced permissions trough occ
@ -66,10 +66,8 @@ To help with configuring nested permission rules, you can check the effective pe
## Notes
* Currently using encryption on group folders is not supported, all files stored within a group folder will be stored unencrypted.
* A new Group folder currently overwrites user folders with the same name. While this does not cause data loss, the users will see the new (empty!) Group folder and wont be able to access their old folder. When the Group folder gets removed, the old folder reappears. While we look into forcing group folders to be unique in an upcoming update, we recommend administrators to make sure the names are unique, for example by prefixing them in a certain way like `GS_` and instructing users not to name their own top-level folders in a similar way.
* Currently actions will not be recorded in Activity-Stream
* Folders will appear as external storage and may need to be addressed per client-basis for download
* Currently using encryption on group folders is not supported. All files stored within a group folder will be stored unencrypted.
* In Client applications, group folders will appear as external storage and may need to be explicitly addressed for download.
## API
@ -80,16 +78,16 @@ For all `POST` calls the required parameters are listed, for more information ab
The following OCS calls are supported.
- `GET apps/groupfolders/folders`: Returns a list of call configured folders and their settings
- `POST apps/groupfolders/folders`: Create a new group folder.
- `mountpoint`: The name for the new folder.
- `POST apps/groupfolders/folders`: Create a new group folder
- `mountpoint`: The name for the new folder
- `GET apps/groupfolders/folders/$folderId`: Return a specific configured folder and it's settings
- `DELETE apps/groupfolders/folders/$folderId`: Delete a group folder.
- `DELETE apps/groupfolders/folders/$folderId`: Delete a group folder
- `POST apps/groupfolders/folders/$folderId/groups`: Give a group access to a folder
- `group`: The id of the group to be given access to the folder.
- `DELETE apps/groupfolders/folders/$folderId/groups/$groupId`: Remove access from a group to a folder.
- `group`: The id of the group to be given access to the folder
- `DELETE apps/groupfolders/folders/$folderId/groups/$groupId`: Remove access from a group to a folder
- `POST apps/groupfolders/folders/$folderId/groups/$groupId`: Set the permissions a group has in a folder
- `permissions` The new permissions for the group as bitmask of [permissions constants](https://github.com/nextcloud/server/blob/b4f36d44c43aac0efdc6c70ff8e46473341a9bfe/lib/public/Constants.php#L65)
- `POST apps/groupfolders/folders/$folderId/quota`: Set the quota for a folder.
- `quota`: The new quota for the folder in bytes, user `-3` for unlimited.
- `POST apps/groupfolders/folders/$folderId/mountpoint`: Change the name of a folder.
- `mountpoint`: The new name for the folder.
- `POST apps/groupfolders/folders/$folderId/quota`: Set the quota for a folder
- `quota`: The new quota for the folder in bytes, user `-3` for unlimited
- `POST apps/groupfolders/folders/$folderId/mountpoint`: Change the name of a folder
- `mountpoint`: The new name for the folder

BIN
screenshots/aclAdmin.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 22 KiB