# Group folders

Admin configured folders shared 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.


![edit](screenshots/edit.png)

Permissions to the content of a group folder can be configured on a per-group basis.

![permissions](screenshots/permissions.png)

## Folders

Once configured, the folders will show up in the home folder for each user in the configured groups.

![folders](screenshots/folders.png)

## 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 won’t 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 (worked on for NC 15)
* Deleted files and folders do not appear in the deleted files section and can not be restored via the Interface (worked on for NC 15)
* Folders will appear as external storage and may need to be addressed per client-basis for download

## API

Group folders can be configured externally trough the OCS Api.

For all `POST` calls the required parameters are listed, for more information about how to use an OCS api see the [Nextcloud documentation on the topic](https://docs.nextcloud.com/server/12/developer_manual/client_apis/OCS/index.html)

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.
- `GET apps/groupfolders/folders/$folderId`: Return a specific configured folder and it's settings
- `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.
- `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.