OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openproject/docs/system-admin-guide/authentication/authentication-settings/README.md

67 lines
3.7 KiB

---
sidebar_navigation:
title: Settings
priority: 990
description: Authentication settings in OpenProject.
robots: index, follow
keywords: authentication settings
---
# Authentication settings
Expanding documentation (#9091) * changed screenshots for projects chapter * changed screenshots in gantt chart chapter * moved "aggregation by project" from work packages to Gantt chart chapter * changed some links * move reference to Excel sync out of Gantt chart chapter * small changes * add initial setup section for administrators to documentation Idea and main content from @ivangriggs Co-Authored-By: ivangriggs <77022874+ivangriggs@users.noreply.github.com> * smaller improvements to docs * improve documentation of manual and automatic scheduling mode * small improvements in docs * small changes * adding section for search options in OpenProject * move section about hourly rate defintion to system admin guide * formatting changes * explaining assignee filter options * change section header to make it detectable when searching for "projects overview" * clean up table of contents, make titles consistent, remove excessive space characters, etc. * update screenshots * changes to project overview docs * add screenshot for search bar * make info about aggregation of changes in activity and notifications easier detectable * small improvements * add info about non member and anonymous role * changes/additions * small changes * add additional options to access context menu * add sum feature for work package list to docs and change screenshot * add/improve info about email notifications * link fixes (necessary due to structural changes in documentation) * working in review comments * changes for time tracking activities * change screen shots for wiki - more functions section * change screenshots and improve description for meetings * improve detectability of mention feature * move FAQ in authentication * add how to reset password * improve explanation on how to un-archive projects * mention Mattermost integration * small correction
4 years ago
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. **Watch out**: If you un-tick this box your OpenProject instance will be visible to the general public without logging in. The visibility of individual projects depends on [this setting](../../../user-guide/projects/#set-a-project-to-public).
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)
## 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.
![Sys-admin-authentication-passwords](Sys-admin-authentication-passwords-1579791010597.png)
## 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.
![Sys-admin-authentication-other-settings](Sys-admin-authentication-other-settings.png)