Henriette Dinger
5 years ago
commit
1553fdd1ca
@ -0,0 +1,9 @@ |
||||
class FixParentIdForWikiPages < ActiveRecord::Migration[6.0] |
||||
class MyWikiPages < ActiveRecord::Base |
||||
self.table_name = "wiki_pages" |
||||
end |
||||
|
||||
def up |
||||
MyWikiPages.where(parent_id: 0).update_all(parent_id: nil) |
||||
end |
||||
end |
||||
|
After Width: | Height: | Size: 144 KiB |
|
After Width: | Height: | Size: 553 KiB |
|
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. |
||||
|
||||
 |
||||
|
||||
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. |
||||
|
||||
 |
||||
|
||||
Next, click the **Proceed to Checkout button**. |
||||
|
||||
 |
||||
|
||||
Verify your **account details** and click the blue Next button. |
||||
|
||||
 |
||||
|
||||
Add your **Billing address and VAT number** and click the blue **Next** button. |
||||
|
||||
 |
||||
|
||||
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. |
||||
|
||||
 |
||||
|
||||
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 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. |
||||
|
||||
 |
||||
|
||||
You will get an overview of your booked subscription. |
||||
|
||||
An invoice will be sent via email to the Billing email. |
||||
|
||||
 |
||||
|
After Width: | Height: | Size: 38 KiB |
|
After Width: | Height: | Size: 25 KiB |
|
After Width: | Height: | Size: 33 KiB |
|
After Width: | Height: | Size: 55 KiB |
|
After Width: | Height: | Size: 61 KiB |
|
After Width: | Height: | Size: 58 KiB |
|
After Width: | Height: | Size: 17 KiB |
|
After Width: | Height: | Size: 81 KiB |
|
After Width: | Height: | Size: 112 KiB |
|
After Width: | Height: | Size: 184 KiB |
|
After Width: | Height: | Size: 123 KiB |
|
After Width: | Height: | Size: 140 KiB |
@ -0,0 +1,43 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Invoices and billing history |
||||
priority: 997 |
||||
description: View the invoices and payment history. |
||||
robots: index, follow |
||||
keywords: invoices, payment history |
||||
--- |
||||
|
||||
# Invoices for the OpenProject Cloud Edition |
||||
|
||||
You will **receive an invoice for your OpenProject Cloud Edition via email** to the email address which you used during the booking process. |
||||
|
||||
The invoice lists the subscription (billing) period as well as the next billing date. |
||||
|
||||
You will also see the payment status. |
||||
For invoices via bank transfer, the money needs to be paid via bank transfer to the bank account listed at the bottom of the invoice. |
||||
|
||||
<div class="alert alert-info" role="alert"> |
||||
**Note**: For the correct assignment of payments, please enter the invoice number on your bank transfer. |
||||
</div> |
||||
|
||||
 |
||||
|
||||
## Payment history and download invoices |
||||
|
||||
If you want to see the billing history or download older invoices of your Cloud Edition, navigate to -> *Administration* -> *Billing* within your system's Administration. |
||||
|
||||
Click the green **Manage button** at the top right. |
||||
|
||||
 |
||||
|
||||
In the overlay window, click on the link **Billing History**. |
||||
|
||||
 |
||||
|
||||
Here, you will get an overview about all your past payments for the Cloud Edition. |
||||
|
||||
With the **Download link** you can download the inovices. |
||||
|
||||
The **Load more link** will open more positions on the list. |
||||
|
||||
 |
||||
|
After Width: | Height: | Size: 282 KiB |
|
After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 33 KiB |
|
After Width: | Height: | Size: 51 KiB |
|
After Width: | Height: | Size: 90 KiB |
|
After Width: | Height: | Size: 112 KiB |
|
After Width: | Height: | Size: 184 KiB |
|
After Width: | Height: | Size: 123 KiB |
|
After Width: | Height: | Size: 140 KiB |
@ -0,0 +1,63 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Manage subscription |
||||
priority: 996 |
||||
description: View the invoices and payment history. |
||||
robots: index, follow |
||||
keywords: manage subscription |
||||
--- |
||||
|
||||
# Manage your OpenProject Cloud subscription |
||||
|
||||
If you want to make changes to your subscription (Up- or downgrade, cancel), navigate to -> *Administration* -> *Billing* within your system's Administration. |
||||
|
||||
Click the green **Manage button**. |
||||
|
||||
 |
