@ -77,3 +77,33 @@ OpenProject installations with a valid Enterprise Edition token can switch to th
theme.
theme.
Go to _-> Administration -> Design_ and from the _Themes_ drop down menu choose _OpenProject BIM_.
Go to _-> Administration -> Design_ and from the _Themes_ drop down menu choose _OpenProject BIM_.
### Docker
#### OpenProject BIM Edition with Docker Compose
in order to use BIM Edition inside a docker-compose OpenProject installation, in the `docker-compose.override.yml` file in `x-op-app` > `environment` add one line
# set to true to enable the email receiving feature. See ./docker/cron for more options
IMAP_ENABLED: "${IMAP_ENABLED:-false}"
```
Note: If the current Docker installation does not yet hold important information it is recommended to simply create all docker containers from scratch as the seeded data such as themes, types, and demo projects are different in the BIM edition. The demo data gets seeded only at the very first time run of the container. The Docker volumes are required to be removed e.g. by issuing `docker-compose down --volumes`
@ -69,7 +69,15 @@ This will not remove your data which is persisted in named volumes, likely calle
If you want to start from scratch and remove the existing data you will have to remove these volumes via
If you want to start from scratch and remove the existing data you will have to remove these volumes via
`docker volume rm compose_opdata compose_pgdata`.
`docker volume rm compose_opdata compose_pgdata`.
### Configuration
In the compose folder you will find the file `docker-compose.yml` which can be edited.
Although we recommend using `docker-compose.override.yml`.
Please be aware that only those variables shall be edited which are documented as not everything is meant to be configured or bend.
#### BIM Edition
In order to install or change to BIM inside a Docker environment, please navigate to the [Docker](../installation-and-operations/changing-to-bim-edition/#docker) paragraph at the [Changing to BIM Edition](../installation-and-operations/changing-to-bim-edition) documentation.
### Disabling services in the docker-compose file
### Disabling services in the docker-compose file
@ -77,7 +85,6 @@ If you have an override file created, it is also easy to disable certain service
@ -41,7 +41,7 @@ Please note these minimum version requirements for the integration to work:
> **Important**: You need to have administrator privileges in both your Nextcloud and OpenProject instances to set up this integration.
> **Important**: You need to have administrator privileges in both your Nextcloud and OpenProject instances to set up this integration.
#### 1. Add the "OpenProject integration" app in Nextcloud and point it to your OpenProject instance
#### 1. Add the "OpenProject Integration" app in Nextcloud and point it to your OpenProject instance
Start by opening your Nextcloud instance as an administrator.
Start by opening your Nextcloud instance as an administrator.
@ -180,4 +180,4 @@ Deleting a file storage at an instance level deletes the Nextcloud integration c
## Using the integration
## Using the integration
Once the file storage is added and enabled for projects, your users are able to take full advantage of the integration between Nextcloud and OpenProject. For more information on how link Nextcloud files to work packages in OpenProject and access linked work packages in Nextcloud, please refer to the [Nextcloud integration user guide](../../../user-guide/nextcloud-integration/).
Once the file storage is added and enabled for projects, your users are able to take full advantage of the integration between Nextcloud and OpenProject. For more information on how to link Nextcloud files to work packages in OpenProject and access linked work packages in Nextcloud, please refer to [Using the Nextcloud integration](../../../user-guide/nextcloud-integration/).
@ -15,17 +15,17 @@ Our Agile boards can be for anything you would like to keep track of within your
> **Note**: The basic board is included in the OpenProject Community Edition. OpenProject Action boards is a Premium Feature and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community Edition is easily possible.
> **Note**: The basic board is included in the OpenProject Community Edition. OpenProject Action boards is a Premium Feature and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community Edition is easily possible.
@ -33,7 +33,7 @@ Our Agile boards can be for anything you would like to keep track of within your
The new Boards are tightly integrated with all other project management functionalities in OpenProject, i.e. work packages or Gantt charts. This makes it so easy and practical to include the Boards in your daily project management routines and to gain a much quicker overview of important topics in your project.
The new Boards are tightly integrated with all other project management functionalities in OpenProject, i.e. work packages or Gantt charts. This makes it so easy and practical to include the Boards in your daily project management routines and to gain a much quicker overview of important topics in your project.
@ -105,13 +105,13 @@ Choose a meaningful title for your Board so that it is clear, e.g. for other tea
**Action boards lists**: The available lists depend on the [type of board you choose](#choose-between-board-types). Remember: if you change a card between the lists, the respective attribute (e.g. status) will be updated automatically.
**Action boards lists**: The available lists depend on the [type of board you choose](#choose-between-board-types). Remember: if you change a card between the lists, the respective attribute (e.g. status) will be updated automatically.
**Basic board lists**: You can create any kind of list and name them to your needs. Remember: No updates to the attributes will happen when moving cards between the lists.
**Basic board lists**: You can create any kind of list and name them to your needs. Remember: No updates to the attributes will happen when moving cards between the lists.
**Basic board lists:** Give the list any meaningful name.
**Basic board lists:** Give the list any meaningful name.
**Action board lists:** The list's name will depend on the type of Action board you chose, e.g. "New", "In Progress", etc. for the Status board.
**Action board lists:** The list's name will depend on the type of Action board you chose, e.g. "New", "In Progress", etc. for the Status board.
@ -120,17 +120,19 @@ Click **+ add list** to add lists to your board.
## Remove lists
## Remove lists
To remove lists, click on the three dots next to a list's title, and select **Delete list**.
To remove lists, click on the three dots next to a list's title, and select **Delete list**
You can add cards to a list. Cards represent a [work package](../../user-guide/work-packages/) in OpenProject. They can be any kind of work within a project, e.g. a Task, a Bug, a Feature, a Risk, anything.
You can add cards to a list. Cards represent a [work package](../../user-guide/work-packages/) in OpenProject. They can be any kind of work within a project, e.g. a Task, a Bug, a Feature, a Risk, anything.
**Add existing**: enter an existing title or an ID and press Enter.
**Add existing**: enter an existing title or an ID and press Enter.
@ -143,15 +145,17 @@ You can update cards in the following ways:
**Move cards with drag and drop** within a list or to a new list. Remember: Moving cards to another list in an Action board will update their attributes, e.g. status.
**Move cards with drag and drop** within a list or to a new list. Remember: Moving cards to another list in an Action board will update their attributes, e.g. status.
A **double click on a card** will open the work package's **fullscreen view.** The **arrow** on top will bring you back to the boards view.
A **double click on a card** will open the work package's **fullscreen view.** The **arrow** on top will bring you back to the boards view. 
Clicking on **Open details view** (the blue "**i**") will open the work package's **[split screen view](../work-packages/work-package-views/#work-package-split-screen-view)**. You can close it by clicking on the **"x"** in its upper right corner.
Clicking on **Open details view** (the blue "**i**") will open the work package's **[split screen view](../work-packages/work-package-views/#work-package-split-screen-view)**. You can close it by clicking on the **"x"** in its upper right corner.
@ -175,7 +179,7 @@ To **create new** boards, **open existing** boards, or **delete** boards, naviga
Verify and **update roles and permissions for boards** in the [system's administration](../../system-admin-guide/users-permissions/) if necessary.
Verify and **update roles and permissions for boards** in the [system's administration](../../system-admin-guide/users-permissions/) if necessary.
@ -21,14 +21,13 @@ This integration makes it possible for you to:
> Note: The 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).
> Note: The 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).
| [Connecting your OpenProject and Nextcloud accounts](#connecting-your-openproject-and-nextcloud-accounts) | How to connect your Nextcloud and OpenProject accounts to be able to use this integration |
| [Connecting your OpenProject and Nextcloud accounts](#connecting-your-openproject-and-nextcloud-accounts) | How to connect your Nextcloud and OpenProject accounts to be able to use this integration |
| [Linking files and folders to work packages](#linking-files-and-folders-to-work-packages) | How to link/unlink files and folders to work packages and view and download linked files |
| [Linking files and folders to work packages](#linking-files-and-folders-to-work-packages) | How to link/unlink files and folders to work packages and view and download linked files |
| [Permissions and access control](#permissions-and-access-control) | Who has access to linked files and who doesn't |
| [Permissions and access control](#permissions-and-access-control) | Who has access to linked files and who doesn't |
| [Next steps for the integration](#next-steps-for-the-integration) | What is planned in future releases |
| [Next steps for the integration](#next-steps-for-the-integration) | What is planned in future releases |
| [Possible errors and troubleshooting](#possible-errors-and-troubleshooting) | Common errors and how to troubleshoot them |
| [Possible errors and troubleshooting](#possible-errors-and-troubleshooting) | Common errors and how to troubleshoot them |
@ -52,7 +51,9 @@ To begin using this integration, you will need to first connect your OpenProject
5. The one-time process to connect your two accounts is complete. You will now be directed back to the original work package, where you can view and open any Nextcloud files that are already linked, or start linking new ones.
5. The one-time process to connect your two accounts is complete. You will now be directed back to the original work package, where you can view and open any Nextcloud files that are already linked, or start linking new ones.
> **Note:** To disconnect the link between your OpenProject and Nextcloud accounts, head on over to Nextcloud and navigate to _Settings → Connected accounts_. There, clicking **Disconnect from OpenProject** button. To re-link the two accounts, simply follow the above instructions again.
> **Note**: To disconnect the link between your OpenProject and Nextcloud accounts, head on over to Nextcloud and navigate to _Settings → Connected accounts_. There, click *Disconnect from OpenProject* button. To re-link the two accounts, simply follow [the above instructions](#connecting-your-openproject-and-nextcloud-accounts) again.
## Linking files and folders to work packages
## Linking files and folders to work packages
@ -61,7 +62,7 @@ The following video gives you a short overview of how to use this integration:
In addition to listing files attached to a work package, the **Files** tab now also shows you Nextcloud files that are linked to the current work package. Hovering on any linked file with your mouse will give you options to **open or download the file, show the containing folder in Nextcloud or remove the link**.
In addition to listing files attached to a work package, the **Files** tab now also shows you Nextcloud files that are linked to the current work package. Hovering on any linked file with your mouse will give you options to **open or download the file, show the containing folder in Nextcloud or remove the link**.
@ -71,7 +72,6 @@ In addition to listing files attached to a work package, the **Files** tab now a
> **Note:** In this version of the integration, you can only link files to work packages on Nextcloud; adding a new link to a Nextcloud file via the OpenProject interface is not yet possible, but will be possible in the near future.
> **Note:** In this version of the integration, you can only link files to work packages on Nextcloud; adding a new link to a Nextcloud file via the OpenProject interface is not yet possible, but will be possible in the near future.
### In Nextcloud
### In Nextcloud
On the file or folder that you want to link to a work package, click on the *three dots → **Details**.*
On the file or folder that you want to link to a work package, click on the *three dots → **Details**.*
@ -97,7 +97,6 @@ In addition to actions related to individual files, you can also choose to displ
There are three additional features related to the integration that you can enable in Nextcloud. In your personal settings page, under *Connected accounts*, you will find these options:
There are three additional features related to the integration that you can enable in Nextcloud. In your personal settings page, under *Connected accounts*, you will find these options:
- **Enable navigation link** displays a link to your OpenProject instance in the Nextcloud header
- **Enable navigation link** displays a link to your OpenProject instance in the Nextcloud header
@ -110,6 +109,10 @@ There are three additional features related to the integration that you can enab
> **Note:** In this version of the integration, you can only link files to work packages on Nextcloud; adding a new link to a Nextcloud file via the OpenProject interface is not yet possible, but will be possible in the near future.
## Permissions and access control
## 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:
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:
@ -126,11 +129,13 @@ However, all available actions depend on permissions the OpenProject user (or mo
Further integration efforts are under way. In the near future, you will be able to link and upload files to Nextcloud directly from the OpenProject interface.
Further integration efforts are under way. In the near future, you will be able to link and upload files to Nextcloud directly from the OpenProject interface.
## Possible errors and troubleshooting
## Possible errors and troubleshooting
#### No permission to see this file
#### No permission to see this file
If you are unable to see the details of a file or are unable to open some of the files linked to a work package, it could be related to your Nextcloud user not having the necessary permissions. In such a case, you will be able to see the name, time of last modification and the name of the modifier but you will not be able to perform any further actions. To open or access these files, please contact your Nextcloud administrator or the creator of the file so that they can grant you the necessary permissions.
If you are unable to see the details of a file or are unable to open some of the files linked to a work package, it could be related to your Nextcloud account not having the necessary permissions. In such a case, you will be able to see the name, time of last modification and the name of the modifier but you will not be able to perform any further actions. To open or access these files, please contact your Nextcloud administrator or the creator of the file so that they can grant you the necessary permissions.
Oliver Günther
2 years ago
