Merge remote-tracking branch 'origin/documentation' into release/10.3

pull/7970/head
Henriette Dinger 5 years ago
commit ea78f5a4bc
  1. BIN
      help/cloud-edition-guide/book-cloud-edition/Cloud-edition-booking.png
  2. BIN
      help/cloud-edition-guide/book-cloud-edition/Cloud-edition-buy-now-teaser.png
  3. BIN
      help/cloud-edition-guide/book-cloud-edition/Cloud-edition-invoice.png
  4. 85
      help/cloud-edition-guide/book-cloud-edition/README.md
  5. BIN
      help/cloud-edition-guide/book-cloud-edition/image-20200115140341853.png
  6. BIN
      help/cloud-edition-guide/book-cloud-edition/image-20200115140444053.png
  7. BIN
      help/cloud-edition-guide/book-cloud-edition/image-20200115140630463.png
  8. BIN
      help/cloud-edition-guide/book-cloud-edition/image-20200115140927046.png
  9. BIN
      help/cloud-edition-guide/book-cloud-edition/image-20200115141131383.png
  10. BIN
      help/cloud-edition-guide/book-cloud-edition/image-20200115141724205.png
  11. 51
      help/system-admin-guide/README.md
  12. BIN
      help/system-admin-guide/Sys-admin-administration-1579104292770.png
  13. BIN
      help/system-admin-guide/Sys-admin-administration.png
  14. 18
      help/system-admin-guide/authentication/README.md
  15. BIN
      help/system-admin-guide/authentication/ldap-authentication/Authentication.png
  16. 56
      help/system-admin-guide/authentication/ldap-authentication/README.md
  17. BIN
      help/system-admin-guide/authentication/ldap-authentication/Screenshot-from-2018-11-01-13-47-42.png
  18. BIN
      help/system-admin-guide/authentication/ldap-authentication/Screenshot-from-2018-11-01-14-03-42.png
  19. BIN
      help/system-admin-guide/authentication/ldap-authentication/Sys-admin_ldap-authentication.png
  20. BIN
      help/system-admin-guide/authentication/ldap-authentication/ldap-group-synchronization/Bildschirmfoto-2018-02-01-um-16.41.26.png
  21. 54
      help/system-admin-guide/authentication/ldap-authentication/ldap-group-synchronization/README.md
  22. BIN
      help/system-admin-guide/authentication/ldap-authentication/ldap-group-synchronization/ldap-groups-1-900x363@2x.png
  23. BIN
      help/system-admin-guide/image-20200115143956118.png
  24. 26
      help/system-admin-guide/users-permissions/README.md
  25. 18
      help/system-admin-guide/users-permissions/avatars/README.md
  26. BIN
      help/system-admin-guide/users-permissions/avatars/image-20200115173409850.png
  27. 44
      help/system-admin-guide/users-permissions/groups/README.md
  28. BIN
      help/system-admin-guide/users-permissions/groups/Sys-admin-add-users-groups.gif
  29. BIN
      help/system-admin-guide/users-permissions/groups/Sys-admin-edit-groups.png
  30. BIN
      help/system-admin-guide/users-permissions/groups/image-20200115164118182.png
  31. BIN
      help/system-admin-guide/users-permissions/groups/image-20200115164307813.png
  32. BIN
      help/system-admin-guide/users-permissions/groups/image-20200115164328352.png
  33. BIN
      help/system-admin-guide/users-permissions/groups/image-20200115164847858.png
  34. 48
      help/system-admin-guide/users-permissions/roles-permissions/README.md
  35. BIN
      help/system-admin-guide/users-permissions/roles-permissions/Sys-admin-create-new-role.png
  36. BIN
      help/system-admin-guide/users-permissions/roles-permissions/Sys-admin-edit-roles.png
  37. BIN
      help/system-admin-guide/users-permissions/roles-permissions/Sys-admin-new-roles.png
  38. 17
      help/system-admin-guide/users-permissions/settings/README.md
  39. BIN
      help/system-admin-guide/users-permissions/users/Admin-guide-lock-users.png
  40. 146
      help/system-admin-guide/users-permissions/users/README.md
  41. BIN
      help/system-admin-guide/users-permissions/users/Sys-admin-add-project.gif
  42. BIN
      help/system-admin-guide/users-permissions/users/Sys-admin-add-users.png
  43. BIN
      help/system-admin-guide/users-permissions/users/Sys-admin-delete-user.png
  44. BIN
      help/system-admin-guide/users-permissions/users/Sys-admin-profile.png
  45. BIN
      help/system-admin-guide/users-permissions/users/Sys-admin-resend-invitation.png
  46. BIN
      help/system-admin-guide/users-permissions/users/Sys-admin-user-settings.png
  47. BIN
      help/system-admin-guide/users-permissions/users/image-20200115153138004.png
  48. BIN
      help/system-admin-guide/users-permissions/users/image-20200115155419645.png
  49. BIN
      help/system-admin-guide/users-permissions/users/image-20200115155456033.png
  50. BIN
      help/system-admin-guide/users-permissions/users/image-20200115155855409.png
  51. BIN
      help/system-admin-guide/users-permissions/users/image-20200115160331426.png
  52. BIN
      help/system-admin-guide/users-permissions/users/image-20200115162109669.png
  53. BIN
      help/system-admin-guide/users-permissions/users/image-20200115162533470.png
  54. BIN
      help/system-admin-guide/users-permissions/users/image-20200115165406439.png
  55. 8
      help/user-guide/gantt-chart/README.md
  56. 3
      help/user-guide/project-settings/README.md
  57. 24
      help/user-guide/project-settings/work-package-types/README.md
  58. 13
      help/user-guide/work-packages/copy-move-delete/README.md
  59. 4
      help/user-guide/work-packages/create-work-package/README.md
  60. 0
      help/user-guide/work-packages/work-package-relations-hierarchies/Add-Relations-1024x507@2x.png
  61. 0
      help/user-guide/work-packages/work-package-relations-hierarchies/Add-relation-column.png
  62. 11
      help/user-guide/work-packages/work-package-relations-hierarchies/README.md
  63. 0
      help/user-guide/work-packages/work-package-relations-hierarchies/Relations_column.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 553 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 165 KiB

