Skip to content

Commit

Permalink
deprecated mailcow__redirect_http_to_https and replaced with mailcow_…
Browse files Browse the repository at this point in the history 
…_config_http_redirect
  • Loading branch information
@DerLinkman
DerLinkman committed Feb 6, 2025
1 parent 72ba04a commit e6d3435
Show file tree
Hide file tree
Showing 6 changed files with 61 additions and 52 deletions.
82 changes: 43 additions & 39 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,45 +18,49 @@ This role will setup a mailcow dockerized email server.
This role will use by default the `inventory_hostname` as mailcow hostname, this means that you have to use the full qualified domain name as your inventory hostname e.g. `mail.mailcow.tld` or you set `mailcow__hostname` to the correct FQDN.

## Variables
| name | purpose | default value | note |
| :---------------------------------------: | :-------------------------------------------------------------------------: | :-------------------------------------------------: | :-----------------------------------------------------------------------: |
| `mailcow__hostname ` | sets MAILCOW_HOSTNAME | `inventory_hostname` | needs to be an full qualified domain name |
| `mailcow__install_path` | sets the path where the mailcow-dockerized repo will be cloned | `/opt/mailcow-dockerized` | |
| `mailcow__git_repo` | Get mailcow from a specific repository | `https://github.com/mailcow/mailcow-dockerized.git` | |
| `mailcow__git_version` | checkout a specific version of mailcow | `master` | |
| `mailcow__timezone` | used to set the timezone your mailcow runs in during the config generation | not set | **must be set** |
| `mailcow__docker_compose_project_name` | sets the docker-compose projectname to a user-defined string | `mailcowdockerized` | |
| `mailcow__theme` | set the default mailcow theme in vars.local.inc.php | `lumen` | |
| `mailcow__config_http_port` | sets HTTP_PORT in mailcow.conf | `80` | |
| `mailcow__config_http_bind` | sets HTTP_BIND in mailcow.conf | `none` | |
| `mailcow__config_https_port` | sets HTTPS_PORT in mailcow.conf | `443` | |
| `mailcow__config_https_bind` | sets HTTPS_BIND in mailcow.conf | `none` | |
| `mailcow__config_acl_anyone` | sets ACL_ANYONE | disallow | |
| `mailcow__config_maildir_gc_time` | sets MAILDIR_GC_TIME in mailcow.conf | `1440` | |
| `mailcow__config_additional_san` | sets ADDITIONAL_SAN in mailcow.conf | | needs to be a list |
| `mailcow__config_additional_server_names` | sets ADDITIONAL_SERVER_NAMES in mailcow.conf | | needs to be a list |
| `mailcow__config_skip_lets_encrypt` | sets SKIP_LETS_ENCRYPT in mailcow.conf | | |
| `mailcow__config_enable_ssl_sni` | sets ENABLE_SSL_SNI in mailcow.conf | | |
| `mailcow__config_skip_ip_check` | sets SKIP_IP_CHECK in mailcow.conf | | |
| `mailcow__config_skip_http_verification` | sets SKIP_HTTP_VERIFICATION in mailcow.conf | `n` | |
| `mailcow__config_skip_clamd` | sets SKIP_CLAMD in mailcow.conf | `n` | |
| `mailcow__config_skip_fts` | sets SKIP_FTS in mailcow.conf | `n` | disables Full-text search (flatcurve) |
| `mailcow__config_fts_heap` | sets FTS_HEAP in mailcow.conf | `128` | sets the max amount of ram per index worker |
| `mailcow__config_fts_procs` | sets FTS_PROCS in mailcow.conf | `1` | amount of indexing processes max. running |
| `mailcow__config_skip_sogo` | sets SKIP_SOGO in mailcow.conf | `n` | |
| `mailcow__config_allow_admin_email_login` | sets ALLOW_ADMIN_EMAIL_LOGIN in mailcow.conf | `n` | |
| `mailcow__config_use_watchdog` | sets USE_WATCHDOG in mailcow.conf | `n` | |
| `mailcow__config_watchdog_notify_email` | sets WATCHDOG_NOTIFY_EMAIL in mailcow.conf | | |
| `mailcow__config_watchdog_notify_ban` | sets WATCHDOG_NOTIFY_BAN in mailcow.conf | `y` | |
| `mailcow__config_watchdog_subject` | sets WATCHDOG_SUBJECT in mailcow.conf | `Watchdog ALERT` | |
| `mailcow__config_log_lines` | sets LOG_LINES in mailcow.conf | `9999` | |
| `mailcow__config_sogo_expire_session` | sets SOGO_EXPIRE_SESSION in mailcow.conf | `480` | |
| `mailcow__install_updates` | if `yes` the mailcow ansible role will also update an existing installation | `yes` | |
| `mailcow__redirect_http_to_https` | if `yes`, all requests via HTTP will be redirected to HTTPS | `no` | also see https://mailcow.github.io/mailcow-dockerized-docs/u_e-80_to_443/ |
| `mailcow__config_acme_contact` | sets ACME_CONTACT in mailcow.conf | | |
| `mailcow__rspamd_clamd_servers` | configures the clamd server used by rspamd | `clamd:3310` | |
| `mailcow__rspamd_clamd_patterns` | configures custom clamd rspamd patterns inside rspamd antivirus.conf | | needs to be a list of name and regex |
| `mailcow__compose_command` | configures the command that is used for compose | `docker compose` | set to `docker-compose` for the standalone version of compose |
| name | purpose | default value | note |
| :---------------------------------------: | :-------------------------------------------------------------------------: | :-------------------------------------------------: | :-----------------------------------------------------------: |
| `mailcow__hostname ` | sets MAILCOW_HOSTNAME | `inventory_hostname` | needs to be an full qualified domain name |
| `mailcow__install_path` | sets the path where the mailcow-dockerized repo will be cloned | `/opt/mailcow-dockerized` | |
| `mailcow__git_repo` | Get mailcow from a specific repository | `https://github.com/mailcow/mailcow-dockerized.git` | |
| `mailcow__git_version` | checkout a specific version of mailcow | `master` | |
| `mailcow__timezone` | used to set the timezone your mailcow runs in during the config generation | not set | **must be set** |
| `mailcow__docker_compose_project_name` | sets the docker-compose projectname to a user-defined string | `mailcowdockerized` | |
| `mailcow__theme` | set the default mailcow theme in vars.local.inc.php | `lumen` | |
| `mailcow__config_http_port` | sets HTTP_PORT in mailcow.conf | `80` | |
| `mailcow__config_http_bind` | sets HTTP_BIND in mailcow.conf | `none` | |
| `mailcow__config_https_port` | sets HTTPS_PORT in mailcow.conf | `443` | |
| `mailcow__config_https_bind` | sets HTTPS_BIND in mailcow.conf | `none` | |
| `mailcow__config_acl_anyone` | sets ACL_ANYONE | disallow | |
| `mailcow__config_maildir_gc_time` | sets MAILDIR_GC_TIME in mailcow.conf | `1440` | |
| `mailcow__config_additional_san` | sets ADDITIONAL_SAN in mailcow.conf | | needs to be a list |
| `mailcow__config_additional_server_names` | sets ADDITIONAL_SERVER_NAMES in mailcow.conf | | needs to be a list |
| `mailcow__config_skip_lets_encrypt` | sets SKIP_LETS_ENCRYPT in mailcow.conf | | |
| `mailcow__config_enable_ssl_sni` | sets ENABLE_SSL_SNI in mailcow.conf | | |
| `mailcow__config_skip_ip_check` | sets SKIP_IP_CHECK in mailcow.conf | | |
| `mailcow__config_skip_http_verification` | sets SKIP_HTTP_VERIFICATION in mailcow.conf | `n` | |
| `mailcow__config_skip_clamd` | sets SKIP_CLAMD in mailcow.conf | `n` | |
| `mailcow__config_skip_fts` | sets SKIP_FTS in mailcow.conf | `n` | disables Full-text search (flatcurve) |
| `mailcow__config_fts_heap` | sets FTS_HEAP in mailcow.conf | `128` | sets the max amount of ram per index worker |
| `mailcow__config_fts_procs` | sets FTS_PROCS in mailcow.conf | `1` | amount of indexing processes max. running |
| `mailcow__config_skip_sogo` | sets SKIP_SOGO in mailcow.conf | `n` | |
| `mailcow__config_http_redirect` | sets HTTP_REDIRECT in mailcow.conf to control HTTP Redirects | `n` | can be `y` or `n` |
| `mailcow__config_allow_admin_email_login` | sets ALLOW_ADMIN_EMAIL_LOGIN in mailcow.conf | `n` | |
| `mailcow__config_use_watchdog` | sets USE_WATCHDOG in mailcow.conf | `n` | |
| `mailcow__config_watchdog_notify_email` | sets WATCHDOG_NOTIFY_EMAIL in mailcow.conf | | |
| `mailcow__config_watchdog_notify_ban` | sets WATCHDOG_NOTIFY_BAN in mailcow.conf | `y` | |
| `mailcow__config_watchdog_subject` | sets WATCHDOG_SUBJECT in mailcow.conf | `Watchdog ALERT` | |
| `mailcow__config_log_lines` | sets LOG_LINES in mailcow.conf | `9999` | |
| `mailcow__config_sogo_expire_session` | sets SOGO_EXPIRE_SESSION in mailcow.conf | `480` | |
| `mailcow__install_updates` | if `yes` the mailcow ansible role will also update an existing installation | `yes` | |
| `mailcow__config_acme_contact` | sets ACME_CONTACT in mailcow.conf | | |
| `mailcow__rspamd_clamd_servers` | configures the clamd server used by rspamd | `clamd:3310` | |
| `mailcow__rspamd_clamd_patterns` | configures custom clamd rspamd patterns inside rspamd antivirus.conf | | needs to be a list of name and regex |
| `mailcow__compose_command` | configures the command that is used for compose | `docker compose` | set to `docker-compose` for the standalone version of compose |


> [!CAUTION]
> The Variable `mailcow__redirect_http_to_https` is **deprecated** but still accepted and will be removed on a later date. Please use the replacement: `mailcow__config_http_redirect` instead.
## Usage

Expand Down
3 changes: 3 additions & 0 deletions defaults/main/mailcow.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,6 @@ mailcow__config_fts_procs: 1
# Skip FTS (Fulltext Search) for Dovecot on low-memory, low-threaded systems or if you simply want to disable it.
# Dovecot inside mailcow use Flatcurve as FTS Backend.
mailcow__config_skip_fts: n

# Redirect HTTP connections to HTTPS - y/n
mailcow__config_http_redirect: n
Loading

0 comments on commit e6d3435

Please sign in to comment.