Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 29 additions & 32 deletions docs/administrator-manual/installation/user_domains.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,42 +192,29 @@ After editing the password policy, you can click on **Edit password policy** but

### Password expiration warning {#password-warning}

The system can send email notifications to users when their password is about to expire.
The system can send email notifications to users when their password is about to expire. This feature is available **only for internal user domains** and is configured separately for user domain.

This feature is available **only for internal user domains** and can be enabled on each user domain.
Before turning it on, make sure that:

To enable this feature, ensure the following:
- password aging is active on the user domain
- the cluster can send [email notifications](../configuration/email_notifications.md), either through an internal Mail application or through an external SMTP server

- password aging must be enabled on the user domain
- the cluster must be configured to send [mail notifications](../configuration/email_notifications.md)

The feature can be enabled from the configuration page of the user domain by clicking the **Edit password warning** button on the `Password` card.

After enabling the feature, fill the following fields:
To activate it, open the user domain's configuration page and click the **Edit password warning** button on the `Password` card, then fill in the following fields:

- `Days before expiration`: the number of days before the password expiration when the notification is sent. The notification is sent every day until the password expires
- `Sender mail address`: the email address of the sender, make sure this is a valid email address to avoid issues with spam filters
- `Mail template`: select the template to use for the notification email. You can choose between the default templates or a custom one. Default templates are available in English and Italian. To use a custom template, see [Custom template](#password_warning_custom_template-section).

The notification email is sent to the user mail address which can be automatically discovered or manually set by an administrator, depending on the cluster configuration.

#### Internal SMTP server

When a [internal mail server](../applications/mail.md) instance is installed, and the cluster is configured to send mail notifications using it, the user mail address is automatically discovered and used to send the password expiration notification.
#### Recipient address {#password-warning-recipient}

The mail address can be overwritten by an administrator setting the `mail` field inside the [User Management portal](#user-management-portal-section).
The notification email recipient address is obtained from the user's `Email` field (LDAP `mail` attribute), which can also be modified by a domain administrator in the [User Management portal](#user-management-portal-section).

:::note

If the cluster is configured to send mail notifications using an external SMTP server, the automatically discovered mail address is not valid because the user domain is not known to the external server. In this case you must explicitly set the mail address for the user.

:::
If the LDAP attribute is empty or missing, the recipient address is obtained from a Mail application bound to the user domain. The address is assumed to be in the form `<user_name>@<user_domain_name>`.

#### External SMTP server
- If that Mail application is the same one configured for [email notifications](../configuration/email_notifications.md), the submission is internal and no public DNS MX record is required.
- Otherwise, delivery to `user_domain_name` follows conventional SMTP rules and does require a public DNS MX record.

When the cluster is configured to send mail notifications using an external SMTP server, the user mail address is not automatically discovered. An administrator must manually set for each user using the [User Management portal](#user-management-portal-section).

The mail address field is available for both OpenLDAP and Active Directory user domains.
If neither the `Email` field is set nor a Mail application is associated with the user domain, no notification is sent.

#### Custom template {#password_warning_custom_template-section}

Expand Down Expand Up @@ -270,9 +257,10 @@ When creating a user, the following fields are mandatory:

Optional attributes are:

- Email address -- Corresponds to the standard LDAP `mail` attribute. It can be set to the user's personal email address, where password expiration warnings are sent. Some applications may also use it as a valid login name.
- Password never expires -- When enabled, the user's password remains valid indefinitely, bypassing the domain password age policy.
- Required password change / User has to change password at next login (AD only) -- When enabled, the user is prompted to change their password at the next login.
- `Email` — Corresponds to the standard LDAP `mail` attribute. How this attribute is used depends on the applications that consume it. For example, it can be set to the user's personal email address, where password expiration warnings are sent, as described in the [Password expiration warning](#password-warning-recipient) section; for matching [mail domains](../applications/mail.md#email_domains), it may define a user's alternative email address; other applications may also use it as a valid login name.
- `Phone extension` — The user's internal phone extension. It is stored in the LDAP `telephoneNumber` attribute. As with the `Email` field, refer to the relevant application's documentation.
- `Password never expires` — When enabled, the user's password remains valid indefinitely, bypassing the domain password age policy.
- `Required password change` / `User has to change password at next login` (AD only) — When enabled, the user is prompted to change their password at the next login.

A user can be added to one or more groups.

Expand All @@ -290,16 +278,22 @@ User names must be unique within the same domain but can be reused across differ
Users and groups can be managed in bulk with the *import* and *export data* actions. The supported data format is [CSV](https://www.rfc-editor.org/rfc/rfc4180) (comma-separated values) with the following fields:

1. *username*
2. *display_name* -- An empty value removes the LDAP `displayName` attribute.
3. *password* -- If the password contains a comma (e.g. `Nethesis,1234`), enclose this field in double quotes. An empty value leaves the password unchanged for existing users, and sets a random initial password for newly created users.
4. *mail* -- A valid email address. Note that unlike Samba Active Directory, the OpenLDAP RFC2307 schema does not allow special characters. An empty value removes the corresponding `mail` LDAP attribute.
5. *groups* -- A list of groups separated by the `|` (pipe) character. If a group does not exist yet, it is created on the fly during the import. If this field is empty, the user is removed from all groups.
2. *display_name* An empty value removes the LDAP `displayName` attribute.
3. *password* If the password contains a comma (e.g. `Nethesis,1234`), enclose this field in double quotes. An empty value leaves the password unchanged for existing users, and sets a random initial password for newly created users.
4. *mail* A valid email address. Note that unlike Samba Active Directory, the OpenLDAP RFC2307 schema does not allow special characters. An empty value removes the corresponding `mail` LDAP attribute.
5. *groups* A list of groups separated by the `|` (pipe) character. If a group does not exist yet, it is created on the fly during the import. If this field is empty, the user is removed from all groups.
6. *locked* (boolean)
7. *must_change_password* (boolean)
8. *no_password_expiration* (boolean)

The fields must be present in the above, exact order. They correspond to the attributes described in the previous section; refer to [Create users and groups](#create-users-and-groups-section) for more information.

:::note

For backward compatibility with the CSV format of earlier versions, the `Phone extension` field is not available in the CSV file.

:::

The last three fields are boolean values. Accepted values are limited to the strings `true` and `false`. The empty string, and any value other than `true`, is interpreted as `false`.

For example, this CSV file includes an optional header line with the eight mandatory fields, followed by one record for user `john`, who is a member of the `devs` and `web` groups.
Expand All @@ -326,10 +320,13 @@ When creating a user, the following fields are available:
- Full name (name and surname)
- Password
- Group (optional field)
- Email address (optional field)
- Email (optional field)
- Phone extension (optional field)
- Password never expires (optional field)
- Required password change / User has to change password at next login (optional field, AD only)

Refer to the [Create users and groups](#create-users-and-groups-section) section for additional field information.

The portal is automatically configured on every instance of [Active Directory](#active_directory-section) or [LDAP server RFC2307](#openldap-section) provider.

The portal is available at the following URL:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,42 +185,29 @@ Dopo aver modificato la politica delle password, puoi cliccare sul pulsante **Mo

### Avviso di scadenza delle password {#password-warning}

Il sistema può inviare notifiche email agli utenti quando la loro password sta per scadere.
Il sistema può inviare notifiche email agli utenti quando la loro password sta per scadere. Questa funzionalità è disponibile **solo per i domini utente interni** ed è configurata separatamente per ciascun dominio utente.

Questa funzionalità è disponibile **solo per i domini utente interni** e può essere abilitata per ciascun dominio utente.
Prima di attivarla, assicurati che:

Per abilitare questa funzionalità, assicurati che:
- l'invecchiamento delle password sia attivo sul dominio utente
- il cluster sia in grado di inviare [notifiche email](../configuration/email_notifications.md), tramite un'applicazione Mail interna oppure un server SMTP esterno

- l'invecchiamento delle password sia abilitato sul dominio utente
- il cluster sia configurato per inviare [notifiche email](../configuration/email_notifications.md)

La funzionalità può essere abilitata dalla pagina di configurazione del dominio utente cliccando sul pulsante **Modifica avviso password** nella scheda `Password`.

Dopo aver abilitato la funzionalità, compila i seguenti campi:
Per attivarla, apri la pagina di configurazione del dominio utente e clicca sul pulsante **Modifica avviso password** nella scheda `Password`, quindi compila i seguenti campi:

- `Giorni prima della scadenza`: il numero di giorni prima della scadenza della password in cui viene inviata la notifica. La notifica viene inviata ogni giorno fino alla scadenza della password.
- `Indirizzo email del mittente`: l'indirizzo email del mittente, assicurati che sia un indirizzo valido per evitare problemi con i filtri antispam.
- `Template email`: seleziona il template da utilizzare per l'email di notifica. Puoi scegliere tra i template predefiniti o uno personalizzato. I template predefiniti sono disponibili in inglese e italiano. Per utilizzare un template personalizzato, consulta [Template personalizzato](#password_warning_custom_template-section).

L'email di notifica viene inviata all'indirizzo email dell'utente, che può essere rilevato automaticamente o impostato manualmente da un amministratore, a seconda della configurazione del cluster.

#### Server SMTP interno

Quando è installata un'istanza di [server di posta interno](../applications/mail.md) e il cluster è configurato per inviare notifiche email utilizzandolo, l'indirizzo email dell'utente viene rilevato automaticamente e utilizzato per inviare la notifica di scadenza della password.
#### Indirizzo del destinatario {#password-warning-recipient}

L'indirizzo email può essere sovrascritto da un amministratore impostando il campo `mail` all'interno del [portale di gestione utenti](#user-management-portal-section).
L'indirizzo del destinatario dell'email di notifica viene ricavato dal campo Indirizzo email dell'utente (attributo LDAP `mail`), che un amministratore di dominio può modificare anche dal [portale di gestione utenti](#user-management-portal-section).

:::note

Se il cluster è configurato per inviare notifiche email utilizzando un server SMTP esterno, l'indirizzo email rilevato automaticamente non è valido perché il dominio utente non è noto al server esterno. In questo caso, è necessario impostare esplicitamente l'indirizzo email per l'utente.

:::
Se l'attributo LDAP è vuoto o assente, l'indirizzo del destinatario viene ricavato da un'applicazione Mail associata al dominio utente. Si assume che l'indirizzo abbia la forma `<user_name>@<user_domain_name>`.

#### Server SMTP esterno
- Se tale applicazione Mail è la stessa configurata per le [notifiche email](../configuration/email_notifications.md), l'invio è interno e non è richiesto alcun record DNS MX pubblico.
- In caso contrario, la consegna a `user_domain_name` segue le normali regole SMTP e richiede un record DNS MX pubblico.

Quando il cluster è configurato per inviare notifiche email utilizzando un server SMTP esterno, l'indirizzo email dell'utente non viene rilevato automaticamente. Un amministratore deve impostarlo manualmente per ciascun utente utilizzando il [portale di gestione utenti](#user-management-portal-section).

Il campo dell'indirizzo email è disponibile sia per i domini utente OpenLDAP che Active Directory.
Se non è impostato il campo Indirizzo email né è associata un'applicazione Mail al dominio utente, la notifica non viene inviata.

#### Template personalizzato {#password_warning_custom_template-section}

Expand Down Expand Up @@ -262,9 +249,10 @@ Quando si crea un utente, i seguenti campi sono obbligatori:

Gli attributi opzionali sono:

- Indirizzo email -- Corrisponde all'attributo LDAP standard `mail`. Può essere impostato sull'indirizzo email personale dell'utente, dove vengono inviate le notifiche di scadenza della password. Alcune applicazioni possono anche utilizzarlo come nome utente valido per l'accesso.
- La password non scade mai (solo AD) -- Quando abilitato, la password dell'utente rimane valida indefinitamente, ignorando la politica di scadenza delle password del dominio.
- Cambio password obbligatorio / L'utente deve cambiare la password al prossimo accesso (solo AD) -- Quando abilitato, l'utente viene invitato a cambiare la propria password al prossimo accesso.
- `Indirizzo email` — Corrisponde all'attributo LDAP standard `mail`. Il modo in cui questo attributo viene utilizzato dipende dalle applicazioni che lo consultano. Ad esempio, può essere impostato sull'indirizzo email personale dell'utente, dove vengono inviate le notifiche di scadenza della password, come descritto nella sezione [Avviso di scadenza delle password](#password-warning-recipient); per far corrispondere i [domini di posta](../applications/mail.md#email_domains), può definire un indirizzo email alternativo dell'utente; altre applicazioni possono anche utilizzarlo come nome utente valido per l'accesso.
- `Interno telefonico` — L'interno telefonico dell'utente. È memorizzato nell'attributo LDAP `telephoneNumber`. Come per il campo `Indirizzo email`, consulta la documentazione dell'applicazione specifica.
- `La password non scade mai` — Quando abilitato, la password dell'utente rimane valida indefinitamente, ignorando la politica di scadenza delle password del dominio.
- `Cambio password obbligatorio` / `L'utente deve cambiare la password al prossimo accesso` (solo AD) — Quando abilitato, l'utente viene invitato a cambiare la propria password al prossimo accesso.

Un utente può essere aggiunto a uno o più gruppi.

Expand All @@ -282,16 +270,22 @@ I nomi utente devono essere univoci all'interno dello stesso dominio, ma possono
Gli utenti e i gruppi possono essere gestiti in blocco con le azioni *import* e *export data*. Il formato dati supportato è [CSV](https://www.rfc-editor.org/rfc/rfc4180) (valori separati da virgola) con i seguenti campi:

1. *username*
2. *display_name* -- Un valore vuoto rimuove l'attributo LDAP `displayName`.
3. *password* -- Se la password contiene una virgola (es. `Nethesis,1234`), racchiudi questo campo tra virgolette doppie. Un valore vuoto lascia la password invariata per gli utenti esistenti e imposta una password iniziale casuale per gli utenti appena creati.
4. *mail* -- Un indirizzo email valido. Nota che, a differenza di Samba Active Directory, lo schema OpenLDAP RFC2307 non consente caratteri speciali. Un valore vuoto rimuove il corrispondente attributo LDAP `mail`.
5. *groups* -- Un elenco di gruppi separati dal carattere `|` (pipe). Se un gruppo non esiste ancora, viene creato automaticamente durante l'importazione. Se questo campo è vuoto, l'utente viene rimosso da tutti i gruppi.
2. *display_name* Un valore vuoto rimuove l'attributo LDAP `displayName`.
3. *password* Se la password contiene una virgola (es. `Nethesis,1234`), racchiudi questo campo tra virgolette doppie. Un valore vuoto lascia la password invariata per gli utenti esistenti e imposta una password iniziale casuale per gli utenti appena creati.
4. *mail* Un indirizzo email valido. Nota che, a differenza di Samba Active Directory, lo schema OpenLDAP RFC2307 non consente caratteri speciali. Un valore vuoto rimuove il corrispondente attributo LDAP `mail`.
5. *groups* Un elenco di gruppi separati dal carattere `|` (pipe). Se un gruppo non esiste ancora, viene creato automaticamente durante l'importazione. Se questo campo è vuoto, l'utente viene rimosso da tutti i gruppi.
6. *locked* (booleano)
7. *must_change_password* (booleano)
8. *no_password_expiration* (booleano)

I campi devono essere presenti nell'ordine esatto sopra indicato. Corrispondono agli attributi descritti nella sezione precedente; consulta [Creare utenti e gruppi](#create-users-and-groups-section) per maggiori informazioni.

:::note

Per compatibilità con il formato CSV delle versioni precedenti, il campo `Interno telefonico` non è disponibile nel file CSV.

:::

Gli ultimi tre campi sono valori booleani. I valori accettati sono limitati alle stringhe `true` e `false`. La stringa vuota e qualsiasi valore diverso da `true` vengono interpretati come `false`.

Ad esempio, questo file CSV include una riga di intestazione opzionale con gli otto campi obbligatori, seguita da un record per l'utente `john`, che è membro dei gruppi `devs` e `web`.
Expand All @@ -318,9 +312,12 @@ Durante la creazione di un utente, sono disponibili i seguenti campi:
- Password
- Gruppo (campo opzionale)
- Indirizzo email (campo opzionale)
- Password non scade mai (campo opzionale, solo AD)
- Interno telefonico (campo opzionale)
- Password non scade mai (campo opzionale)
- Cambio password richiesto / L'utente deve cambiare la password al prossimo accesso (campo opzionale, solo AD)

Per maggiori informazioni sui campi, consulta la sezione [Creare utenti e gruppi](#create-users-and-groups-section).

Il portale è configurato automaticamente su ogni istanza di [Active Directory](#active_directory-section) o del provider [LDAP server RFC2307](#openldap-section).

Il portale è disponibile al seguente URL:
Expand Down
Loading