From bb160f39a560ba3d0e7a49da575c1273ec7c088f Mon Sep 17 00:00:00 2001 From: timo Date: Sat, 6 May 2017 01:45:13 +0200 Subject: [PATCH] Adjusted headers and added chapter requirements --- docs/dns.md | 0 docs/mc14_import.md | 0 docs/requirements.md | 39 +++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 28 ++++++++++++++++------------ 4 files changed, 55 insertions(+), 12 deletions(-) create mode 100644 docs/dns.md create mode 100644 docs/mc14_import.md create mode 100644 docs/requirements.md diff --git a/docs/dns.md b/docs/dns.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/mc14_import.md b/docs/mc14_import.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/requirements.md b/docs/requirements.md new file mode 100644 index 000000000..b0bebaddb --- /dev/null +++ b/docs/requirements.md @@ -0,0 +1,39 @@ +Before you run **mailcow: dockerized**, there are a few requirements that you should check: +- **WARNING**: When you want to run the dockerized version on your Debian 8 (Jessie) box you should consider switching to the kernel 4.9 from jessie backports because there is a bug (kernel panic) with the kernel 3.16 when running docker containers with *healthchecks*! +- Mailcow: dockerized requires some ports to be open for incomming connections, so make sure that your firewall is not bloking these. Also make sure that no other application is interferring with mailcow's configuration. +- A correct DNS setup is crucial to every good mailserver setup, so please make sure you got at least the basis covered bevore you begin! + +## Minimum System Resources + +Please make sure that your system has at least the following resources: + +| Resource | mailcow-dockerized | +| ----------------------- | ------------------ | +| CPU | 1 GHz | +| RAM                     | 1 GiB         | +| Disk | 5 GiB | +| System Type | x86_64 | + +## Firewall & Ports + +Please check if any of mailcow's standard ports are open and not blocked by other applications: + +```bash +netstat -tulpn | grep -E -w '25|80|110|143|443|465|587|993|995' +``` + +If this command returns any results please remove or stop the application running on that port. You may also adjust mailcows ports via the `mailcow.conf` configuration file. + +If you have a firewall already up and running please make sure that these ports are open for incomming connections: + +| Service | Protocol | Port | Container | +| --------------------|:--------:|:-------|:----------------| +| Postfix Submission | TCP | 587 | postfix-mailcow | +| Postfix SMTPS | TCP | 465 | postfix-mailcow | +| Postfix SMTP | TCP | 25 | postfix-mailcow | +| Dovecot IMAP | TCP | 143 | dovecot-mailcow | +| Dovecot IMAPS | TCP | 993 | dovecot-mailcow | +| Dovecot POP3 | TCP | 110 | dovecot-mailcow | +| Dovecot POP3S | TCP | 995 | dovecot-mailcow | +| Dovecot ManageSieve | TCP | 4190 | dovecot-mailcow | +| HTTP(S) | TCP | 80/443 | nginx-mailcow | diff --git a/mkdocs.yml b/mkdocs.yml index 02e7859bf..9b81a6cf6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,29 +6,33 @@ markdown_extensions: - codehilite(guess_lang=true) - toc(permalink=true) pages: -- 'Information and support': 'index.md' -- 'Installation & update': +- 'Information & Support': 'index.md' +- 'Prerequisites': + - 'System Requirements': 'requirements.md' + - 'DNS Setup': 'dns.md' +- 'Migrating from mailcow 0.14': 'mc14_import.md' +- 'Installation & Update': - 'Installation': 'install.md' - 'Update': 'update.md' -- 'First Steps': +- 'First Steps': - 'SSL': 'ssl.md' - 'Rspamd Web UI': 'rspamd_ui.md' - 'Reverse Proxy': 'rp.md' - - 'Setup a relayhost (optional)': 'relayhost.md' + - 'Setup a Relayhost (optional)': 'relayhost.md' - 'Log to Syslog': 'syslog.md' - - 'Local MTA on Docker host': 'local_mta.md' - - 'Sender and receiver model': 'sender_rcv.md' + - 'Local MTA on Docker Host': 'local_mta.md' + - 'Sender and Receiver Model': 'sender_rcv.md' - 'Usage & Examples': - - 'mailcow UI configuration': 'mailcow_ui.md' + - 'mailcow UI Configuration': 'mailcow_ui.md' - 'Redirect HTTP to HTTPS': '80_to_443.md' - - 'Anonymize headers': 'anonym_headers.md' - - 'Adjust service configurations': 'change_config.md' - - 'Docker Compose Bash completion': 'dc_bash_compl.md' - - 'Two-factor authentication': 'tfa.md' + - 'Anonymize Headers': 'anonym_headers.md' + - 'Adjust Service Configurations': 'change_config.md' + - 'Docker Compose Bash Completion': 'dc_bash_compl.md' + - 'Two-Factor Authentication': 'tfa.md' - 'Blacklist / Whitelist': 'bl_wl.md' - 'Backup Maildir': 'backup_maildir.md' - 'Customize Dockerfiles': 'cust_dockerfiles.md' - - 'Disable sender addresses verification': 'disable_sender_verification.md' + - 'Disable Sender Addresses Verification': 'disable_sender_verification.md' - 'Debug': 'debug.md' - 'Autodiscover / Autoconfig': 'autodiscover_config.md' - 'Redis': 'redis.md'