From 1d98a8b7fb50345232fbf30d5b55a068cd053c28 Mon Sep 17 00:00:00 2001 From: andryyy Date: Wed, 5 Jul 2017 12:05:40 +0200 Subject: [PATCH] Update docs --- docs/firststeps-local_mta.md | 10 ++++++++++ docs/install-update.md | 17 ++++++++++++++++- docs/install.md | 10 +++++----- docs/prerequesite-system.md | 25 +++++++++++++++---------- 4 files changed, 46 insertions(+), 16 deletions(-) diff --git a/docs/firststeps-local_mta.md b/docs/firststeps-local_mta.md index 954e0e93a..19dc9a507 100644 --- a/docs/firststeps-local_mta.md +++ b/docs/firststeps-local_mta.md @@ -4,4 +4,14 @@ The easiest option would be to disable the listener on port 25/tcp. ``` #smtp inet n - - - - smtpd ``` + +Furthermore, to relay your local mail over the dockerized mailcow, you may want to add `172.22.1.1` as relayhost: + +``` +postconf -e 'relayhost = 172.22.1.1' +``` + +"172.22.1.1" is the mailcow created network gateway in Docker. +Relaying over this interface is necessary (instead of - for example - relaying directly over ${MAILCOW_HOSTNAME}) to relay over a known internal network. + Restart Postfix after applying your changes. diff --git a/docs/install-update.md b/docs/install-update.md index bd5cbda3c..80d1baa1f 100644 --- a/docs/install-update.md +++ b/docs/install-update.md @@ -1,4 +1,19 @@ -There is no update routine. You need to refresh your pulled repository clone and apply your local changes (if any). Actually there are many ways to merge local changes. +## Automatic update + +An update script in your mailcow-dockerized directory will take care of updates. + +But use it with caution! If you think you made a lot of changes to the mailcow code, you should use the manual update guide below. + +Run the update script: +``` +./update.sh +``` + +If it needs to, it will ask you how you wish to proceed. +Merge errors will be reported. +Some minor conflicts will be auto-corrected (in favour of the mailcow: dockerized repository code). + +## Manual update ### Step 1 diff --git a/docs/install.md b/docs/install.md index 3d795bb4b..7503d36be 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,6 +1,6 @@ You need Docker and Docker Compose. -1\. Learn how to install [Docker](https://docs.docker.com/engine/installation/linux/) and [Docker Compose](https://docs.docker.com/compose/install/). +**1\.** Learn how to install [Docker](https://docs.docker.com/engine/installation/linux/) and [Docker Compose](https://docs.docker.com/compose/install/). Quick installation for most operation systems: @@ -17,17 +17,17 @@ chmod +x /usr/local/bin/docker-compose Please use the latest Docker engine available and do not use the engine that ships with your distros repository. -2\. Clone the master branch of the repository +**2\.** Clone the master branch of the repository ``` git clone https://github.com/mailcow/mailcow-dockerized && cd mailcow-dockerized ``` -3\. Generate a configuration file. Use a FQDN (`host.domain.tld`) as hostname when asked. +**3\.** Generate a configuration file. Use a FQDN (`host.domain.tld`) as hostname when asked. ``` ./generate_config.sh ``` -4\. Change configuration if you want or need to. +**4\.** Change configuration if you want or need to. ``` nano mailcow.conf ``` @@ -35,7 +35,7 @@ If you plan to use a reverse proxy, you can, for example, bind HTTPS to 127.0.0. You may need to stop an existing pre-installed MTA which blocks port 25/tcp. See [this chapter](https://mailcow.github.io/mailcow-dockerized-docs/firststeps-local_mta/) to learn how to reconfigure Postfix to run besides mailcow after a successful installation. -5\. Pull the images and run the composer file. The parameter `-d` will start mailcow: dockerized detached: +**5\.** Pull the images and run the composer file. The parameter `-d` will start mailcow: dockerized detached: ``` docker-compose pull docker-compose up -d diff --git a/docs/prerequesite-system.md b/docs/prerequesite-system.md index ba6600895..9427f9d82 100644 --- a/docs/prerequesite-system.md +++ b/docs/prerequesite-system.md @@ -33,18 +33,23 @@ If this command returns any results please remove or stop the application runnin If you have a firewall already up and running please make sure that these ports are open for incoming connections: -| Service | Protocol | Port | Container | Variable | -| --------------------|:--------:|:-------|:----------------|--------------------------------| -| Postfix SMTP | TCP | 25 | postfix-mailcow | `${SMTP_PORT}` | -| Postfix SMTPS | TCP | 465 | postfix-mailcow | `${SMTPS_PORT}` | -| Postfix Submission | TCP | 587 | postfix-mailcow | `${SUBMISSION_PORT}` | -| Dovecot IMAP | TCP | 143 | dovecot-mailcow | `${IMAP_PORT}` | -| Dovecot IMAPS | TCP | 993 | dovecot-mailcow | `${IMAPS_PORT}` | -| Dovecot POP3 | TCP | 110 | dovecot-mailcow | `${POP_PORT}` | -| Dovecot POP3S | TCP | 995 | dovecot-mailcow | `${POPS_PORT}` | -| Dovecot ManageSieve | TCP | 4190 | dovecot-mailcow | `${SIEVE_PORT}` | +| Service | Protocol | Port | Container | Variable | +| --------------------|:--------:|:-------|:----------------|----------------------------------| +| Postfix SMTP | TCP | 25 | postfix-mailcow | `${SMTP_PORT}` | +| Postfix SMTPS | TCP | 465 | postfix-mailcow | `${SMTPS_PORT}` | +| Postfix Submission | TCP | 587 | postfix-mailcow | `${SUBMISSION_PORT}` | +| Dovecot IMAP | TCP | 143 | dovecot-mailcow | `${IMAP_PORT}` | +| Dovecot IMAPS | TCP | 993 | dovecot-mailcow | `${IMAPS_PORT}` | +| Dovecot POP3 | TCP | 110 | dovecot-mailcow | `${POP_PORT}` | +| Dovecot POP3S | TCP | 995 | dovecot-mailcow | `${POPS_PORT}` | +| Dovecot ManageSieve | TCP | 4190 | dovecot-mailcow | `${SIEVE_PORT}` | | HTTP(S) | TCP | 80/443 | nginx-mailcow | `${HTTP_PORT}` / `${HTTPS_PORT}` | +To bind a service to an IP address, you can prepend the IP like this: `SMTP_PORT=1.2.3.4:25` + +**Important**: You cannot use IP:PORT bindings in HTTP_PORT and HTTPS_PORT. Please use `HTTP_PORT=1234` and `HTTP_BIND=1.2.3.4` instead. + + ## Date and Time To ensure that you have the correct date and time setup on your system, please check the output of `timedatectl status`: