Henriette Dinger
5 years ago
|
After Width: | Height: | Size: 169 KiB |
|
After Width: | Height: | Size: 280 KiB |
|
After Width: | Height: | Size: 171 KiB |
|
After Width: | Height: | Size: 114 KiB |
|
After Width: | Height: | Size: 137 KiB |
|
After Width: | Height: | Size: 142 KiB |
|
After Width: | Height: | Size: 142 KiB |
@ -0,0 +1,67 @@ |
||||
--- |
||||
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. |
||||
|
||||
 |
||||
|
||||
## 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**. |
||||
|
||||
 |
||||
|
||||
## Configure password settings |
||||
|
||||
You can change various settings to configure password preferences in OpenProject. |
||||
|
||||
1. Define the **minimum password length**. |
||||
2. Define the password strength and select what **character classes are a mandatory 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.** This way a user will be able to reset the own password via email. |
||||
|
||||
 |
||||
|
||||
## Other authentication settings |
||||
|
||||
There can be defined a number of other authentication settings. |
||||
|
||||
1. Define the number of failed **login attempts, after which a user will be temporarily blocked**. |
||||
2. Define the **duration of the time, for which the user will be blocked after failed login attempts**. |
||||
3. Enable or disable the **autologin option**. This allows a user to remain logged in, even if he/she leaves the site. If this option is activated, the “Stay signed in” option will appear on the login screen to be selected. |
||||
4. 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**. |
||||
5. Define to **log user login, name, and mail address for all requests**. |
||||
6. **Enable REST web service**. This activates an API-Interface, which allows communication between external services (for example MS Office) and the instance. |
||||
7. Do not forget to **save** your changes. |
||||
|
||||
 |
||||
|
After Width: | Height: | Size: 213 KiB |
|
After Width: | Height: | Size: 219 KiB |
|
After Width: | Height: | Size: 219 KiB |
|
After Width: | Height: | Size: 42 KiB |
|
After Width: | Height: | Size: 100 KiB |
@ -0,0 +1,29 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: OAuth applications |
||||
priority: 900 |
||||
description: OAuth application settings in OpenProject. |
||||
robots: index, follow |
||||
keywords: OAuth application settings |
||||
--- |
||||
# OAuth applications |
||||
|
||||
To activate and configure oauth applications, navigate to -> *Administration* -> *Authentication* and choose -> *Oauth applications*. |
||||
|
||||
## Add a new authentication application for oauth |
||||
|
||||
To add a new oauth application, click the green **+ Add** button. |
||||
|
||||
 |
||||
|
||||
|
||||
|
||||
You can configure the following options to add your oauth application. |
||||
|
||||
1. Enter the **name** of your oauth application. |
||||
2. **Define redirect URLs** where authorized users can be redirected to. |
||||
3. Check if the application will be used **confidentially**. |
||||
4. Choose **client credential flows** and define a user on whose behalf requests will be performed. |
||||
5. Press the blue **Create** button to add your oauth application. |
||||
|
||||
 |
||||
|
After Width: | Height: | Size: 291 KiB |
|
After Width: | Height: | Size: 213 KiB |
|
After Width: | Height: | Size: 219 KiB |
|
After Width: | Height: | Size: 219 KiB |
|
After Width: | Height: | Size: 42 KiB |
|
After Width: | Height: | Size: 100 KiB |
|
After Width: | Height: | Size: 98 KiB |
@ -0,0 +1,31 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: OpenID providers |
||||
priority: 800 |
||||
description: OpenID providers for OpenProject. |
||||
robots: index, follow |
||||
keywords: OpenID providers |
||||
--- |
||||
# OpenID providers |
||||
|
||||
<div class="alert alert-info" role="alert"> |
||||
**Note**: For the OpenID configuration view our docs in Github: https://github.com/opf/openproject/blob/dev/docs/configuration/openid.md (Todo: needs to be moved to documentation). |
||||
</div> |
||||
|
||||
To activate and configure OpenID providers in OpenProject, navigate to -> *Administration* -> *Authentication* and choose -> *OpenID providers*. |
||||
|
||||
## Add a new authentication application for oauth |
||||
|
||||
To add a new OpenID provider, click the green **+ OpenID provider** button. |
||||
|
||||
 |
||||
|
||||
You can configure the following options. |
||||
|
||||
1. Choose **Google** or **Azure** to add as an OpenID provider to OpenProject. |
||||
2. Optionally enter a **display name**. |
||||
3. Enter the **Identifier**. |
||||
4. Enter the **Secret**. |
||||
5. Press the blue **create** button. |
||||
|
||||
 |
||||
|
After Width: | Height: | Size: 118 KiB |
|
After Width: | Height: | Size: 80 KiB |
@ -0,0 +1,22 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: reCAPTCHA |
||||
priority: 600 |
||||
description: configure reCAPTCHA for OpenProject. |
||||
robots: index, follow |
||||
keywords: reCAPTCHA |
||||
--- |
||||
# reCAPTCHA configuration |
||||
|
||||
To activate and **configure reCAPTCHA** for OpenProject, navigate to -> *Administration* -> *Authentication* and choose -> reCAPTCHA. |
||||
|
||||
If enabled, a captcha form will be rendered upon login for all users that have not verified a captcha yet. Please see the following link for more details on reCAPTCHA and their versions, and how to create the website and secret keys: https://www.google.com/recaptcha. |
||||
|
||||
You can configure the following options: |
||||
|
||||
1. Activate reCAPTCHA for OpenProject. You can choose between reCAPTCHA v2 and reCAPTCHA v3. |
||||
2. Insert the **website key**. |
||||
3. Insert the **secret key**. |
||||
4. Press the blue **Apply** button to save your changes. |
||||
|
||||
 |
