From a5e18ad1c114b7175514f072d32a1d1d4b1b4c9c Mon Sep 17 00:00:00 2001 From: andryyy Date: Thu, 2 Mar 2017 20:11:48 +0100 Subject: [PATCH] Fix docs --- docs/first_steps.md | 73 ++++++++++++++++++++++++++++++++++++++------- docs/install.md | 33 +++++++++++++------- docs/u_and_e.md | 11 ++++++- 3 files changed, 95 insertions(+), 22 deletions(-) diff --git a/docs/first_steps.md b/docs/first_steps.md index 85a1d09f..fd187dd5 100644 --- a/docs/first_steps.md +++ b/docs/first_steps.md @@ -1,13 +1,3 @@ -# Change default language - -Change `data/conf/sogo/sogo.conf` and replace English by your language. - -Create a file `data/web/inc/vars.local.inc.php` and add "DEFAULT_LANG" with either "en", "pt", "de" or "nl": -``` - + ServerName mail.example.org + ServerAlias autodiscover.example.org + ServerAlias autoconfig.example.org + + [...] + # You should proxy to a plain HTTP session to offload SSL processing + ProxyPass / http://127.0.0.1:8080 + ProxyPassReverse / http://127.0.0.1:8080 + ProxyPreserveHost On + your-ssl-configuration-here + [...] + + # If you plan to proxy to a HTTPS host: + #SSLProxyEngine On + + # If you plan to proxy to an untrusted HTTPS host: + #SSLProxyVerify none + #SSLProxyCheckPeerCN off + #SSLProxyCheckPeerName off + #SSLProxyCheckPeerExpire off + +``` + +**Nginx** +``` +server { + listen 443; + server_name mail.example.org autodiscover.example.org autoconfig.example.org; + + [...] + your-ssl-configuration-here + location / { + proxy_pass http://127.0.0.1:8080; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + } + [...] +} +``` + diff --git a/docs/install.md b/docs/install.md index 7836b705..8daf6a85 100644 --- a/docs/install.md +++ b/docs/install.md @@ -2,22 +2,35 @@ 1. You need Docker. - - Most systems can install Docker by running `wget -qO- https://get.docker.com/ | sh` +Most systems can install Docker by running `wget -qO- https://get.docker.com/ | sh`. -2. You need Docker Compose. +2. You need Docker Compose +Learn [how to install Docker Compose](https://docs.docker.com/compose/install/). - - Learn [how to install Docker Compose](https://docs.docker.com/compose/install/) -3. Clone the master branch of the repository and run `./generate_config.sh` to generate a file "mailcow.conf". You will be asked for a hostname and a timezone: +3. Clone the master branch of the repository +``` +git clone https://github.com/andryyy/mailcow-dockerized && cd mailcow-dockerized +``` - - `git clone https://github.com/andryyy/mailcow-dockerized && cd mailcow-dockerized` - - `./generate_config.sh` - - Open and check "mailcow.conf" if you need or want to make changes to ports (for example changing the default HTTPS port) +4. Generate a configuration file. Use a FQDN (`host.domain.tld`) as hostname when asked. +``` +./generate_config.sh +``` -4. Run the composer file. - - `docker-compose up -d` +5. Change configuration if you want or need to. +``` +nano mailcow.conf +``` -Done. +If you plan to use a reverse proxy, you can, for example, bind HTTPS to 127.0.0.1 on port 8443 and HTTP to 127.0.0.1 on port 8080. + +6. Run the composer file. +``` +docker-compose up -d +``` + +Done! You can now access **https://${MAILCOW_HOSTNAME}** with the default credentials `admin` + password `moohoo`. diff --git a/docs/u_and_e.md b/docs/u_and_e.md index 9542b9a3..62ba76ce 100644 --- a/docs/u_and_e.md +++ b/docs/u_and_e.md @@ -10,7 +10,6 @@ Save as `data/conf/postfix/mailcow_anonymize_headers.pcre`: /^\s*X-Mailer/ IGNORE /^\s*X-Originating-IP/ IGNORE /^\s*X-Forward/ IGNORE -/^\s*Mime-Version:/ IGNORE ``` Add this to `data/conf/postfix/main.cf`: @@ -52,6 +51,16 @@ curl -L https://raw.githubusercontent.com/docker/compose/$(docker-compose versio Edit a domain as (domain) administrator to add an item to the filter table. Beware that a mailbox user can login to mailcow and override a domain policy filter item. + +# Change default language + +Change `data/conf/sogo/sogo.conf` and replace "English" by your prefered language. + +Create a file `data/web/inc/vars.local.inc.php` and add "DEFAULT_LANG" with either "en", "pt", "de" or "nl": +``` +