@ -0,0 +1,85 @@
---
sidebar_navigation:
title: Subscribe
priority:
description: Book the OpenProject Cloud Edition.
robots: index, follow
keywords: Book Cloud Edition
---
# Book the Cloud Edition
After you have tested the OpenProject Could Edition and want to continue working with OpenProject, you can subscribe to one of our plans.
Please refer to our website for the Cloud Edition [pricing](https://www.openproject.org/pricing/).
You can subscribe to a monthly or yearly plan. The subscription can be **paid via Credit Card or Bank transfer** (only for yearly subscription).
To upgrade your trial to the full version, **click on the BUY NOW teaser**, e.g. in the application header or project menu.
![Cloud-edition-buy-now-teaser](Cloud-edition-buy-now-teaser.png)
You will be directed to the -> *Administration* -> *Billing*.
(1) First, choose if you want to subscribe to an **annual or monthly plan**. Only annually billed plans can be paid via bank transfer.
(2) Select the **amount of users** from the drop-down list. It is only to book members in the steps of 5, minimum 5 users.
(3) Select your **country** from the drop-down list.
(4) The **total amount** (excl. VAT) will be displayed.
(5) Click the **Subscribe** button.
![Cloud-edition-booking](Cloud-edition-booking.png)
Next, click the **Proceed to Checkout button**.
![Proceed to Checkout](image-20200115140341853.png)
Verify your **account details** and click the blue Next button.
![Account details](image-20200115140444053.png)
Add your **Billing address and VAT number** and click the blue **Next** button.
![Billing address](image-20200115140630463.png)
Enter your **payment details** (credit card information). Make sure to verify your address (same as for the invoice) in order to avoid payment failures via credit card. If your credit card is stated to a different address, make sure to enter it here as card address.
Click the blue **Next** button.
![Payment details](image-20200115140927046.png)
You will once again get an overview about your subscription.
Here, you can edit the account or billing information if needed.
Subscribe to our regular newsletter in order to keep up to date with latest product developments.
Click the blue **Pay button and subscribe** to the OpenProject Cloud Edition.
A payment receipt will be sent via email.
![Pay and subscribe](image-20200115141131383.png)
## Pay per invoice (via bank transfer)
If you book an annual plan you can also choose to pay via invoice.
(1) Click the **Pay per invoice check mark**.
(2) Enter your **Billing information**. Make sure to validate your billing email to receive the required information and invoice.
If you are a business customer, please enter a valid **VAT ID number**.
(3) You have to **agree to our terms of services and privacy policy**.
(4) Click the blue **Subscribe** button.
![Cloud-edition-invoice](Cloud-edition-invoice.png)
You will get an overview of your booked subscription.
An invoice will be sent via email to the Billing email.
![Subscription](image-20200115141724205.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

@ -1,22 +1,41 @@
# System Admin guide
---
sidebar_navigation:
title: System Admin guide
priority: 999
description: OpenProject system administration guide.
robots: index, follow
keywords: system administration
---
# System Administration guide
Welcome to the OpenProject System Administration guide.
Welcome to the OpenProject **System Administration guide**.
Here you will learn how to configure your OpenProject.
In order to make changes to settings affecting your entire OpenProject environment, you need to navigate to the OpenProject administration.
If you are an administrator on your OpenProject environment, you can access the administration by clicking on your user Avatar in the upper right corner and selecting ->*Administration* from the dropdown menu.
Click on one of the categories in order to proceed with the configuration.
![Sys-admin-administration](Sys-admin-administration-1579104292770.png)
## Overview
| Popular Topics | Description |
| --------------------------------------------- | :-------------------------------------------------- |
| [Users and permissions](./users-permissions) | How to manage users and permissions in OpenProject? |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
## Coming soon!
| Popular Topics | Description |
| ------------------------------------------------ | :----------------------------------------------------------- |
| [Users and permissions](./users-permissions) | How to manage users, groups and permissions in OpenProject? |
| [Work packages](./manage-work-packages) | How to configure work packages, types, status and workflows? |
| [Custom fields](./custom-fields) | Set custom fields for work packages, Spent time, projects, versions, users, groups and more. |
| [Enumerations](./enumerations) | Set enumerations, e.g. work package priorities, time tracking activities, document categories, and more. |
| [System settings](./ssytem-settings) | Configure your system settings, e.g. a welcome text block on the landing page, display settings, email notifications, incoming emails, repositories, and more. |
| [Authentication](./authentication) | Configure authentication methods in OpenProject, e.g. OAuth, OpenID, Two-factor-authentication, LDAP, and more. |
| [Announcement](./announcement) | How to create a system announcement? |
| [Design](./design) | Create your own design and make it compliant to your company's Corporate Identity, upload logo and customize colors. |
| [Colors](./colors) | Configure colors used in the system, e.g. status colors, work package types, priorities and more. |
| [Enterprise Edition](./enterprise-edition-guide) | Upgrade your Community Edition to the Enterprise Edition and enter your valid Enterprise token. |
| [Budgets](./budgets) | Configure your currency and create cost types in OpenProject. |
| [Backlogs](./backlogs) | Configure your backlogs settings in OpenProject, e.g. story types to be displayed in the backlogs, task types, and more. |
| [Billing](./cloud-edition-guide) | Manage your OpenProject Cloud Edition, e.g. subscribe to the Cloud Edition, upgrade, downgrade, cancel, and more. |
| [Plugins](./plugins) | Manage plugins in OpenProject. |
| [Webhooks](./webhooks) | Add and manage webhooks in OpenProject. |
| [Information](information) | View the latest system information status. |

Binary file not shown.

After

Width:  |  Height:  |  Size: 217 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 217 KiB

@ -0,0 +1,18 @@
# Authentication
Coming soon!
## Overview
| Popular Topics | Description |
| -------------- | :---------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

@ -0,0 +1,56 @@
---
sidebar_navigation:
title: LDAP authentication
priority:
description: Manage LDAP Authentication in OpenProject.
robots: index, follow
keywords: ldap authentication
---
# Manage LDAP Authentication
<div class="alert alert-info" role="alert">
**Note**: In order to be able to access the administration panel and manage LDAP authentication you need to be a system admin.
</div>
To see the list of all available LDAP (Lightweight Directory Access Protocol) authentications navigate to - > *Administration* and select *-> Authentication* -> *LDAP Authentication* from the menu on the left. You will see the list of all available authentications already created.
## Add a new LDAP authentication
To create a new LDAP authentication click on the respective icon.
![Sys-admin_ldap-authentication](Sys-admin_ldap-authentication.png)
You will then be able to specify the LDAP configuration. This can be any directory service compatible with the LDAPv3 standard, such as Microsoft Active Directory or openLDAP. The configuration depends on the specific database/applications, through which the authentication with OpenProject is intended.
The following screenshot contains an exemplary configuration for a new LDAP authentication mode. In the following, we will go through all available options.
![Adding a new LDAP authentication server](Screenshot-from-2018-11-01-13-47-42.png)
- **Name:** Arbitrary identifier used to show which authentication source a user is coming from (e.g., in the [Administration > Users view](https://www.openproject.org/help/administration/manage-users/))
- **Host:** Full hostname to the LDAP server
- **Port :** LDAP port. Will usually be 389 for LDAP and 689 for LDAPS connections.
- **LDAPS :** If checked, this will result in NET::LDAP connecting with the *simple_tls* option *enabled.* [Click here to read more details into what this means for connection security.](https://www.rubydoc.info/gems/ruby-net-ldap/Net/LDAP)
- **Account:** The full DN of a system users used for looking up user details in the LDAP. It must have read permissions under the Base DN. This will not be used for the user bind upon authentication.
- **Password:** The bind password of the system user’s DN above.
- **On-the-fly user creation:** Check to automatically create users in OpenProject when they first login in OpenProject. It will use the LDAP attribute mapping below to fill out required attributes. The user will be forwarded to a registration screen to complete required attributes if they are missing in the LDAP.
**Attribute mapping**
The attribute mapping is used to identify attributes of OpenProject with attributes of the LDAP directory. At least the *login* attribute is required to create DNs from the login credentials.
- **Login:** The login attribute in the ldap. Will be used to construct the DN from `login-attribute=value,`. Most often, this will be *uid.*
- **First name:** The attribute name in the LDAP that maps to first name. Most often, this will be *givenName.* If left empty, user will be prompted to enter upon registration if **on-the-fly-creation** is true.
- **Last name:** The attribute name in the LDAP that maps to last name. Most often, this will be *sn.* If left empty, user will be prompted to enter upon registration if **on-the-fly-creation** is true.
- **Email:** The attribute name in the LDAP that maps to the user’s mail address. This will usually be *mail.* If left empty, user will be prompted to enter upon registration if **on-the-fly-creation** is true.
- **Admin:** Specify an attribute that if it has a truthy value, results in the user in OpenProject becoming an admin account. Leave empty to never set admin status from LDAP attributes.
Lastly, click on *Create* to save the LDAP authentication mode. You will be redirected to the index page with the created authentication mode. Click the *test* button to create a test connection using the system user’s bind credentials.
![LDAP authentication mode created](Screenshot-from-2018-11-01-14-03-42.png)
With the [OpenProject Enterprise Edition](https://www.openproject.org/enterprise-edition/) it is possible to [synchronize LDAP and OpenProject groups](./ldap-group-synchronization).

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

@ -0,0 +1,54 @@
---
sidebar_navigation:
title: LDAP group synchronization
priority:
description: Synchronize LDAP groups.
robots: index, follow
keywords: synchronize ldap groups
---
# Synchronize LDAP and OpenProject groups (Premium feature)
Note: This feature is available for the Enterprise Edition only for OpenProject versions 7.4+. For more information and differences to CE, [see this page](https://www.openproject.org/enterprise-edition/).
In OpenProject EE, you can synchronize LDAP group memberships defined through the [groupOfNames](https://tools.ietf.org/html/rfc4519#section-3.5) LDAP object class. This guide assumes that you:
- - have at least one group defined in OpenProject (See the “[Managing groups](././users-permissions/groups/)” guide for more information on how to create and edit groups),
- have set up your LDAP authentication source (See the “[Manage LDAP authentication](./ldap-authentication/)” guide)
- have at least one LDAP entry with a *groupOfNames* object class and at least one *member* reference to an entry within your base DN of your LDAP authentication source. We use the inverse *memberOf* filter to determine the members of a group entry.
For the sake of simplicity, we assume that in this guide, your LDAP structure looks like the following:
![ldap groups](ldap-groups-1-900x363@2x.png)
You have two groups *cn=groupA,ou=groups,ou=example,ou=com and cn=groupB,ou=groups,ou=example,ou=com* with two and one users, respectively*.* Your base DN is *ou=people,ou=example,ou=com.*
## LDAP group synchronization
LDAP group synchronization augments the memberships defined by administrators in an existing OpenProject group. Important things to note are:
- Only existing groups and users in OpenProject can be synchronized. The functionality will not simply create all entries in the LDAP group base nor will it synchronize users that do not exist in OpenProject.
- Group synchronization have to be enabled by an administrator by creating a *synchronized LDAP group* that ties the OpenProject group to an LDAP entry.
- Only synchronized memberships will be removed from the OpenProject group. If you want to add a user outside your LDAP authentication to an OpenProject group, you can safely do so without the membership being removed.
## Configure synchronized LDAP group
In order to get to the LDAP group sync administration pane, expand the LDAP authentication menu item in your administration.
### Define group base and key settings
In order for the LDAP groups plugin to locate your group entries, you first need to set the *group key* to **cn** (the identifying attribute of the group entries) and *group base* to **ou=groups,ou=example,ou=com** as shown in the following screenshot.
![LDAP group synchronization settings](Bildschirmfoto-2018-02-01-um-16.41.26.png)LDAP group synchronization settings
### Create a synchronized group
To create a new synchronized group, use the button on the top right of the page. There, you will select your LDAP authentication source that contains the group, as well as the existing OpenProject group that members should be synchronized to.
The *entry* *identifier* field corresponds to the value of the group key, e.g. **groupA** for our first exemplary group.
Click on *Create* to finish the creation of the synchronized group. The LDAP memberships of each user will be synchronized hourly through a cron job on your packaged installation. Changes and output will be logged to */var/log/openproject/cron-hourly.log*.

Binary file not shown.

After

Width:  |  Height:  |  Size: 167 KiB

@ -1,18 +1,22 @@
---
sidebar_navigation:
title: Users & Permissions
priority: 999
description: Manage users and permissions.
robots: index, follow
keywords: users, permissions
---
# Users & Permissions
Manage users and permissions in OpenProject.
## Overview
| Popular Topics | Description |
| --------------------- | :---------------------------------------------------- |
| Settings | Configure user settings (e.g. default language). |
| Users | View all users, invite new users, manage users. |
| Groups | View groups, create new groups, add users to groups. |
| Roles and permissions | See / manage roles and permissions and add new roles. |
| Avatars | Activate / deactivate user avatars. |
| | |
| | |
| | |
| | |
| Popular Topics | Description |
| ------------------------------------------ | :----------------------------------------------------------- |
| [Settings](/settings) | Configure user settings, e.g. default language, time zone, and more. |
| [Users](/users) | Manage users: View all users, invite new users, lock users, and more. |
| [Groups](/groups) | View groups, create new groups, add users to groups. |
| [Roles and permissions](roles-permissions) | See / manage roles and permissions and add new roles. |
| [Avatars](/avatars) | Activate / deactivate user avatars (profile pictures) |

@ -0,0 +1,18 @@
---
sidebar_navigation:
title: Avatars
priority: 960
description: Manage Avatars in OpenProject
robots: index, follow
keywords: Avatars
---
# OpenProject Avatars
To select which type of Avatars can be used in your OpenProject, navigate to -> *Administration* -> *Users & Permissions* -> *Avatars*.
You can choose whether to allow user Gravatar or enable to upload custom avatars.
The Avatars can be configured via the [users profile](./users).
![Avatars](image-20200115173409850.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

@ -1,19 +1,43 @@
---
title: Manage groups
description: Manage groups in OpenProject
sidebar_navigation:
title: Groups
priority: 980
description: Manage groups in OpenProject.
robots: index, follow
keywords: manage groups
---
# Manage Groups
XX
OpenProject allows creating tailored project member **groups**, which grants additional rights to individual users within specific projects. This way, you do not need to add individual users to a project but you can add a user group, e.g. Marketing.
You can edit the existing groups and create new ones in the system administration. To do that select *Administration -> Users & Permissions -> *Groups*.
| Feature | Documentation for |
| ------------------------------------------------------------ | ----------------- |
| TODO | |
| | |
| | |
| | |
| | |
## Add a new group
After selecting the *Groups* from the administration menu, you will see the list of all the existing groups. If no groups have been created yet, the list will be empty.
Click the green **+ Group** button in order to create a new group in the system.
![create group](image-20200115164118182.png)
Give a name for your new group and click the blue **Create** button
![new group](image-20200115164328352.png)
## Add users to a group, edit or remove groups
You can add users to a group and edit a group by clicking on the **name of the group** (1) and remove the group by clicking on **delete** icon in the respective line (2).
![Sys-admin-edit-groups](Sys-admin-edit-groups.png)
After selecting the editing mode, you will be able to **adapt the group name**, **add or remove group members** and the **assignment of groups to projects**.
![edit groups](image-20200115164847858.png)
### Add users to a group
Click the group details and click the **Users** tab. Select the users you want to add to this group from the drop-down list. Click the blue **Add** button.
![Sys-admin-add-users-groups](Sys-admin-add-users-groups.gif)

Binary file not shown.

After

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

@ -1,19 +1,43 @@
---
title: Roles and permissions
description: Manage roles and permissions in OpenProject
sidebar_navigation:
title: Roles & Permissions
priority: 970
description: Manage roles and permissions in OpenProject.
robots: index, follow
keywords: roles, permissions
keywords: manage roles, manage permissions
---
# Roles and permissions
XX
A role is a set of permissions that can be assigned to any project member. Multiple roles can be assigned to the same project member.
In contrast to “normal” project roles, **Global roles** are project-overarching roles that can be assigend to a user and allow certain actions (for example, creating new projects).
Global roles can be added to a [user profile](./users/#view-user-profile).
## Create a new role
To create a new role, navigate to the administration and select -> *Users & permissions* -> *Roles and permissions* from the menu on the left.
You will see the list of all the roles that have been created so far.
After clicking the green *+ New Role* button a form will open and you will be able to specify the role.
![Sys-admin-new-roles](Sys-admin-new-roles.png)
You will then be able to specify the following:
1. Role name
2. Define whether the role is a global one and should be applied to a user on a project-overarching level.
3. Define whether work packages can be assigned to the role
4. Copy the workflow from an existing role. In case you select a role from the dropdown list, the respective workflows will be copied (i.e. changing status for work packages)
5. You can specify the permissions per OpenProject module and select the permissions which should apply for this role. You also have the possibility to check all or uncheck all at the right next to a module.
Don’t forget to save the new role at the bottom of the page.
![Sys-admin-create-new-role](Sys-admin-create-new-role.png)
## Edit and remove roles
| Feature | Documentation for |
| ------------------------------------------------------------ | ----------------- |
| TODO | |
| | |
| | |
| | |
| | |
To edit a role navigate to the roles overview list and click on the role name (1). To remove an existing role click on the delete button next to a role in the list (2).
![Sys-admin-edit-roles](Sys-admin-edit-roles.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 196 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

@ -1,9 +1,10 @@
---
title: Manage users
description: Manage users in OpenProject
sidebar_navigation:
title: User settings
priority: 999
description: Configure user settings in OpenProject.
robots: index, follow
keywords: manage users
keywords: user settings
---
# User settings
@ -14,15 +15,11 @@ User settings are accessibly by administrators from the OpenProject administrati
![image-20191104162935680](image-20191104162935680.png)
| Feature | Documentation for |
| ------------------------------------------ | -------------------------- |
| Feature | Documentation for |
| ------------------------------------------- | -------------------------- |
| [Default preferences](#default-preferences) | User default preferences. |
| [User deletion](#user-deletion) | Who can delete users. |
| [User consent](#user-consent) | User privacy and security. |
| | |
| | |
## Default preferences

Binary file not shown.

After

Width:  |  Height:  |  Size: 203 KiB

@ -1,19 +1,145 @@
---
title: Manage users
description: Manage users in OpenProject
sidebar_navigation:
title: Manage users
priority: 990
description: Manage users in OpenProject.
robots: index, follow
keywords: manage users
---
# Manage Users
The users list provides an overview of all users in OpenProject. You can create new users, make changes to existing user accounts of delete users from the users list.
The users list provides an overview of all users in OpenProject. You can create new users, make changes to existing user accounts, block or delete users from the system.
| Feature | Documentation for |
| -------------------------------------------- | ----------------- |
| [User list](#user-list) | Viewing users in |
| [Filter users](#filter-users) | |
| [Invite new users](#invite-new-users) | |
| [Manage user settings](#manage-user-settings) | |
| [Delete users](#delete-users) | |
| Feature | Documentation for |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [User list](#user-list) | Manage all users in OpenProject. |
| [Lock users](#lock-users) | Block a user permanently in the system. |
| [Filter users](#filter-users) | Filter users in the list. |
| [Invite new users](#invite-new-users) | Add new users to your OpenProject and invite them via email. |
| [Send user invitation via email](#resend-user-invitation-via-email) | Send user invitation via email. |
| [Manage user settings](#manage-user-settings) | Manage user settings, e.g. language, projects, groups, global roles, rate history, avatar, two-factor authentication. |
| [Delete users](#delete-users) | Delete a user from the system. |
## User list
You will see the list of all users in your OpenProject with detailed information, such as user name, first name, last name, e-mail address.
You will also see if a user is an Administrator in the system.
Also, you get the information when the user has been created, and when the user had his last login.
![user list](image-20200115153138004.png)
## Lock users
If you want to **block users permanently** in the system, you can click the **Lock permanently** link next to a user.
If you are using the [OpenProject Cloud Edition](././cloud-edition-guide), you will then have a new user available to add to the system within your booked plan.
<div class="alert alert-info" role="alert">
**Note**: The previous activities from this locked users will still be displayed in the system.
</div>
![Admin-guide-lock-users](Admin-guide-lock-users.png)
## Filter users
Especiall if you have a very long user list, it is essential to filter in this list.
At the top of the list, you can choose to filter for all, altive, or locked users.
You can then search for the name or email of a user. Click the blue **Apply** button to filter the list.
![filter users](image-20200115155456033.png)
## Invite new users
To invite new users to your system, click the green **+ User** button at the top right.
![Sys-admin-add-users](Sys-admin-add-users.png)
Enter the Email address, first name, and last name of the new user. Check whether the new user should get system administration rights.
Click the blue **Create** button in order to invite the new user via email.
![new user](image-20200115155855409.png)
The **Create and continue** button will bring you to the form to add another new user.
## Resend user invitation via email
If a user did not receive the email invitation, you can send the invitation to the user again if needed. In the user list, click on the user name to whom you want to resend the email with the invitation link to the system.
In the top right, click the **Send invitation** button in order to send the email once again.
![Sys-admin-resend-invitation](Sys-admin-resend-invitation.png)
## View user profile
If you want to see the user profile, click on the user name in the user list to display the activities accross all projects from a certain user. Click the **Profile** button on the top right of a user.
![Sys-admin-profile](Sys-admin-profile.png)
You will see all the Activities accross all projects from this user, as well as the amount of reported work packages in the system.
![user profile](image-20200115162109669.png)
## Manage user settings
### General settings
You can manage individual user settings if you click on the user name in the list. The settings will overwrite the individual user settings set in the [My Account settings](././getting-started/my-account/).
(1) Change username, first name, last name, email address or language. Activate or deactivate **Administrator** permission.
(2) See user based custom fields.
(3) Display last given [user consent](./settings/#user-consent).
(4) Display **authentication provider**.
(5) Change e-mail **notification** settings.
(6) Set **preferences** for time zone and display of comments.
(7) Do not forget to **Save** your changes.
![Sys-admin-user-settings](Sys-admin-user-settings.png)
### Add users to a project
In order to see and work in a project, a user has to be a member of a project and needs to be added with a certain role to this project.
On the **Projects** tab, select the new project from the drop-down list, choose a **role** for this project and click the blue **Add** button.
![Sys-admin-add-project](Sys-admin-add-project.gif)
### Add users to groups
In order to add a user to a group, at least [one group needs to be created](./groups) in the system.
Select or de-select the groups a user should be a member of. Click the blue **Save** button.
![add users to a group](image-20200115165406439.png)
## Delete users
In order to delete users from the system, open the [user list](#user-list).
Click on the **user name** of the user which you want to delete.
To delete a user permanently from the system, press the **Delete** button at the top right.
![Sys-admin-delete-user](Sys-admin-delete-user.png)
You will then be asked to type in the user's email address in order to delete the user permanently from the system.
![delete user](image-20200115162533470.png)
<div class="alert alert-info" role="alert">
**Note**: Deleting a user account is an irreversible action and cannot easily be restored via the frontend.
</div>

Binary file not shown.

After

Width:  |  Height:  |  Size: 215 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 211 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 172 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 230 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 175 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 146 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

@ -1,7 +1,11 @@
title: Gantt charts
---
sidebar_navigation:
title: Gantt charts
priority: 865
description: Create project timelines with Gantt charts in OpenProject
robots: index, follow
keywords: gantt charts
keywords: gantt chart, timeline, project plan
---
# Gantt charts

@ -20,5 +20,4 @@ asdf
| | |
| | |
| | |
| | |
| | |

@ -0,0 +1,24 @@
---
sidebar_navigation:
title: Work package types
priority:
description: Enable or disable work package types in a project.
robots: index, follow
keywords: work package types
---
# Work package types
Coming soon!
| Feature | Documentation for |
| ------- | ----------------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |

@ -0,0 +1,13 @@
---
sidebar_navigation:
title: Copy, move, delete work packages
priority:
description: How to copy, change project or delete a work package?
robots: index, follow
keywords: copy work package, delete work package, move work package
---
# Copy, change project or delete a work package
Coming soon!

@ -12,7 +12,7 @@ keywords: create work packages
| Feature | Documentation for |
| ------------------------------------------------------------ | ---------------------------------------------- |
| [Create work packages?](#how-to-create-work-packages?) | How to create a new work package in a project? |
| [Add attachments to a work package](#how-to-add-attachments-to-a-work-package?) | How to add attachments to a work package? |
| [Add attachments to a work package](#add-attachments-to-work-packages) | How to add attachments to a work package? |
| | |
| | |
| | |
@ -56,7 +56,7 @@ Click the green **Save** button.
![create-work-package-split-screen](1566303947314.png)
## How to add attachments to a work package?
## Add attachments to work packages
You can directly add images, e.g. via copy and paste to the **work package description**. You can also use the toolbar above the work package description and click the Insert image icon:

@ -1,15 +1,15 @@
---
sidebar_navigation:
title: Work package relations
title: Work package relations and hierarchies
priority: 866
description: How to add or configure work package relations?
robots: index, follow
keywords: work package relations
---
# Work package relations
# Work package relations and hierarchies
You can not only create [work package hierarchies](./work-package-hierarchies), but also define relations, for example to indicate that work packages address a similar topic or create status dependencies. To create a relationship between two work packages:
You can not only create [work package hierarchies](#work-package-hierarchies), but also define relations, for example to indicate that work packages address a similar topic or create status dependencies. To create a relationship between two work packages:
1. Select a work package, click on the **Relations** tab to open the relations tab and click the *+ Create new relations* link.
2. Select the type of relationship from the dropdown menu.
@ -43,4 +43,7 @@ The relations column shows the number of relations each work package has for the
You can click on the number to display the work packages which have the relation type.
![Relations_column](Relations_column.png)
![Relations_column](Relations_column.png)
## Work package hierarchies
Loading…
Cancel
Save