Skip to content

Commit

Permalink
Adding documentation on file storages troubleshooting (#15295)
Browse files Browse the repository at this point in the history
* Adding documentation on file storages troubleshooting

Adding documentation on file storages troubleshooting

* docs link fix

* docs link fix

* adding file storages health status e-mail documentation

* Update docs/system-admin-guide/file-storages/file-storage-troubleshooting/README.md

Co-authored-by: dominic-braeunlein <d.braeunlein@openproject.com>

* Update docs/system-admin-guide/file-storages/file-storage-troubleshooting/README.md

Co-authored-by: dominic-braeunlein <d.braeunlein@openproject.com>

* Update docs/system-admin-guide/file-storages/file-storage-troubleshooting/README.md

Co-authored-by: dominic-braeunlein <d.braeunlein@openproject.com>

* Update docs/system-admin-guide/file-storages/file-storage-troubleshooting/README.md

Co-authored-by: dominic-braeunlein <d.braeunlein@openproject.com>

* Update docs/system-admin-guide/file-storages/file-storage-troubleshooting/README.md

Co-authored-by: dominic-braeunlein <d.braeunlein@openproject.com>

* Update docs/system-admin-guide/file-storages/file-storage-troubleshooting/README.md

Co-authored-by: dominic-braeunlein <d.braeunlein@openproject.com>

* Update docs/system-admin-guide/file-storages/file-storage-troubleshooting/README.md

Co-authored-by: dominic-braeunlein <d.braeunlein@openproject.com>

* Update docs/system-admin-guide/file-storages/file-storage-troubleshooting/README.md

Co-authored-by: dominic-braeunlein <d.braeunlein@openproject.com>

* Update docs/system-admin-guide/file-storages/file-storage-troubleshooting/README.md

Co-authored-by: dominic-braeunlein <d.braeunlein@openproject.com>

* Update README.md

* Update docs/system-admin-guide/file-storages/file-storage-troubleshooting/README.md

Co-authored-by: dominic-braeunlein <d.braeunlein@openproject.com>

---------

Co-authored-by: dominic-braeunlein <d.braeunlein@openproject.com>
  • Loading branch information
MayaBerd and dominic-braeunlein committed Apr 19, 2024
1 parent 1c9c555 commit 3dcb62c
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/system-admin-guide/file-storages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,8 @@ For detailed guide on the initial setup, please consult [OneDrive/SharePoint int
Please also remember to activate the **File storages** module under [project settings in a respective project](../../user-guide/projects/project-settings/file-storages/).

For instructions on using the integration after the setup has been complete please refer to [SharePoint/OneDrive integration user guide](../../user-guide/file-management/one-drive-integration/).

## File storage troubleshooting

For troubleshooting guidance related to file storages, visit the [File storage troubleshooting](./file-storage-troubleshooting) page. Here you will find possible explanations and suggested solutions. If you encounter any challenges not addressed here, do not hesitate to reach out to the [OpenProject community](https://community.openproject.org/projects/openproject/forums) or [support team](https://www.openproject.org/contact/) for further assistance.

Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
sidebar_navigation:
title: File storages troubleshooting
priority: 999
description: File storages troubleshooting in OpenProject.
keywords: file storages, Nextcloud error, Nextcloud troubleshooting, OneDrive error, Sharepoint error, OneDrive, Sharepoint, error, troubleshooting
---

# File storage errors and troubleshooting

## Unhealthy file storages email notifications

In some cases it is possible that a file storage has been set-up incorrectly, the connection is faulty or the storage itself has problems. In this case the respective message will appear under *Administration* -> *File storages*.

> Please note that this only applies to file storages where **automatically managed project folders** have been selected.
![Health check for automatically managed folders in file storage integrations in OpenProject](openproject_file_storages_health_message.png)

If a problem has been detected for a file storage with automatically managed folders enabled, the OpenProject adminstrators will be notified via email of the detected error. Admin will be notified once a day of the faulty integration, including the specific error description and solution suggestions (see the section below).

Once the error has been resolved, the admin will also receive an email informing him/her/them of this.

You can choose to subscribe or unsubscribe to these email notifications by clicking the respective button under the error message.

## File storage errors description

Once you have set up your files storages, it is possible that a technical error may occur. Please consult the following table for possible reasons behind the errors and suggested solutions.



| Error name | Error description | Possible reasons | Next steps and solutions |
| ------------ | --------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| Error | No group specified | The name may not be specified for the storage.<br/>A glitch during setup or manual changes to the DB could cause this problem. The group name is saved in the database in the Storages Table in the providers field (JSON). | Setup the entire storage again. |
| Error | Group does not exist | The app was activated on Nextcloud and the OpenProject group was removed afterwards.<br/>Changes on Nextlcoud: OpenProject group was removed. | Manually add the group in the Nextcloud setup and call it OpenProject. Add the user OpenProject to the group OpenProject. |
| Error | User does not exist | After the app was activated on Nextcloud and the user was removed afterwards.<br /> Changes on Nextlcoud: OpenProject user was removed. | Manually add the user in the Nextcloud setup and call that user OpenProject. Add the user OpenProject to the group OpenProject. <br />Alternatively reinstall the OpenProject integration app on Nextcloud. You will also need to reconfigure the Nextcloud storage. |
| Error | Insufficient privileges | OpenProject can not change the user permissions for folders or add folders to the OpenProject folder, because the OpenProject user no longer has access to the folder. | Reinstall the OpenProject integration app on Nextcloud. You will need to reconfigure the Nextcloud storage. Make sure the OpenProject user is the admin of the OpenProject group and also the admin of the OpenProject folder. |
| Error | Failed to remove or add user from group | A user does not exist in the file storage. <br />A user can not be removed from the OpenProject group due to admin rights. <br />This may occur when running the sync job and further information can be found in the server logs. | Ensure that the user exists in the file storage platform. <br />Remove admin rights for that user on the OpenProject group. <br />If the user is also an admin in the files storage group, he/she/they need to be removed by a file storage platform admin. |
| Not allowed | Outbound request method not allowed | OpenProject sent wrong requests to the storage. <br />This error can occur both in Nextcloud and OneDrive/Sharepoint integration. | Report this to [OpenProject community](https://community.openproject.org/projects/openproject/forums) or [support team](https://www.openproject.org/contact/). |
| Not found | Outbound request destination not found | OpenProject can not reach file storage platform. <br />This could be due to Storage provider being down:<br />- DNS problems <br />- Network problems (flaky network) <br />- Local networks (Nexctloud specific setting that needs to enabled) | See if you can access the file storage platform from your browser. <br />For Nextcloud, see if Nextcloud settings are active if in local network. |
| Unauthorized | Outbound request not authorized | - Authentification is failing<br /> - Application password was changed and not updated in OpenProject (Nextcloud OAuth settings are wrong or OneDrive/SharePoint client secret or ID is wrong).<br />- User has no access, can not login, no token can be negotiated.<br /> Server to server: the client secret might be wrong <br /> OpenProject User credentials might be wrong | Check the storages setup.<br />Check if the client secret (OneDrive/SharePoint) or the OAuth setup is correct (Nextcloud).<br />Check if the application password is correct. |
| Conflict | *error_text_from_response* | A folder or a file was created, which already exists on the storage platform, e.g. a folder with the same name exists. <br /> Can happen if for example a user manually created something on the storage platform. | Check in the storage platform if the folder already exists. |
| Error | Outbound request failed | An unexpected 500 error, e.g. TOS (Terms of Service) app was activated and OpenProject can not access storage anymore. <br /> Password configuration plugin may have caused problems. | See if file storage is working correctly. If it does, collect as much information as possible and contact [OpenProject community](https://community.openproject.org/projects/openproject/forums) or [support team](https://www.openproject.org/contact/). |




If the suggested troubleshooting solutions did not resolve your issue, please reach out to the [OpenProject community](https://community.openproject.org/projects/openproject/forums) or [support team](https://www.openproject.org/contact/) for further assistance.
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 3dcb62c

Please sign in to comment.