Skip to content

Commit

Permalink
chore: Rename app to Team folders
Browse files Browse the repository at this point in the history
Signed-off-by: provokateurin <[email protected]>
  • Loading branch information
provokateurin committed Jan 13, 2025
1 parent e12dbb8 commit 6878d90
Show file tree
Hide file tree
Showing 25 changed files with 80 additions and 80 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ labels: bug, 0. Needs triage
<!--
Thanks for reporting issues back to Nextcloud!
Note: This is the **issue tracker of Nextcloud app Group Folder**, please do NOT use this to get answers to your questions or get help for fixing your installation. This is a place to report bugs to developers, after your server has been debugged. You can find help debugging your system on our home user forums: https://help.nextcloud.com or, if you use Nextcloud in a large organization, ask our engineers on https://portal.nextcloud.com. See also https://nextcloud.com/support for support options.
Note: This is the **issue tracker of Nextcloud app Team folders**, please do NOT use this to get answers to your questions or get help for fixing your installation. This is a place to report bugs to developers, after your server has been debugged. You can find help debugging your system on our home user forums: https://help.nextcloud.com or, if you use Nextcloud in a large organization, ask our engineers on https://portal.nextcloud.com. See also https://nextcloud.com/support for support options.
Nextcloud is an open source project backed by Nextcloud GmbH. Most of our volunteers are home users and thus primarily care about issues that affect home users. Our paid engineers prioritize issues of our customers. If you are neither a home user nor a customer, consider paying somebody to fix your issue, do it yourself or become a customer.
Expand All @@ -18,7 +18,7 @@ Guidelines for submitting issues:
- You can also filter by appending e. g. "state:open" to the search string.
- More info on search syntax within github: https://help.github.com/articles/searching-issues
* This repository https://github.com/nextcloud/groupfolders/issues is *only* for issues within the Group folders code.
* This repository https://github.com/nextcloud/groupfolders/issues is *only* for issues within the Team folders code.
* SECURITY: Report any potential security bug to us via our HackerOne page (https://hackerone.com/nextcloud) following our security policy (https://nextcloud.com/security/) instead of filing an issue in our bug tracker.
Expand Down Expand Up @@ -59,7 +59,7 @@ Tell us what happens instead

**Nextcloud version:** (see Nextcloud admin page)

**Group folders version:**
**Team folders version:**

**Updated from an older Nextcloud/ownCloud or fresh install:**

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ labels: enhancement, 0. Needs triage
<!--
Thanks for reporting issues back to Nextcloud!
Note: This is the **issue tracker of Nextcloud Group folders**, please do NOT use this to get answers to your questions or get help for fixing your installation. This is a place to report bugs to developers, after your server has been debugged. You can find help debugging your system on our home user forums: https://help.nextcloud.com or, if you use Nextcloud in a large organization, ask our engineers on https://portal.nextcloud.com. See also https://nextcloud.com/support for support options.
Note: This is the **issue tracker of Nextcloud Team folders**, please do NOT use this to get answers to your questions or get help for fixing your installation. This is a place to report bugs to developers, after your server has been debugged. You can find help debugging your system on our home user forums: https://help.nextcloud.com or, if you use Nextcloud in a large organization, ask our engineers on https://portal.nextcloud.com. See also https://nextcloud.com/support for support options.
Nextcloud is an open source project backed by Nextcloud GmbH. Most of our volunteers are home users and thus primarily care about issues that affect home users. Our paid engineers prioritize issues of our customers. If you are neither a home user nor a customer, consider paying somebody to fix your issue, do it yourself or become a customer.
Expand All @@ -18,7 +18,7 @@ Guidelines for submitting issues:
- You can also filter by appending e. g. "state:open" to the search string.
- More info on search syntax within github: https://help.github.com/articles/searching-issues
* This repository https://github.com/nextcloud/groupfolders/issues is *only* for issues within the Nextcloud Group folders code.
* This repository https://github.com/nextcloud/groupfolders/issues is *only* for issues within the Nextcloud Team folders code.
* SECURITY: Report any potential security bug to us via our HackerOne page (https://hackerone.com/nextcloud) following our security policy (https://nextcloud.com/security/) instead of filing an issue in our bug tracker.
Expand Down
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
- SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
- SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Group Folders
# Team folders

[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud/groupfolders)](https://api.reuse.software/info/github.com/nextcloud/groupfolders)

Expand All @@ -16,36 +16,36 @@

[^1]: The releases are now managed in a [dedicated release repository](https://github.com/nextcloud-releases/groupfolders/releases). The releases in this repository may be outdated.

## Configuring Group Folders
## Configuring Team folder

Group Folders can be configured through *Group Folders* under *Administration settings*.
Team folders can be configured through *Team folders* under *Administration settings*.

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)

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

![permissions](screenshots/permissions.png)

The configuration options include the _Write_, _Share_ and _Delete_ permissions for each group.

## Using Group Folders
## Using Team folders

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

![folders](screenshots/folders.png)

## Setting Advanced Permissions

_Advanced Permissions_ allows entitled users to configure permissions inside groupfolders on a per file and folder basis.
_Advanced Permissions_ allows entitled users to configure permissions inside Team folders 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 advanced 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. Denied permissions configured for the group folder itself cannot be overwritten to "allow" permissions by the advanced permission rules.
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 advanced 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. Denied permissions configured for the Team folder itself cannot be overwritten to "allow" permissions by the advanced permission rules.

![advanced permissions](screenshots/acl.png)

Users or whole groups can be entitled to set advanced permissions for each group folder separately on the group folders admin page.
Users or whole groups can be entitled to set advanced permissions for each Team folder separately on the Team 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)
Expand All @@ -54,7 +54,7 @@ For entitlements, only users from those groups are selectable which have to be c

Some settings are currently only exposed via `config/config.php`:

### Default quota for new groupfolders
### Default quota for new Team folders

```injectablephp
'groupfolders.quota.default' => -3,
Expand All @@ -64,24 +64,24 @@ The special value `-3` means unlimited and any other value is the quota limit in

## Command-line interface management and configuration (via `occ`)

Group folders can be configured and managed from the command-line interface (CLI). This is accomplished by using the `occ` command.
Team folders can be configured and managed from the command-line interface (CLI). This is accomplished by using the `occ` command.

The `occ` command is utilized throughout Nextcloud for many operations and is not specific to Group Folders. When the Group Folders app is enabled, the `occ` command gains additional functionality specific to Group Folders.
The `occ` command is utilized throughout Nextcloud for many operations and is not specific to Team folders. When the Team folders app is enabled, the `occ` command gains additional functionality specific to Team folders.

If you're unfamiliar with `occ` see [Using the occ command](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/occ_command.html) in the Nextcloud Server Administration Guide for general guidance.

### Commands Available

- `occ groupfolders:create <name>` &rarr; create a group folder
- `occ groupfolders:delete <folder_id> [-f|--force]` &rarr; delete a group folder and all its contents
- `occ groupfolders:create <name>` &rarr; create a Team folder
- `occ groupfolders:delete <folder_id> [-f|--force]` &rarr; delete a Team folder and all its contents
- `occ groupfolders:expire` &rarr; trigger file version and trashbin expiration (see [Nextcloud docs for versioning](https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/file_versioning.html) and [Nextcloud docs for the trash bin](https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/trashbin_configuration.html) for details)
- `occ groupfolders:group <folder_id> <group_id> [-d|--delete] [write|share|delete]` &rarr; assign groups and their rights to a group folder
- `occ groupfolders:list` &rarr; list configured group folders
- `occ groupfolders:group <folder_id> <group_id> [-d|--delete] [write|share|delete]` &rarr; assign groups and their rights to a Team folder
- `occ groupfolders:list` &rarr; list configured Team folders
- `occ groupfolders:permissions` &rarr; configure advanced permissions (see below for details)
- `occ groupfolders:quota <folder_id> [<quota>|unlimited]` &rarr; set a quota for a group folder
- `occ groupfolders:rename <folder_id> <name>` &rarr; rename a group folder
- `occ groupfolders:scan <folder_id>` &rarr; trigger a filescan for a group folder
- `occ groupfolders:trashbin:cleanup` &rarr; empty the trashbin of all group folders
- `occ groupfolders:quota <folder_id> [<quota>|unlimited]` &rarr; set a quota for a Team folder
- `occ groupfolders:rename <folder_id> <name>` &rarr; rename a Team folder
- `occ groupfolders:scan <folder_id>` &rarr; trigger a filescan for a Team folder
- `occ groupfolders:trashbin:cleanup` &rarr; empty the trashbin of all Team folders
- `occ config:app:set groupfolders enable_encryption --value="true"` &rarr; activate encryption (server-side) support

### Configuring Advanced Permissions via `occ`
Expand All @@ -90,7 +90,7 @@ Advanced permissions can also be configured through the `occ groupfolders:permis

#### Enabling

Before configuring any advanced permissions you'll first have to enable advanced permissions for the folder using `occ groupfolders:permissions <folder_id> --enable`. To do this you'll first need to find the `folder_id` of the groupfolder you're trying to configure. You can use `occ groupfolders:list` to find the `folder_id` of the target folder.
Before configuring any advanced permissions you'll first have to enable advanced permissions for the folder using `occ groupfolders:permissions <folder_id> --enable`. To do this you'll first need to find the `folder_id` of the Team folder you're trying to configure. You can use `occ groupfolders:list` to find the `folder_id` of the target folder.

#### Using

Expand Down Expand Up @@ -120,7 +120,7 @@ To manage the users or groups entitled to set advanced permissions, use `occ gro

#### Disabling

To disable the advanced permissions feature for a group folder, use `occ groupfolders:permissions <folder_id> --disable`.
To disable the advanced permissions feature for a Team folder, use `occ groupfolders:permissions <folder_id> --disable`.

## APIs

Expand All @@ -130,7 +130,7 @@ See the [OpenAPI specification](openapi.json) to learn about all available API e

### WebDAV API

Group folders are also exposed through a separate [WebDAV API](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) at `/remote.php/dav/groupfolders/<user id>`.
Team folders are also exposed through a separate [WebDAV API](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) at `/remote.php/dav/groupfolders/<user id>`.

In addition to browsing the contents of the group folders, you can also request the mount point for the group folder by requesting the `{http://nextcloud.org/ns}mount-point` property.
In addition to browsing the contents of the Team folders, you can also request the mount point for the Team folder by requesting the `{http://nextcloud.org/ns}mount-point` property.

10 changes: 5 additions & 5 deletions appinfo/info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
-->
<info>
<id>groupfolders</id>
<name>Group folders</name>
<summary>Admin configured folders shared with everyone in a group</summary>
<description><![CDATA[Admin configured folders shared with everyone in a group.
<name>Team folders</name>
<summary>Admin configured folders shared with everyone in a Team</summary>
<description><![CDATA[Admin configured folders shared with everyone in a Team.
Folders can be configured from *Group folders* in the admin settings.
Folders can be configured from *Team folders* in the admin settings.
After a folder is created, the admin can give access to the folder to one or more groups, control their write/sharing permissions and assign a quota for the folder.
After a folder is created, the admin can give access to the folder to one or more teams, control their write/sharing permissions and assign a quota for the folder.
]]></description>
<version>19.0.0-alpha.1</version>
<licence>agpl</licence>
Expand Down
2 changes: 1 addition & 1 deletion lib/Command/ACL.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public function __construct(
protected function configure(): void {
$this
->setName('groupfolders:permissions')
->setDescription('Configure advanced permissions for a configured group folder')
->setDescription('Configure advanced permissions for a configured Team folder')
->addArgument('folder_id', InputArgument::REQUIRED, 'Id of the folder to configure')
->addOption('enable', 'e', InputOption::VALUE_NONE, 'Enable advanced permissions for the folder')
->addOption('disable', 'd', InputOption::VALUE_NONE, 'Disable advanced permissions for the folder')
Expand Down
2 changes: 1 addition & 1 deletion lib/Command/Create.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public function __construct(
protected function configure(): void {
$this
->setName('groupfolders:create')
->setDescription('Create a new group folder')
->setDescription('Create a new Team folder')
->addArgument('name', InputArgument::REQUIRED, 'Name of the new folder');
parent::configure();
}
Expand Down
4 changes: 2 additions & 2 deletions lib/Command/Delete.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class Delete extends FolderCommand {
protected function configure(): void {
$this
->setName('groupfolders:delete')
->setDescription('Delete group folder')
->setDescription('Delete Team folder')
->addArgument('folder_id', InputArgument::REQUIRED, 'Id of the folder to rename')
->addOption('force', 'f', InputOption::VALUE_NONE, 'Skip confirmation');
parent::configure();
Expand All @@ -31,7 +31,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
}

$helper = $this->getHelper('question');
$question = new ConfirmationQuestion('Are you sure you want to delete the group folder ' . $folder['mount_point'] . ' and all files within, this cannot be undone (y/N).', false);
$question = new ConfirmationQuestion('Are you sure you want to delete the Team folder ' . $folder['mount_point'] . ' and all files within, this cannot be undone (y/N).', false);
if ($input->getOption('force') || $helper->ask($input, $output, $question)) {
$folderMount = $this->mountProvider->getFolder($folder['id']);
$this->folderManager->removeFolder($folder['id']);
Expand Down
4 changes: 2 additions & 2 deletions lib/Command/ExpireGroupVersionsPlaceholder.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ class ExpireGroupVersionsPlaceholder extends Base {
protected function configure(): void {
$this
->setName('groupfolders:expire')
->setDescription('Trigger expiry of versions for files stored in group folders');
->setDescription('Trigger expiry of versions for files stored in Team folders');
parent::configure();
}

protected function execute(InputInterface $input, OutputInterface $output): int {
$output->writeln('<error>groupfolder version handling is only supported with Nextcloud 15 and up</error>');
$output->writeln('<error>Team folder version handling is only supported with Nextcloud 15 and up</error>');
return 0;
}
}
2 changes: 1 addition & 1 deletion lib/Command/Group.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public function __construct(
protected function configure(): void {
$this
->setName('groupfolders:group')
->setDescription('Edit the groups that have access to a group folder')
->setDescription('Edit the groups that have access to a Team folder')
->addArgument('folder_id', InputArgument::REQUIRED, 'Id of the folder to configure')
->addArgument('group', InputArgument::REQUIRED, 'The group to configure')
->addArgument('permissions', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'The permissions to set for the group, leave empty for read only')
Expand Down
4 changes: 2 additions & 2 deletions lib/Command/ListCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ public function __construct(
protected function configure(): void {
$this
->setName('groupfolders:list')
->setDescription('List the configured group folders')
->addOption('user', 'u', InputArgument::OPTIONAL, 'List group folders applicable for a user');
->setDescription('List the configured Team folders')
->addOption('user', 'u', InputArgument::OPTIONAL, 'List Team folders applicable for a user');
parent::configure();
}

Expand Down
2 changes: 1 addition & 1 deletion lib/Command/Quota.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class Quota extends FolderCommand {
protected function configure(): void {
$this
->setName('groupfolders:quota')
->setDescription('Edit the quota of a configured group folder')
->setDescription('Edit the quota of a configured Team folder')
->addArgument('folder_id', InputArgument::REQUIRED, 'Id of the folder to configure')
->addArgument('quota', InputArgument::REQUIRED, 'New value for the quota of the folder');
parent::configure();
Expand Down
2 changes: 1 addition & 1 deletion lib/Command/Rename.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class Rename extends FolderCommand {
protected function configure(): void {
$this
->setName('groupfolders:rename')
->setDescription('Rename group folder')
->setDescription('Rename Team folder')
->addArgument('folder_id', InputArgument::REQUIRED, 'Id of the folder to rename')
->addArgument('name', InputArgument::REQUIRED, 'New value name of the folder');
parent::configure();
Expand Down
Loading

0 comments on commit 6878d90

Please sign in to comment.