Skip to content

Commit

Permalink
Merge pull request #13498 from opf/nextcloud-documentation-changes
Browse files Browse the repository at this point in the history
Nextcloud documentation changes
  • Loading branch information
MayaBerd committed Aug 18, 2023
2 parents 23a1a85 + ac00643 commit 2067109
Show file tree
Hide file tree
Showing 10 changed files with 30 additions and 6 deletions.
4 changes: 3 additions & 1 deletion docs/system-admin-guide/integrations/nextcloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,14 @@ OpenProject offers close integration with Nextcloud to allow users to:
## Minimum requirements

Please note these minimum version requirements for the integration to work:
Please note these minimum version requirements for the integration to work with a minimal feature set:

- OpenProject version 12.2 (or above)
- Nextcloud version 22 (or above)
- The [OpenProject Integration](https://apps.nextcloud.com/apps/integration_openproject) app, version 2.0.0 (or above)

We recommend using the latest versions of both Nextcloud and OpenProject to be able to use the latest features.

## Set up the integration

> **Important**: You need to have administrator privileges in both your Nextcloud and OpenProject instances to set up this integration.
Expand Down
16 changes: 14 additions & 2 deletions docs/user-guide/nextcloud-integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ Starting with OpenProject 12.2, you can use [Nextcloud](https://nextcloud.com/)
This integration makes it possible for you to:

- Link files and folders stored in Nextcloud with work packages in OpenProject
- View, open and download files and folders linked to a work package via the Files tab
- View, open and download files and folders linked to a work package via the **Files** tab
- View all work packages linked to a file
- View OpenProject notifications via the Nextcloud dashboard

Since OpenProject 13.0 it is also possible to automatically create dedicated [project folders](../projects/project-settings/file-storages/#project-folders), which makes documentation structure clearer and makes navigation more intuitive.

> **Important note**: The minimum requirements for this integration are Nextcloud version 22 (or above) and OpenProject version 12.2 (or above). To be able to use Nextcloud as a file storage in your project, the administrator of your instance should first have completed the [Nextcloud integration setup](../../system-admin-guide/integrations/nextcloud). Then a project administrator can activate Nextcloud in the [**File storages**](../projects/project-settings/file-storages/) for a project.
> **Important note**: To be able to use Nextcloud as a file storage in your project, the administrator of your instance should first have completed the [Nextcloud integration setup](../../system-admin-guide/integrations/nextcloud). Then a project administrator can activate Nextcloud in the [**File storages**](../projects/project-settings/file-storages/) for a project.

| Topic | Description |
Expand Down Expand Up @@ -174,6 +174,18 @@ There are two additional features related to the integration that you can enable

![Nextcloud search for work packages](nc_global_search.png)

## Work package link preview in Nextcloud

Starting with OpenProject 13.0 a work package link preview will be shown if you use Nextcloud Talk or Text apps. You can [copy a work package link](../work-packages/copy-move-delete/#copy-link-to-clipboard) and paste it into a Talk or Text app. Alternatively you can use **/** to activate the **smart picker** and find the work package by searching.

![activate smart picker in nextcloud](nc_smartpicker_start.png)

![smart picker search in nextcloud](nc_smartpicker_search.png)

Once you have selected a work package to share in the talk or text app, a preview of this work package will be displayed.

![work package preview in nextcloud](nc_smartpicker_preview.png)

## Permissions and access control

When a Nextcloud file or folder is linked to a work package, an OpenProject user who has access to that work package will be able to:
Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 13 additions & 3 deletions docs/user-guide/projects/project-settings/file-storages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ In the page that follows, you will be able to select one of the file storages se
In the last step of the process, you will be able to choose which kind of project folder will be the default folder for file uploads for this project:

1. **No specific folder**: By default, each user will start at their own home folder when they upload a file.
2. **New folder with automatically managed permissions**: This will automatically create a root folder for this project and manage the access permissions for each project member. Each project member will automatically get read, write and share access permissions (according to defined [File storages permissions](../../../system-admin-guide/users-permissions/roles-permissions/#permissions) in the project) to this root folder. This option will only be available if the system administrator has [set up the storage with automatically managed folders](../../../system-admin-guide/integrations/nextcloud/).
3. **Existing folder with manually managed permissions**: Once you selected this option, you can designate an existing folder as the root folder for this project using the button **Select folder**. The permissions are however not automatically managed. The administrator needs to manually ensure relevant users have access. The selected folder can be used by multiple projects.
2. **New folder with automatically managed permissions**: This will automatically create a folder for this project and manage the access permissions for each project member. Each project member will automatically get read, write and share access permissions (according to defined [File storages permissions](../../../system-admin-guide/users-permissions/roles-permissions/#permissions) in the project) to this folder. This option will only be available if the system administrator has [set up the storage with automatically managed folders](../../../system-admin-guide/integrations/nextcloud/).
3. **Existing folder with manually managed permissions**: Once you selected this option, you can designate an existing folder as the project folder for this project using the button **Select folder**. The permissions are however not automatically managed. The administrator needs to manually ensure relevant users have access. The selected folder can be used by multiple projects.

![Select the project folder type](storage-add-project-folder.png)

Expand All @@ -58,8 +58,18 @@ For the moment, you will only be able to edit which project folder type is used

![Edit the project folder type](storage-edit.png)

> **Note:** If the previous selected project folder type was **New folder with automatically managed permissions**, changing the project folder type will not delete the already created root folder and its permissions.
> **Note:** If the previous selected project folder type was **New folder with automatically managed permissions**, changing the project folder type will not delete the already created project folder.
To be able to delete a storage from a project you will be asked to confirm the action by introducing the name of the storage. This action is irreversible and will remove all links from work packages of this project to files and folders of that storage. Also, in case this storage has an automatically managed project folder, it and its files will be deleted forever.

![Delete a storage from a project](storage-delete.png)

## Project folder member connection status

As a project administrator you can see which of the project members have access to the automatically managed folders. To see the list of users click on the users icon on the right side of the list.

![Open a list of project members](storage-list-members.png)

You will see which project members have have successfully connected and who may need assistance.

![Project folder member connection status](storage-list-member-status.png)
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2067109

Please sign in to comment.