||||
|
After Width: | Height: | Size: 118 KiB |
|
After Width: | Height: | Size: 80 KiB |
|
After Width: | Height: | Size: 197 KiB |
|
After Width: | Height: | Size: 171 KiB |
@ -0,0 +1,19 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Two-factor authentication |
||||
priority: 700 |
||||
description: configure two-factor authentication for OpenProject. |
||||
robots: index, follow |
||||
keywords: two-factor authentication |
||||
--- |
||||
# Two-factor authentication (Premium feature) |
||||
|
||||
To activate and **configure two-factor authentication** for OpenProject, navigate to -> *Administration* -> *Authentication* and choose -> *two-factor authentication*. |
||||
|
||||
You can configure the following options: |
||||
|
||||
1. **Enforce two-factor authentication (2FA) for the whole system**. All users will be forced to [register a 2FA device](../../../getting-started/my-account/#two-factor-authentication-premium-feature) on their next login. |
||||
2. **Remember 2FA login for a given number of days**, e.g. 30 days. |
||||
3. Press the blue **Apply** button to save your changes. |
||||
|
||||
 |
||||
|
After Width: | Height: | Size: 118 KiB |
|
After Width: | Height: | Size: 80 KiB |
|
After Width: | Height: | Size: 171 KiB |
|
After Width: | Height: | Size: 68 KiB |
|
After Width: | Height: | Size: 194 KiB |
|
After Width: | Height: | Size: 114 KiB |
|
After Width: | Height: | Size: 117 KiB |
|
After Width: | Height: | Size: 223 KiB |
@ -0,0 +1,20 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Incoming emails |
||||
priority: 600 |
||||
description: Configure incoming email in OpenProject. |
||||
robots: index, follow |
||||
keywords: incoming email |
||||
--- |
||||
# Incoming emails settings |
||||
|
||||
To adapt incoming email settings, go to System settings on the tab **Incoming emails** you can configure the following options. |
||||
|
||||
1. **Define after which lines an email should be truncated**. This setting allows shortening email after the entered lines. |
||||
2. Specify a **regular expression** to truncate emails. |
||||
3. **Ignore mail attachment** of the specified names in this list. |
||||
4. Do not forget to **save** the changes. |
||||
|
||||
 |
||||
|
||||
**To set up incoming email**, please visit our [Operations guide](../../../installation-and-operations/operation/#). (To Do: Migrate incoming email guide from: https://www.openproject.org/operations/configuration/incoming-emails/) |
||||
|
After Width: | Height: | Size: 117 KiB |
|
After Width: | Height: | Size: 117 KiB |
|
After Width: | Height: | Size: 193 KiB |
@ -0,0 +1,49 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Repositories settings |
||||
priority: 500 |
||||
description: Repositories settings in OpenProject. |
||||
robots: index, follow |
||||
keywords: repository settings |
||||
--- |
||||
# Repositories settings |
||||
|
||||
To adapt repositories settings, go to System settings on the tab **Repositories** you can configure the following options. |
||||
|
||||
1. **Autofetch repository changes**. This option allows to automatically show commits in an OpenProject Repository. |
||||
2. **Repository disk size cache**. In order to cache the repository disk size (displayed e.g. in repository page). |
||||
3. **Enable repository management web service**. This option allows communication with SVN- or Git-Clients. If it is deactivated, a repository cannot be created. |
||||
4. **Define an API key**. This API key is created once and used for communication with an SVN or Git client. |
||||
5. Select which **SCM** you want to enabled. You can choose **Git** and/or **Subversion**. |
||||
6. **Automatic repository vendor type**. Specify the default repository type which is used in new projects. |
||||
7. **Define repositories encodings**. |
||||
8. Define the **maximum number of revisions to be displayed on file log**. |
||||
9. Define the **maximum number of files displayed in the repository browser**. |
||||
10. **Enable caching for authentication request of version control software**. This option allows saving the authentication so that a user doesn’t have to authenticate every time a repository is accessed (for example during commits). |
||||
|
||||
1.  |
||||
|
||||
|
||||
|
||||
## Checkout instructions for Subversion and GIT |
||||
|
||||
Show checkout instructions for Subversion and GIT. |
||||
|
||||
1. Select whether or not to **display checkout instructions** on the repository page. |
||||
2. **Checkout base URL**. Define the base URL to be used for repositories of new projects. |
||||
3. **Checkout instruction text**. Used to specify an (optional) instruction text for repositories (can be further specified in project settings). |
||||
|
||||
 |
||||
|
||||
## Referencing and fixing work packages in commit messages |
||||
|
||||
1. **Define referencing keywords** for work packages in commit messages. Used to reference keywords used to link revisions to work packages. |
||||
2. Define **fixing keywords for work packages** in commit messages. Fixing keywords allow status or progress changes using certain keywords in commit messages, e.g. changing a work pacakge to closed and set to 100%. |
||||
3. Define which **status will be applied** to a work package if a fixing word is used in a commit message. |
||||
4. Define which **percentage of done is applied** to a work package if a fixing word is used in a commit message for that work package. |
||||
5. **Enable time logging**. Activating this option enables [logging time to a work package ](../../../user-guide/time-and-costs/time-tracking/)via commit message. |
||||
6. Define **activity for logged time**. This activity is used for time logging via a commit. |
||||
|
||||
 |
||||
|
||||
7. Do not forger to **Save** all your changes. |
||||
|
After Width: | Height: | Size: 341 KiB |
|
After Width: | Height: | Size: 126 KiB |
|
After Width: | Height: | Size: 329 KiB |
@ -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 | |
||||
| ------- | ----------------- | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
|
||||