||||
|
||||
In the overlay window, you can choose between several topics: |
||||
|
||||
| Popular Topics | Description | |
||||
| ------------------------------------------------------------ | :----------------------------------------------------- | |
||||
| [Upgrade, downgrade or cancel](#update-existing-subscriptions) | How to upgrade, downgrade or cancel a subscription? | |
||||
| Edit Account information | | |
||||
| Edit Billing Addresses | | |
||||
| Edit or add payment methods | | |
||||
| Edit or add payment methods | | |
||||
| [View billing history and dowload invoices](./invoices-and-billing-history) | How to view the billing history and download invoices? | |
||||
|
||||
## Update existing subscriptions |
||||
|
||||
If you want to up- or downgrade the amount of users of an existing subscription, click on the subscription listed at the top. |
||||
|
||||
 |
||||
|
||||
Here you can either **Edit or Cancel the existing subscription**. |
||||
|
||||
### Upgrade or downgrade subscription |
||||
|
||||
You can **upgrade an existing subscription** at any time. Open the [Manage subscription menu](#manage-your-subscription). Additional users will be billed on a prorated basis, this means you will only pay the amount of additional users until the end of the current subscription period. |
||||
|
||||
You can **downgrade a subscription** to the end of a current subscription period. This means the downgrade becomes active with the next payment term. |
||||
|
||||
Click the **Edit Subscription** link. |
||||
|
||||
 |
||||
|
||||
You can choose the new amount of users. Your next payment will be displayed below. |
||||
|
||||
Click the blue **Update your subscription now button** to save the changes. |
||||
|
||||
 |
||||
|
||||
### Cancel subscription |
||||
|
||||
To cancel your subscription, open the [Manage subscription](#manage-your-openproject-cloud-subscription) form and click to [update the subscription](#update-existing-subscriptions) you want to cancel. |
||||
|
||||
Click on the **Cancel Subscription link** if you want to terminate your OpenProject Cloud Edition subscription. |
||||
|
||||
 |
||||
|
||||
<div class="alert alert-info" role="alert"> |
||||
**Note**: After cancellation you will receive an email confirmation. Your subscription will be terminated at the end of the current subscription period. After cancellation your data will be kept for a certain period of time in case of reactivation of a subscription. |
||||
</div> |
||||
|
After Width: | Height: | Size: 282 KiB |
|
After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 33 KiB |
|
After Width: | Height: | Size: 108 KiB |
@ -0,0 +1,27 @@ |
||||
--- |
||||
title: OpenProject 10.3.1 |
||||
sidebar_navigation: |
||||
title: 10.3.1 |
||||
release_version: 10.3.1 |
||||
release_date: 2020-01-15 |
||||
--- |
||||
|
||||
# OpenProject 10.3.1 |
||||
|
||||
We released [OpenProject 10.3.1](https://community.openproject.com/versions/1409). |
||||
The release contains several bug fixes and we recommend updating to the newest version. |
||||
|
||||
<!--more--> |
||||
#### Bug fixes and changes |
||||
|
||||
- Fixed: Activity numbers only partly shown on mobile \[[#31892](https://community.openproject.com/wp/31892)\] |
||||
- Fixed: Text in custom field not correctly displayed \[[#31896](https://community.openproject.com/wp/31896)\] |
||||
- Fixed: New Wiki pages are not shown \[[#31907](https://community.openproject.com/wp/31907)\] |
||||
- Fixed: Date separator (dash) misplaced \[[#31926](https://community.openproject.com/wp/31926)\] |
||||
|
||||
#### Contributions |
||||
A big thanks to community members for reporting bugs and helping us identifying and providing fixes. |
||||
|
||||
Special thanks for reporting and finding bugs go to |
||||
|
||||
Christian Dubois, Stefano Stucchi |
||||
@ -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. |
||||
|
||||
 |
||||
|
||||
## 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. | |
||||
|
||||
|
||||
|
After Width: | Height: | Size: 217 KiB |
|
After Width: | Height: | Size: 217 KiB |
@ -0,0 +1,18 @@ |
||||
# Authentication |
||||
|
||||
Coming soon! |
||||
|
||||
## Overview |
||||
|
||||
| Popular Topics | Description | |
||||
| -------------- | :---------- | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
|
||||
|
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. |
||||
|
||||
 |
||||
|
||||
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. |
||||
|
||||
 |
||||
|
||||
- **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. |
||||
|
||||
 |
||||
|
||||
|
||||
|
||||
With the [OpenProject Enterprise Edition](https://www.openproject.org/enterprise-edition/) it is possible to [synchronize LDAP and OpenProject groups](./ldap-group-synchronization). |
||||
|
After Width: | Height: | Size: 25 KiB |
|
After Width: | Height: | Size: 11 KiB |
|
After Width: | Height: | Size: 70 KiB |
|
After Width: | Height: | Size: 95 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: |
||||
|
||||
 |
||||
|
||||
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 |
||||
|
||||
|
||||
|
||||
### 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*. |
||||
|
After Width: | Height: | Size: 58 KiB |
|
After Width: | Height: | Size: 167 KiB |
@ -1,19 +1,23 @@ |
||||
--- |
||||
title: Configure Work Package Types |
||||
description: Configure Work Package Types in OpenProject |
||||
sidebar_navigation: |
||||
title: Manage work packages |
||||
priority: 980 |
||||
description: Manage work packages in OpenProject. |
||||
robots: index, follow |
||||
keywords: work package types |
||||
keywords: manage work packages |
||||
--- |
||||
# Manage work packages |
||||
|
||||
# Configure Work Package Types |
||||
Manage work packages in OpenProject. |
||||
|
||||
XX |
||||
## Overview |
||||
|
||||
| Feature | Documentation for | |
||||
| ------------------------------------------------------------ | ----------------- | |
||||
| TODO | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| Popular Topics | Description | |
||||
| -------------------------------------------- | :----------------------------------------------------------- | |
||||
| [Settings](work-package-settings) | Configure general work package settings and defaults, such as display options and more. | |
||||
| [Types](work-package-types) | Create and manage work package types. | |
||||
| [Status](work-package-status) | Create and manage work package status. | |
||||
| [Workflows](work-package-workflows) | Create and manage workflows for work packages in OpenProject. | |
||||
| [Custom actions](custom-actions) | Create custom actions for work packages (Premium feature) | |
||||
| [Attribute help texts](attribute-help-texts) | Create and manage attribute help texts in OpenProject (Premium feature) | |
||||
|
||||
|
||||
@ -0,0 +1,37 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Settings |
||||
priority: 999 |
||||
description: Work package settings in OpenProject. |
||||
robots: index, follow |
||||
keywords: work package settings |
||||
--- |
||||
# Work package settings |
||||
|
||||
To change basic settings for work package tracking in OpenProject, navigate to the -> *Administration* -> *Work packages* -> *Settings*. |
||||
|
||||
 |
||||
|
||||
You can adapt the following under settings: |
||||
|
||||
1. **Allow cross-project work package relations**, i.e. that work packages created in one project can have relations to work packages in another project, for example parent-children work packages. |
||||
|
||||
2. **Allow assignment of work packages to groups**. See [here](./users-permissions/groups) how to manage groups. |
||||
|
||||
3. **Display subprojects work packages in main projects** by default. This way the work packages of subprojects will always be visible in the main project if a user has the corresponding role in the subproject to see work packages. |
||||
|
||||
4. **Use current date as start date for new work packages**. This way the current date will always be set as a start date if your create new work packages. Also, if you copy projects, the new work packages will get the current date as start date. |
||||
|
||||
5. **Calculate the work package done ratio with** ... defines how the **Progress %** field is calculated for work packages. If you choose “disable”, the filed will not be shown. If you select “Use the work package field”, the Progress % field can be manually set in 10% steps directly in the work package attribute. If you opt for „Use the work package status“, the Progress % field is chosen based on the status of a work package. In this case a % done value is assigned to every [status](./work-package-status) (for example, “tested” is assigned 80%), which is then adapted if the status changes. |
||||
|
||||
6. **Work package export limit**. This setting defines how many work packages you can export at the same time, for example in the the work package lists. |
||||
|
||||
7. **Default highlighting mode** (premium feature) defines which should be the default [attribute highlighting](./././user-guide/work-packages/work-package-table-configuration/#attribute-highlighting-premium-feature) mode, e.g. to highlight the following criteria in the work package table. This setting is only available for Enterprise and Cloud Edition customers. |
||||
|
||||
 |
||||
|
||||
8. Customize the appearance of the work package lists to **define which work package properties are displayed in the work package lists by default** and for which properties sums are displayed. |
||||
|
||||
Do not forget to save your changes with the blue **Save** button at the bottom. |
||||
|
||||
 |
||||
|
After Width: | Height: | Size: 213 KiB |
|
After Width: | Height: | Size: 77 KiB |
|
After Width: | Height: | Size: 26 KiB |
|
After Width: | Height: | Size: 190 KiB |
|
After Width: | Height: | Size: 216 KiB |
|
After Width: | Height: | Size: 150 KiB |
|
After Width: | Height: | Size: 228 KiB |
|
After Width: | Height: | Size: 184 KiB |
|
After Width: | Height: | Size: 174 KiB |
|
After Width: | Height: | Size: 98 KiB |
|
After Width: | Height: | Size: 98 KiB |
|
After Width: | Height: | Size: 828 B |
|
After Width: | Height: | Size: 151 KiB |
|
After Width: | Height: | Size: 53 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). |
||||
|
||||
 |
||||
|
||||
|
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. |
||||
|
||||
 |
||||
|
||||
Give a name for your new group and click the blue **Create** button |
||||
|
||||
 |
||||
|
||||
## 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). |
||||
|
||||
 |
||||
|
||||
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**. |
||||
|
||||
 |
||||
|
||||
### 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. |
||||
|
||||
|
||||
|
||||
 |
||||
|
After Width: | Height: | Size: 144 KiB |
|
After Width: | Height: | Size: 41 KiB |
|
After Width: | Height: | Size: 68 KiB |
|
After Width: | Height: | Size: 68 KiB |
|
After Width: | Height: | Size: 13 KiB |
|
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. |
||||
|
||||
 |
||||
|
||||
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. |
||||
|
||||
 |
||||
|
||||
## 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). |
||||
|
||||
 |
||||
|
After Width: | Height: | Size: 196 KiB |
|
After Width: | Height: | Size: 30 KiB |
|
After Width: | Height: | Size: 86 KiB |
|
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. |
||||
|
||||
 |
||||
|
||||
## 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> |
||||
|
||||
 |
||||
|
||||
## 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. |
||||
|
||||
 |
||||
|
||||
## Invite new users |
||||
|
||||
To invite new users to your system, click the green **+ User** button at the top right. |
||||
|
||||
 |
||||
|
||||
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. |
||||
|
||||
 |
||||
|
||||
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. |
||||
|
||||
 |
||||
|
||||
## 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. |
||||
|
||||
 |
||||
|
||||
|
||||
|
||||
You will see all the Activities accross all projects from this user, as well as the amount of reported work packages in the system. |
||||
|
||||
 |
||||
|
||||
## 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. |
||||
|
||||
 |
||||
|
||||
### 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. |
||||
|
||||
 |
||||
|
||||
### 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. |
||||
|
||||
 |
||||
|
||||
|
||||
|
||||
## 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. |
||||
|
||||
 |
||||
|
||||
You will then be asked to type in the user's email address in order to delete the user permanently from the system. |
||||
|
||||
 |
||||
|
||||
<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> |
||||
|
After Width: | Height: | Size: 215 KiB |
|
After Width: | Height: | Size: 211 KiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue