General Settings#

General setting influence the basic domain configuration; most of them appear during the creation of the domain. More options allow to define the time zone, the use of HTTP or HTTPS protocol (we suggest using always the latter), and a mail server used for spam-relay purposes.

Additionally, if option Allow searching users’ information in all domains is not active in Carbonio Admin Panel Domains ‣ Global ‣ Settings (see Settings), a Domain or Global Administrator will be able to allow, on a domain basis, the search for users in other domains configured on the Carbonio infrastructure.

Moreover, a default COS and its status can be attached to the domain.

We build on the domain created in previous section and attach some property.

Public Service Protocol

Force clients to connect only using https.

Time Zone

The timezone is set to Hawaii’s time.

Default Class of Service

The COS used by the domain, which is left to the default one.

Public Service Host Name

It is the FQDN (mail.acme.example) used by clients to connect to the domain and must correspond to the DNS A record to be reachable publicly. If the A record is set to a private IP address, to reach the WebGUI you need some mechanism, like e.g., a VPN tunnel.

At the bottom of the page, button DELETE DOMAIN allows to delete the domain. When clicked, a dialog will open, listing all items defined on the domain (Accounts, Distribution Lists, Resources, and so on) and that will be deleted together with the domain. Two choices are available: to Close the domain, keeping all items but preventing access, or Remove the domain and all its items.

Global Address List#

