UniqueSoft/openpanel
2
0
Fork 0
mirror of https://github.com/stefanpejcic/openpanel synced 2025-06-26 18:28:26 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update settings.md

Browse Source
This commit is contained in:
Radovan Ječmenica 2025-05-05 15:48:26 +02:00 committed by GitHub
parent 1f084ac1bb
commit c9f9bd1965
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 72 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
website/docs/admin/emails/settings.md
View File

@ -4,53 +4,26 @@ sidebar_position: 3
# Email Settings
Email Settings allow Administrator to monitor email traffic and manage mail server.
The Email Settings section allows you to configure various parameters for the MailServer stack to ensure efficient and secure email management.
:::info
Emails are only available on [OpenPanel Enterprise edition](/beta)
:::
Settings page displays current mail server status and settings.
![email settings](/img/admin/email_settings.png)
## MailServer Service
## MailServer Status
The status of the Mail Server service is displayed at the top of the page, where administrators can start, stop, or restart the service as needed.
The current status of the webmail client is shown under "Webmail Software," along with the total number of email accounts.
## Total Email Accounts
![mail_actions](/img/admin/mail_actions.png)
Displays the total number of email accounts currently active on the server. This includes all accounts across all domains configured on the system.
## MailServer Stack
Administrators can set and configure different services based on their needs:
![mailserver stack](/img/admin/mailserver_stack.png)
Changes to this service will interrupt current email traffic and restart the mailserver.
Advanced users can edit the `/usr/local/mail/openmail/mailserver.env` and `/usr/local/mail/openmail/compose.yml` files directly through the interface.
![mailserver env](/img/admin/mailserver_env.png)
## Relay Hosts
An SMTP relay service (aka relay host / smarthost) is an MTA that relays (forwards) mail on behalf of third parties (it does not manage the mail domains).
You should only configure this when you have some external service for outgoing emails, like SMTP2GO or self-hosted Proxmox Mail Gateway.
![relay hosts](/img/admin/relay_hosts.png)
## Webmail Client
Administrators can choose the Webmail client for their users to use on configured domain.
![webmail client](/img/admin/webmail_client.png)
Available options are:
- Roundcube
@ -63,10 +36,76 @@ Only one service can be active at a time.
By default the webmail client is available on `IP:8080`. Administrators can set a custom domain name to be used for the webmail.
![webmail domain](/img/admin/webmail_domain.png)
Domain should be added in format `name.tld` example: webmail.hosting.com or webmail-hosting.com - without the http or https prefix.
`/webmail` on every domain added to the server will redirect to this webmail domain.
## MailServer Stack
Administrators can set and configure different services based on their needs.
Configure services for the MailServer stack:
| Service | Description |
|----------------------------------------|-----------------------------------------------------------------------------|
| **Amavis** | Amavis content filter (used for ClamAV & SpamAssassin). |
| **DNS block lists** | Enables DNS block lists in Postscreen. |
| **Rspamd** | Enable or disable Rspamd. |
| **SpamAssassin** | Analyzes incoming mail and assigns a spam score. |
| **MTA-STS** | Enables MTA-STS support for outbound mail. |
| **OpenDKIM service** | Enables the OpenDKIM service for email signing. |
| **OpenDMARC service** | Enables the OpenDMARC service for email domain-based message authentication. |
| **POP3** | Enables the POP3 service for email retrieval. |
| **IMAP** | Enables the IMAP service for email retrieval. |
| **ClamAV** | Enables the ClamAV antivirus service. |
| **fail2ban** | Enables the fail2ban service to ban IPs based on suspicious activity. |
| **Only SMTP** | If enabled, only the Postfix service is started, and users cannot receive incoming email. |
| **Sender Rewriting Scheme** | Enables the Sender Rewriting Scheme, needed for email forwarding (see [postsrsd](https://github.com/roehling/postsrsd/blob/main/README.rst) for explanation). |
Changes to this service will interrupt current email traffic and restart the mailserver.
## Relay Hosts
The **Relay Hosts** feature allows you to configure an SMTP relay service (also known as a relay host or smarthost) for relaying (forwarding) outbound email on behalf of third parties. This service does not manage mail domains but helps in routing emails through an external SMTP server.
This feature is useful for organizations that need to route their outgoing email traffic through a trusted third-party service or SMTP server for better deliverability and security.
---
### Configuration Parameters
The following parameters are used to configure the relay host settings:
- **DEFAULT_RELAY_HOST**
Default relay host for outgoing emails. This should match the **RELAY_HOST**.
- Example: `mail.example.com`
- **RELAY_HOST**
The SMTP relay host that all outbound emails will be routed through.
- Example: `mail.example.com`
- **RELAY_PORT**
The port to be used for connecting to the SMTP relay host.
- Example: `25`
- **RELAY_USER (optional)**
The username for authenticating with the relay host. If this is set, secure connections will be required for outbound mail traffic.
- Example: `relay_user`
- **RELAY_PASSWORD**
The password for authenticating with the relay host, used alongside the **RELAY_USER**.
- Example: `relay_password`
When both **RELAY_USER** and **RELAY_PASSWORD** are configured, all outbound mail traffic will require a secure connection and the credentials will be mandatory.
---
Once configured, click the **Save Relay** button to apply the settings and begin routing outbound emails through the specified relay host.