Commit changes to links

pull/7998/head
birthe 5 years ago
parent fd2dd65ca7
commit 164d82fa76
  1. 2
      help/enterprise-edition-guide/activate-enterprise-edition/README.md
  2. 24
      help/system-admin-guide/authentication/README.md
  3. BIN
      help/system-admin-guide/authentication/Sys-admin-authentication-1579787715984.png
  4. BIN
      help/system-admin-guide/authentication/Sys-admin-authentication.png
  5. 59
      help/system-admin-guide/authentication/authentication-settings/README.md
  6. BIN
      help/system-admin-guide/authentication/authentication-settings/Sys-admin-authentication-registration-footer.png
  7. BIN
      help/system-admin-guide/authentication/authentication-settings/Sys-admin-authentication-settings.png
  8. 2
      help/system-admin-guide/authentication/ldap-authentication/ldap-group-synchronization/README.md
  9. 6
      help/system-admin-guide/custom-fields/README.md
  10. 4
      help/system-admin-guide/custom-fields/custom-fields-projects/README.md
  11. 16
      help/system-admin-guide/system-settings/README.md
  12. 3
      help/system-admin-guide/system-settings/display-settings/README.md
  13. 6
      help/system-admin-guide/system-settings/general-settings/README.md
  14. 2
      help/system-admin-guide/system-settings/project-system-settings/README.md
  15. 2
      help/system-admin-guide/users-permissions/users/README.md
  16. 2
      help/user-guide/project-overview/README.md
  17. 24
      help/user-guide/project-settings/custom-fields/README.md