A GAL is a special account (“GALSync Account”) that contains all e-mail accounts configured on the server and provides the ability to quickly search e-mail addresses, for example when composing an email or adding participants to an event in the Calendar. A GAL can be internal when configured on Carbonio, external (when configured on the LDAP used by Carbonio, or both. In this page you see the email-address of the GALSync account, you can change it from external to internal, or vice versa, or both. you can also remove it, create it if missing, and change some of its options.

The GALSync account is updated regularly, according to the interval specified in the Settings section of the page. Administrators can force a resynchronisation of all GALs defined on a domain by clicking the RE-SYNC button.

Authentication#

Options in this page control how a user can log in to Carbonio. The supported methods are Carbonio, Carbonio’s local authentication backend, a Local LDAP, an External LDAP, or an External Active Directory server. You can refer to Section Authentication Methods for more information about these backends.

If the method is different from Carbonio, on the one side you need to provide the various parameters and check it the connection is successful, while on the other side, the use of 2FA will not be allowed, as it is not possible to enforce 2FA with authentication methods other than Carbonio.

External LDAP#

A typical connection is shown in Fig. 13, the following scenario describes the parameters to be used.

Scenario

This scenario defines a few values that are used for the connection to an external LDAP server. Adapt them according to your needs!

• Define on Carbonio the domain authentication.example.com

• On an external LDAP server, located at 172.24.0.155, a domain called ldapexternal.local exists

  Note

  This external source can also be another Carbonio.

• On the external LDAP server a dedicated admin user exists, that will be used for the LDAP connection (for example service.ldap@ldapexternal.local with password astrongpwd)

• The LDAP class that stores the users and their password is called uid

Our goal is to have the authentication.example.com domain users authenticate with the passwords of the domain accounts ldapexternal.local defined on the external ldap server

URL

The hostname or IP address where the LDAP is located, which should include the port (default is 389). In our scenario it is 172.24.0.155:389.

Filter

Represents the attribute that identifies the user in the external LDAP (uid=%u).

Basic Search

The LDAP query that is used to filter the users. It contains the domain defined on the LDAP server (dc=ldapexternal,dc=local) and the organisation (or, in a broader sense, the LDAP class) to which the filter above belongs.

Search Bind user & Search Bind Password

The user password used to execute the query (user service.ldap@ldapexternal.local with password astrongpwd).

Verify Auth

This two fields allow to test whether an LDAP user, identified by username and password, can successfully authenticate.

See also

You can carry out the same procedure from the CLI, please refer to Section External LDAP.

External AD#

A typical connection is shown in Fig. 14, the following scenario describes the parameters to be used.

Scenario

This scenario defines a few values that are used for the connection to an external AD server. Adapt them according to your needs!

• Define on Carbonio the domain ad-auth.example.com

• On an external AD server, located at 172.24.0.100 a domain called external_ad.com exists

  Note

  This external source can also be another Carbonio.

• On the external AD server a dedicated user exists, that will be used for the AD connection (for example service.ad@external_ad.com with password very_strong_pass!)

Our goal is to have the ad-auth.example.com domain users authenticate with the passwords of the domain accounts external_ad.com defined on the external ldap server

URL

The hostname or IP address where the AD is located, which should include the port (default is 3268). In our scenario it is 172.24.0.100:3268.

Filter

Represents the attribute that identifies the user in the external AD (|(userprincipalname=%u@external_ad.com)(samaccountname=%u)).

Basic Search

The query that is used to filter the users. It contains the domain defined on the AD server (dc=external_ad,dc=com).

Search Bind user & Search Bind Password

The user password used to execute the query (user service.ad@external_ad.com with password very_strong_pass!).

Verify Auth

These two fields allow to test whether an AD user, identified by username and password, can successfully authenticate.

See also

You can carry out the same procedure from the CLI, please refer to Section External Active Directory.

Virtual Hosts & Domain Certificates#

A Virtual Host is an alternative name given to a domain that can be used to access the same domain. To be able to use the virtual host, the name must be registered on the domain’s DNS with an A or CNAME record.

To each virtual host you can associate an SSL certificate. Carbonio supports the upload of multiple SSL domain certificates from the Carbonio Admin Panel and associate them to different domains, a procedure that requires only a few steps.

Select the virtual host, then click VERIFY CERTIFICATE. In the dialog, you can choose to use:

• A Let’s Encrypt longChain Certificate, i.e., including an intermediate certificate. Make sure to satisfy the requirements before clicking the GENERATE CERTIFICATE button. Complete the procedure according to the directions below.

• A Let’s Encrypt shortChain Certificate, without intermediate certificate: like the previous case, make sure to satisfy the requirements before clicking the GENERATE CERTIFICATE button. Complete the procedure according to the directions below.

  Let’s Encrypt’s Short and Long Chain certificates.

  Without going into much details, the difference between the two types of certificates issued by Let’s Encrypt (“ISRG Root X1”) is the compatibility with older Android clients and SSL libraries.

  More technically, the difference is that the Short Chain contains two certificates: Let’s Encrypt’s Root certificate and the one issued to your website, signed by the former; while the Long Chain three: the same of the Short Chain and an intermediate certificate. The ISRG Root X1 indeed, was issued quite recently and may not be known to some browsers, devices, or clients, therefore it was decided to add as intermediate certificate another root certificate that is well known to clients, to expand compatibility.

  See also

  More details and technicalities about the Short vs. Long Chain certificates can be found in article Long (default) and Short (alternate) Certificate Chains Explained.

• A custom certificate. In this case, you need to provide by yourself the three files of the authorisation chain (i.e., the Domain Certificate, the Certificate CA Chain, and the Private Key). You can either click the paper clip icon to upload a certificate file or paste the content of the file in the corresponding textfields.

  Note

  If you paste the certificate, remember to add a carriage return (CR) at the end of the certificate (i.e., after the -----END CERTIFICATE----- line), like in the following screenshot.

  

  Click VERIFY to verify the certificates: if everything is correct, notification The certificate is valid will appear. To use the certificate, click the I WANT TO USE THIS CERTIFICATE button to upload and use the certificate. Again, a notification will be shown (The certificates have been saved). To complete the procedure, restart the Node on which the Proxy is installed.

You can REMOVE or DOWNLOAD the certificates by clicking the appropriate button above the certificates themselves.

zextras$ /opt/zextras/libexec/zmproxyconfgen
zextras$ zmproxyctl restart

zextras$ /opt/zextras/libexec/zmproxyconfgen
zextras$ /opt/zextras/bin/zmproxyctl reload

zextras$ /opt/zextras/libexec/zmproxyconfgen
zextras$ /opt/zextras/bin/zmproxyctl reload

Mailbox Quota#

These settings allow to define a maximum limit (in gigabytes, with 0 meaning no limit) for the space used by each account and by the entire domain. It is also possible to set a value that, when reached, will send a warning by e-mail to a given address. The values configured here are inherited by all accounts that will be created, but can be overridden on a per-user basis.

To ease monitoring quota available to users for Mails and Carbonio Files, the bottom of the page contains a list of accounts and their respective quotas (total quota and percentage of quota used) for both services. The accounts can be sorted by the total quota or percentage quota of Mails or Carbonio Files.

Additionally, click the DOWNLOAD QUOTA REPORT button to download a CSV file containing the current status of the used quota.

White-label Settings#

These setting are the same that appear in Global’s section (Domains ‣ Global ‣ White-label), but are domain-specific: if not defined at domain level, the global theme settings will be applied. The description of the available options can be found in the dedicated section.

2-Factor-Autenthication#

In this page it is possible to configure 2FA for the various services offered by Carbonio, only for the selected domain. To modify settings for all domains, refer to 2-Factor-Autenthication.

These settings are available only if the authentication method (under Domains ‣ Details ‣ Authentication, see Authentication) for the current domain is set to Carbonio.

Many services are available to configure individually. For each of them it is possible to Disable 2FA completely, allowing user access with username and password only; to Trust the IP, meaning that all client connections from a given IP address or IP range will be trusted even if they don’t use 2FA; and to Trust the device which allows an application (usually a browser) to be trusted when connecting from a given IP.

SAML#

The management of SAML access to Carbonio is carried out from this page.

At the top of the page, two buttons allow to copy the ENTITY ID and SERVICE URL of the current Carbonio, which are required to carry out the configuration on the SAML IDP provider’s side: click each of them to paste the respective value and generate the configuration.

Once the configuration has been carried out, it is possible to copy its URL and paste it in the textfield. Click the Allow Unsecure if the configuration URL uses HTTP and not HTTPS. Click IMPORT to import the configuration.

The three button below allow to generate the SP certificate to configure the logout from the IDP and to export or delete the current configuration.

The procedure to follow for the complete logout from the IDP is described in detail in the CLI Section Configure SAML Logout. You can accomplish the same goal from the Carbonio Admin Panel by writing in the two bottom textfields the variables mentioned in that section and their corresponding value, then clicking the ADD button. Remember also to add the SP certificate to the IDP’s configuration.

Disclaimer#

To add a disclaimer to e-mails, use either textfield present in the page. The text written in the left-hand side will be appended to e-mails of users that have the mail editor set for plain-text, while the text written in the right-hand side is for user using the rich-text editor.

Please check the Carbonio’s global settings for further configuration.

The text can contain for example a legal, confidentiality, or copyright notice: an example in text:

This email and any files transmitted with it are confidential and
are for the sole use of the individual or entity to which they are
addressed. If you received this email in error, please notify your
system administrator.

One example in HTML:

<h2>Contacts</h2>
<p>Company Phone: +00 123 456 7890</p>
<p>Company e-mail: info@example.com</p>

Every time you enable or disable the disclaimer or change the text, you need to issue the command as the zextras user on every Node featuring the MTA role

zextras$ /opt/zextras/libexec/zmaltermimeconfig