@ -23,7 +23,7 @@ Next, select **Enterprise Edition** from the menu items (3).
Do you already have an Enterprise token?
Yes, then you can proceed entering your token as described below.
No, then you need to [order your Enterprise token](#order-the-enterprise-edition) or [request a trial token](../enterprise-trial) first.
No, then you need to [order your Enterprise token](#order-the-enterprise-edition) or [request a trial token](../../enterprise-trial) first.
In the Enterprise Edition section, copy and paste the full content of your Enterprise support token into the input field and press the blue **Save** button.

@ -8,19 +8,19 @@ keywords: authentication
---
# Authentication
Coming soon!
Configure **authentication** settings and authentication providers in OpenProject. To adapt these authentication settings, navigate to your user name and select -> *Administration* -> *Authentication*.
![Sys-admin-authentication](Sys-admin-authentication-1579787715984.png)
## Overview
| Popular Topics | Description |
| -------------- | :---------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| Popular Topics | Description |
| ------------------------------------------------------------ | :----------------------------------------------------------- |
| [Authentication settings](authentication-settings) | Configure general authentication settings, such as registration, passwords, and more. |
| [OAuth applications](oauth-applications) | How to configure OAuth applications in OpenProject? |
| [OpenID providers](openid-providers) | How to configure OpenID providers in OpenProject? |
| [Two-factor authentication](two-factor-authentication) | Set up and manage two-factor authentication (2FA) in OpenProject. |
| [reCAPTCHA](recaptcha) | How to activate reCAPTCHA in OpenProject? |
| [LDAP authentication](ldap-authentication) | How to set up LDAP authentication in OpenProject? |
| [LDAP group synchronization](ldap-authentication/ldap-group-synchronization) | How to configure LDAP group synchronization in OpenProject (Premium feature)? |

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

@ -0,0 +1,59 @@
---
sidebar_navigation:
title: Settings
priority: 990
description: Authentication settings in OpenProject.
robots: index, follow
keywords: authentication settings
---
# Authentication settings
To adapt general system **authentication settings**, navigate to -> *Administration* -> *Authentication* and choose -> *Settings*.
You can adapt the following under the authentication settings:
## General authentication settings
1. Select if the **authentication is required** to access OpenProject.
2. Select an option for **self-registration**. Self-registration can either be **disabled**, or it can be allowed with the following criteria:
a) **Account activation by email** means the user receives an email and needs to confirm the activation.
b) **Manual account activatio**n means that a system administrator needs to manually activate the newly registered user.
c) **Automatic account activation** means that a newly registered user will automatically be active.
3. Define if the **email address should be used as login** name.
4. Define after how many days the **activation email sent to new users will expire**. Afterwards, you will have the possibility to [re-send the activation email](../../users-permissions/users/#resend-user-invitation-via-email) via the user settings.
![Sys-admin-authentication-settings](Sys-admin-authentication-settings.png)
## Define a registration footer for registration emails
You can define a footer for your registration emails under -> *Administration* -> *Authentication* -> *Settings*.
1. Choose for which **language** you want to define the registration footer.
2. Enter a **text for the registration footer**.
![Sys-admin-authentication-registration-footer](Sys-admin-authentication-registration-footer.png)
1. Define the minimum password length.
2. Select what character classes should be part of the password.
3. Define the minimum number of required character classes.
4. Define the number of days, after which a password change should be enforced.
5. Define the number of the most recently used passwords that a user should not be allowed to reuse.
6. Activate the *Forgot your password.*
7. Define the number of failed login attempts, after which a user will be temporarily blocked.
8. Define the duration of the time, for which the user will be blocked after failed login attempts.
9. Enable or disable the autologin option. This allows a user to remain logged in, even if he/she leaves the site. Is this option is activated, the “Stay signed in” option will appear on the login screen.
10. Activate the session expiration option. If you select this option, an additional field will open, where you will be able to define the inactivity time duration before the session expiry.
11. Log user login, name, and mail address for all requests.
12. Enable REST web service. This activates an API-Interface, which allows communication between external services (for example MS Office) and the instance.
13. Don’t forget to save your changes.

@ -14,7 +14,7 @@ Note: This feature is available for the Enterprise Edition only for OpenProject
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 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:

@ -33,7 +33,7 @@ Depending on the module, for which the new custom field is being created, sligh
4. **Regular expression** specifying which values are allowed for the custom field.
5. Set if the new custom field should be a **required** field.
6. Specify if the new custom field should be **used for all projects**. This means the custom field will be active for all projects and does not need to be activated separately per project.
7. Specify if the new custom field should be **used as a filter for work packages**. See [here](../user-guide/work-packages/work-package-table-configuration/#filter-work-packages) how to filter work packages.
7. Specify if the new custom field should be **used as a filter for work packages**. See [here](../../user-guide/work-packages/work-package-table-configuration/#filter-work-packages) how to filter work packages.
8. Specify if the new custom field should be **searchable** via the global search.
9. **Save** the new custom field.
@ -47,11 +47,11 @@ Depending on the module, for which the new custom field is being created, sligh
2. Custom field is activated for the project.
</div>
1. [Assign a custom field to a work package type](./manage-work-packages/work-package-types/#work-package-form-configuration) (Form configuration). You can do this directly via the link in the custom field overview.
1. [Assign a custom field to a work package type](../manage-work-packages/work-package-types/#work-package-form-configuration) (Form configuration). You can do this directly via the link in the custom field overview.
![Sys-admin-add-custom-field](Sys-admin-add-custom-field.png)
2. Activate the custom field in a project [through the project settings](../user-guide/project-settings/custom-fields/). This is not relevant if the setting **For all projects** has been configured for the custom field.
2. Activate the custom field for a project in the [project settings](../../user-guide/project-settings/custom-fields/). This is not relevant if the setting **For all projects** has been configured for the custom field.
With these additional settings, you have absolute freedom which custom fields are relevant for your projects and types. You can customize only those types that are relevant and create a whole set of custom attributes for your work packages.

@ -21,7 +21,7 @@ Click on the link **Create a new custom field** to create a project custom field
2. Choose a **format** (e.g. List) for the custom field, e.g. list.
3. **Enter the possible values** which can be selected (for a list). This is not relevant if you choose e.g. Text format.
4. Define if the custom field should be **required**.
5. If you check **visible** it will also be visible for all users (non Admins) in the project overview and displayed in the project details widget on the [Project Overview](../user-guide/project-overview/).
5. If you check **visible** it will also be visible for all users (non Admins) in the project overview and displayed in the project details widget on the [Project Overview](../../../user-guide/project-overview/).
6. Define if the custom field for projects should be **searchable**.
7. Click **Save** to create the custom field.
@ -29,7 +29,7 @@ Click on the link **Create a new custom field** to create a project custom field
## Setting and displaying a project custom field
Once you created the custom field you can set it in the [project’s settings](../user-guide/project-settings/).
Once you created the custom field you can set it in the [project settings](../../../user-guide/project-settings/).
To do this navigate to a project and select *Project settings* from the side menu. The project custom field is visible under *Information*. As a project manager you can set the project custom field.

@ -14,12 +14,12 @@ There are various project overarching settings that are referred to as **system
## Overview
| Popular Topics | Description |
| ---------------------------------------------------- | :----------------------------------------------------------- |
| [General settings](/general-settings) | How to configure general system settings, e.g. a welcome text block on the application landing page, attachment size, and much more? |
| [Display settings](/display-settings) | How to configure languages, date and time formats, week start, and more? |
| [System projects settings](/project-system-settings) | How to set default project modules and more? |
| [Email notifications](/email-notifications) | How to configure email notifications and your email provider? |
| [Incoming emails](/incoming-emails) | How to set up incoming emails? |
| [Repositories](/repositories) | How to integrate SVN or GIT repositories? |
| Popular Topics | Description |
| --------------------------------------------------- | :----------------------------------------------------------- |
| [General settings](general-settings) | How to configure general system settings, e.g. a welcome text block on the application landing page, attachment size, and much more? |
| [Display settings](display-settings) | How to configure languages, date and time formats, week start, and more? |
| [System projects settings](project-system-settings) | How to set default project modules and more? |
| [Email notifications](email-notifications) | How to configure email notifications and your email provider? |
| [Incoming emails](incoming-emails) | How to set up incoming emails? |
| [Repositories](repositories) | How to integrate SVN or GIT repositories? |

@ -17,7 +17,8 @@ Choose the languages which you want to activate for your system. Those languages
![available languages](image-20200123100856639.png)
At the moment there are more than 30 languages available.
**Note**: Many languages are translated by the Community. We highly appreciate if you want to [help translating OpenProject to your language](../development/translate-openproject).
<div>
**Note**: Many languages are translated by the Community. We highly appreciate if you want to [help translating OpenProject to your language](../../../development/translate-openproject).
</div>
## Time and date formatting

@ -10,13 +10,13 @@ keywords: general settings
You can configure general system settings in OpenProject. Under System settings on the tab **General** you can configure the following options.
1. **Application title**: This title will be displayed on the [application start page](../user-guide/start-page).
1. **Application title**: This title will be displayed on the [application start page](../../../user-guide/start-page).
2. **Attachment maximum size** defines the maximum size of an attachment (for example in a work package).
3. **Object per page options** define the options of how many objects (for example work packages or news entries) you can have displayed on one page. This is used for the pagination in the work package list. You can enter several values, separated by coma. Please note that the higher value you set, the more work packages will be initially loaded and therefore it might take longer time to load a work package page.
4. **Days displayed on project activity** determines how far back the project activities will be traced and displayed in the project's [Activity](../user-guide/activity).
4. **Days displayed on project activity** determines how far back the project activities will be traced and displayed in the project's [Activity](../../../user-guide/activity).
5. **Host name**.
@ -34,7 +34,7 @@ You can configure general system settings in OpenProject. Under System settings
12. **Max number of diff lines displayed** defines the maximum number of lines displayed when comparing (diff) two versions in a repository.
13. **Display security badge** enables to display a badge with your installation status in the [Information administration panel](./information), and on the [start page](../user-guide/start-page). It is displayed to administrators only.
13. **Display security badge** enables to display a badge with your installation status in the [Information administration panel](../../information), and on the [start page](../user-guide/start-page). It is displayed to administrators only.
The badge will check your current OpenProject version against the official OpenProject release database to alert you of any updates or known vulnerabilities. For more information on what the check provides, what data is needed to provide available updates, and how to disable this check, please visit [the configuration documentation](https://github.com/opf/openproject/blob/dev/docs/configuration/configuration.md#security-badge).

@ -13,7 +13,7 @@ To adapt system project settings, go to System settings on the tab **Projects**
1. Check if **new projects are public by default**. This means that users without an account can access the project without login.
2. Select **which modules should be activated for newly created projects per default**.
3. Choose whether **sequential project identifiers should be created**. If this option is activated, a project identifier for the next project will be offered automatically, based on the existing project name. For example, if a project “Myproject1” was created, “Myproject2” will be offered as identifier for the next project.
4. The r**ole given to a user in a new project when the user created a new project but is not an admin**. This makes sense when a user receives the permission to create a new project via [global role](./users-permissions/roles-permissions/).
4. The r**ole given to a user in a new project when the user created a new project but is not an admin**. This makes sense when a user receives the permission to create a new project via [global role](../../users-permissions/roles-permissions/).
5. Do not forget to **save** your changes.
![Sys-admin-project-system-settings](Sys-admin-project-system-settings.png)

@ -35,7 +35,7 @@ Also, you get the information when the user has been created, and when the user
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.
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.

@ -95,7 +95,7 @@ The description can be added or changed in the [project settings](../projects/).
The project details widget displays all custom fields for projects, e.g. project owner, project due date, project number, or any other custom field for this project.
The custom fields can be adapted in the [project settings](./project-settings/). As a system administrator you can [create new custom fields for projects](../system-admin-guide/custom-fields/projects-custom-fields/).
The custom fields can be adapted in the [project settings](../project-settings/). As a system administrator you can [create new custom fields for projects](../../system-admin-guide/custom-fields/custom-fields-projects/).
![project details widget](image-20191112144557906.png)

@ -0,0 +1,24 @@
---
sidebar_navigation:
title: Custom fields
priority:
description: Manage custom fields in a project.
robots: index, follow
keywords: custom fields
---
# Manage custom fields in projects
Coming soon!
| Feature | Documentation for |
| ------- | ----------------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
Loading…
Cancel
Save