From d2b6912aaba88e14fe449f9104ae7ea46e3bb9f9 Mon Sep 17 00:00:00 2001
From: andryyy <andre.peters@debinux.de>
Date: Thu, 2 Mar 2017 11:32:49 +0100
Subject: [PATCH] Remove docs from dev

---
 docs/first_steps.md |  76 ---------
 docs/index.md       |  42 -----
 docs/install.md     |  61 -------
 docs/u_and_e.md     | 390 --------------------------------------------
 mkdocs.yml          |   9 -
 5 files changed, 578 deletions(-)
 delete mode 100644 docs/first_steps.md
 delete mode 100644 docs/index.md
 delete mode 100644 docs/install.md
 delete mode 100644 docs/u_and_e.md
 delete mode 100644 mkdocs.yml

diff --git a/docs/first_steps.md b/docs/first_steps.md
deleted file mode 100644
index 85a1d09f..00000000
--- a/docs/first_steps.md
+++ /dev/null
@@ -1,76 +0,0 @@
-# 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":
-```
-<?php
-$DEFAULT_LANG = "de";
-```
-
-# SSL (and: How to use Let's Encrypt)
-
-mailcow dockerized comes with a snakeoil CA "mailcow" and a server certificate in `data/assets/ssl`. Please use your own trusted certificates.
-
-mailcow uses 3 domain names that should be covered by your new certificate:
-
-- ${MAILCOW_HOSTNAME}
-- autodiscover.*example.org*
-- autoconfig.*example.org*
-
-## Obtain multi-SAN certificate by Let's Encrypt
-
-This is just an example of how to obtain certificates with certbot. There are several methods!
-
-1. Get the certbot client:
-```
-wget https://dl.eff.org/certbot-auto -O /usr/local/sbin/certbot && chmod +x /usr/local/sbin/certbot
-```
-2. Make sure you set `HTTP_BIND=0.0.0.0` in `mailcow.conf` or setup a reverse proxy to enable connections to port 80. If you changed HTTP_BIND, then restart Nginx: `docker-compose restart nginx-mailcow`.
-
-3. Request the certificate with the webroot method:
-
-```
-cd /path/to/git/clone/mailcow-dockerized
-source mailcow.conf
-certbot certonly \
-        --webroot \
-        -w ${PWD}/data/web \
-        -d ${MAILCOW_HOSTNAME} \
-        -d autodiscover.example.org \
-        -d autoconfig.example.org \
-        --email you@example.org \
-        --agree-tos
-```
-
-3. Create hard links to the full path of the new certificates. Assuming you are still in the mailcow root folder:
-```
-mv data/assets/ssl/cert.{pem,pem.backup}
-mv data/assets/ssl/key.{pem,pem.backup}
-ln $(readlink -f /etc/letsencrypt/live/${MAILCOW_HOSTNAME}/fullchain.pem) data/assets/ssl/cert.pem
-ln $(readlink -f /etc/letsencrypt/live/${MAILCOW_HOSTNAME}/privkey.pem) data/assets/ssl/key.pem
-```
-4. Restart containers which use the certificate:
-```
-docker-compose restart postfix-mailcow dovecot-mailcow nginx-mailcow
-```
-When renewing certificates, run the last two steps (link + restart) as post-hook in a script.
-
-# Rspamd UI access
-At first you may want to setup Rspamds web interface which provides some useful features and information.
-
-1. Generate a Rspamd controller password hash:
-```
-docker-compose exec rspamd-mailcow rspamadm pw
-```
-2. Replace the default hash in `data/conf/rspamd/override.d/worker-controller.inc` by your newly generated:
-```
-enable_password = "myhash";
-```
-3. Restart rspamd:
-
-```
-docker-compose restart rspamd-mailcow
-```
-
-Open https://${MAILCOW_HOSTNAME}/rspamd in a browser and login!
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index f44f3308..00000000
--- a/docs/index.md
+++ /dev/null
@@ -1,42 +0,0 @@
-# mailcow: dockerized - 🐮 + 🐋 = 💕
-
-[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=JWBSYHF4SMC68)
-
-mailcow dockerized comes with **11 containers** linked in **one bridged network**.
-
-- Dovecot
-- Memcached
-- Redis
-- MySQL
-- Bind9 (Resolver) (formerly PDNS Recursor)
-- PHP-FPM
-- Postfix
-- Nginx
-- Rmilter
-- Rspamd
-- SOGo
-
-**6 volumes** to keep dynamic data - take care of them!
-
-- vmail-vol-1
-- dkim-vol-1
-- redis-vol-1
-- mysql-vol-1
-- rspamd-vol-1
-- postfix-vol-1
-
-The integrated **mailcow UI** allows administrative work on your mail server instance as well as separated domain administrator and mailbox user access:
-
-- DKIM key management
-- Black- and whitelists per domain and per user
-- Spam score managment per-user (reject spam, mark spam, greylist)
-- Allow mailbox users to create temporary spam aliases
-- Prepend mail tags to subject or move mail to subfolder (per-user)
-- Allow mailbox users to toggle incoming and outgoing TLS enforcement
-- Allow users to reset SOGo ActiveSync device caches
-- imapsync to migrate or pull remote mailboxes regularly
-- TFA: Yubi OTP and U2F USB (Google Chrome and derivates only)
-- Add domains, mailboxes, aliases, domain aliases and SOGo resources
-
-
-*[Looking for a farm to host your cow?](https://www.servercow.de)* 
diff --git a/docs/install.md b/docs/install.md
deleted file mode 100644
index 352bfa64..00000000
--- a/docs/install.md
+++ /dev/null
@@ -1,61 +0,0 @@
-# Install mailcow
-
-1. You need Docker.
-
-    - Most systems can install Docker by running `wget -qO- https://get.docker.com/ | sh`
-
-2. You need Docker Compose.
-
-    - Learn [how to install Docker Compose](https://docs.docker.com/compose/install/) - or:
-	- `curl -L "https://github.com/docker/compose/releases/download/composer_version/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose && chmod +x /usr/local/bin/docker-compose`
-
-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:
-
-    - `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. Run the composer file.
-    - `docker-compose up -d`
-
-Done.
-
-You can now access **https://${MAILCOW_HOSTNAME}** with the default credentials `admin` + password `moohoo`.
-
-It may take a while for MySQL to warm up, so please wait half a minute.
-
-The database will be initialized right after a connection to MySQL can be established.
-
-# Update mailcow
-
-There is no update routine.
-
-You need to refresh your pulled repository clone by running `git pull` - this will likely fail due to changes to your local configuration. But that's why we use git! :-)
-
-Whatever file has local changes, add and commit it to your repository clone. For example:
-
-```
-git add data/conf/postfix/main.cf data/conf/dovecot/dovecot.conf
-git commit -m "My changes to main.cf and dovecot.conf
-```
-
-Try running `git pull` again and resolve conflicts, if any.
-
-Now update all images, apply changes to containers and restart all services:
-
-```
-docker-compose pull
-docker-compose up -d --remove-orphans
-docker-compose restart
-```
-
-## Use dev branch (not recommended)
-
-When you checkout the dev branch, you will most likely end up using the "master" images with code base of "dev".
-If there were critical changes to the images in dev, mailcow will not work.
-
-But you can still build the images by yourself:
-
-```
-docker-compose up -d --build
-```
diff --git a/docs/u_and_e.md b/docs/u_and_e.md
deleted file mode 100644
index 0f88118e..00000000
--- a/docs/u_and_e.md
+++ /dev/null
@@ -1,390 +0,0 @@
-# Anonymize headers for smtp relayed
-
-Save as `data/conf/postfix/mailcow_anonymize_headers.pcre`:
-
-```
-/^\s*Received:[^\)]+\)\s+\(Authenticated sender:(.+)/
-	REPLACE Received: from localhost (localhost [127.0.0.1]) (Authenticated sender:$1
-/^\s*User-Agent/        IGNORE
-/^\s*X-Enigmail/        IGNORE
-/^\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`:
-
-```
-smtp_header_checks = pcre:/opt/postfix/conf/mailcow_anonymize_headers.pcre
-```
-
-# Backup and restore maildir (simple tar file)
-
-### **Backup**
-
-This line backups the vmail directory to a file backup_vmail.tar.gz in the mailcow root directory:
-```
-cd /path/to/mailcow-dockerized
-source mailcow.conf
-DATE=$(date +"%Y%m%d_%H%M%S")
-docker run --rm -it -v $(docker inspect --format '{{ range .Mounts }}{{ if eq .Destination "/var/vmail" }}{{ .Name }}{{ end }}{{ end }}' $(docker-compose ps -q dovecot-mailcow)):/vmail -v ${PWD}:/backup debian:jessie tar cvfz /backup/backup_vmail.tar.gz /vmail
-```
-
-You can change the path by adjusting ${PWD} (which equals to the current directory) to any path you have write-access to.
-Set the filename `backup_vmail.tar.gz` to any custom name, but leave the path as it is. Example: `[...] tar cvfz /backup/my_own_filename_.tar.gz`
-
-### **Restore**
-
-```
-cd /path/to/mailcow-dockerized
-source mailcow.conf
-DATE=$(date +"%Y%m%d_%H%M%S")
-docker run --rm -it -v $(docker inspect --format '{{ range .Mounts }}{{ if eq .Destination "/var/vmail" }}{{ .Name }}{{ end }}{{ end }}' $(docker-compose ps -q dovecot-mailcow)):/vmail -v ${PWD}:/backup debian:jessie tar xvfz /backup/backup_vmail.tar.gz
-```
-For the tab-tab... :-)
-
-```
-curl -L https://raw.githubusercontent.com/docker/compose/$(docker-compose version --short)/contrib/completion/bash/docker-compose -o /etc/bash_completion.d/docker-compose
-```
-# Black- and Whitelist
-
-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 theme
-
-mailcow uses [Bootstrap](http://getbootstrap.com/), a HTML, CSS, and JS framework.
-
-Open or create the file `data/web/inc/vars.local.inc.php` and change `DEFAULT_THEME` to either cerulean, cosmo, custom, cyborg, darkly, flatly, journal, paper, readable, sandstone, simplex, slate, spacelab, superhero, united or yeti (see https://bootswatch.com/):
-```
-<?php
-$DEFAULT_THEME = "paper";
-```
-# Customize Dockerfiles
-
-Make your changes in `data/Dockerfiles/$service` and build the image locally:
-
-```
-docker build data/Dockerfiles/service -t andryyy/mailcow-dockerized:$service
-```
-
-Now auto-recreate modified containers:
-
-```
-docker-compose up -d
-```
-
-# Do not check sender addresses for any domain
-
-This option is not best-practice and should only be implemented when there is no other option available to archive whatever you are trying to do.
-
-Simply create a file `data/conf/postfix/check_sender_access` and enter the following content:
-```
-user-to-allow-everything@example.com OK
-```
-
-Open `data/conf/postfix/main.cf` and find `smtpd_sender_restrictions`. Prepend `check_sasl_access hash:/opt/postfix/conf/check_sender_access` like this:
-```
-smtpd_sender_restrictions = check_sasl_access hash:/opt/postfix/conf/check_sender_access reject_authenticated_sender [...]
-```
-
-Run postmap on check_sasl_access:
-
-```
-docker-compose exec postfix-mailcow postmap /opt/postfix/conf/check_sasl_access
-``` 
-
-Restart the Postfix container.
-# Install Roundcube
-
-Download Roundcube 1.3.x (beta at the time of Feb 2017) to the web htdocs directory and extract it (here `rc/`):
-
-```
-cd data/web/rc
-wget -O - https://github.com/roundcube/roundcubemail/releases/download/1.3-beta/roundcubemail-1.3-beta-complete.tar.gz | tar xfvz -
-# Change folder name
-mv roundcubemail-1.3* rc
-# Change permissions
-chown -R root: rc/
-```
-
-Create a file `data/web/rc/config/config.inc.php` with the following content.
-
-**Change the `des_key` parameter to a random value.** It is used to temporarily store your IMAP password.
-
-```
-<?php
-error_reporting(0);
-if (!file_exists('/tmp/mime.types')) {
-file_put_contents("/tmp/mime.types", fopen("http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types", 'r'));
-}
-$config = array();
-$config['db_dsnw'] = 'mysql://' . getenv('DBUSER') . ':' . getenv('DBPASS') . '@mysql/' . getenv('DBNAME');
-$config['default_host'] = 'tls://dovecot';
-$config['default_port'] = '143';
-$config['smtp_server'] = 'tls://postfix';
-$config['smtp_port'] = 587;
-$config['smtp_user'] = '%u';
-$config['smtp_pass'] = '%p';
-$config['support_url'] = '';
-$config['product_name'] = 'Roundcube Webmail';
-$config['des_key'] = 'rcmail-!24ByteDESkey*Str';
-$config['log_dir'] = '/dev/null';
-$config['temp_dir'] = '/tmp';
-$config['plugins'] = array(
-    'archive',
-);
-$config['skin'] = 'larry';
-$config['mime_types'] = '/tmp/mime.types';
-$config['imap_conn_options'] = array(
-'ssl' => array('verify_peer' => false, 'verify_peer_name' => false, 'allow_self_signed' => true)
-);
-$config['enable_installer'] = false;
-$config['smtp_conn_options'] = array(
-'ssl' => array('verify_peer' => false, 'verify_peer_name' => false, 'allow_self_signed' => true)
-);
-```
-
-Point your browser to `https://myserver/rc/installer` and follow the instructions.
-Initialize the database and leave the installer.
-**Delete the directory `data/web/rc/installer` after a successful installation!**
-
-## Enable password changing
-
-Open `data/web/rc/config.inc.php` and enable the password plugin:
-
-```
-...
-$config['plugins'] = array(
-    'archive',
-    'password',
-);
-...
-```
-
-Open `data/web/rc/plugins/password/password.php`, search for `case 'ssha':` and add above:
-
-```
-        case 'ssha256':
-            $salt = rcube_utils::random_bytes(8);
-            $crypted = base64_encode( hash('sha256', $password . $salt, TRUE ) . $salt );
-            $prefix  = '{SSHA256}';
-            break;
-```
-
-Open `data/web/rc/plugins/password/config.inc.php` and change the following parameters (or add them at the bottom of that file):
-
-```
-$config['password_driver'] = 'sql';
-$config['password_algorithm'] = 'ssha256';
-$config['password_algorithm_prefix'] = '{SSHA256}';
-$config['password_query'] = "UPDATE mailbox SET password = %P WHERE username = %u";
-```
-
-# Learn spam and ham
-
-Rspamd learns mail as spam or ham when you move a message in or out of the junk folder to any mailbox besides trash.
-This is archived by using the Dovecot plugin "antispam" and a simple parser script.
-
-Rspamd also auto-learns mail when a high or low score is detected (see https://rspamd.com/doc/configuration/statistic.html#autolearning)
-
-The bayes statistics are written to Redis as keys `BAYES_HAM` and `BAYES_SPAM`.
-
-You can also use Rspamds web ui to learn ham and/or spam.
-
-# MySQL
-
-### Connect to the MySQL database:
-```
-source mailcow.conf
-docker-compose exec mysql-mailcow mysql -u${DBUSER} -p${DBPASS} ${DBNAME}
-```
-
-### Backup the database:
-```
-cd /path/to/mailcow-dockerized
-source mailcow.conf
-DATE=$(date +"%Y%m%d_%H%M%S")
-docker-compose exec mysql-mailcow mysqldump --default-character-set=utf8mb4 -u${DBUSER} -p${DBPASS} ${DBNAME} > backup_${DBNAME}_${DATE}.sql
-```
-
-### Restore the database:
-```
-cd /path/to/mailcow-dockerized
-source mailcow.conf
-docker-compose exec mysql-mailcow mysql -u${DBUSER} -p${DBPASS} ${DBNAME} < backup_file.sql
-```
-
-# Read logs
-You can use `docker-compose logs $service-name` for all containers.
-
-Run `docker-compose logs` for all logs at once.
-
-Follow the log output by running docker-compose with `logs -f`.
-
-# Redirect port 80 to 443
-
-Since February the 28th 2017 mailcow does come with port 80 and 443 enabled.
-
-Open `mailcow.conf` and set `HTTP_BIND=0.0.0.0`.
-
-Open `data/conf/nginx/site.conf` and add a new "catch-all" site at the top of that file:
-
-```
-server {
-	listen 80 default_server;
-	server_name _;
-	return 301 https://$host$request_uri;
-}
-```
-
-Restart the stack, changed containers will be updated:
-
-`docker-compose up -d`
-
-# Redis
-
-## Connect to redis key store:
-
-```
-docker-compose exec redis-mailcow redis-cli
-```
-
-# Remove persistent data
-
-- Remove volume `mysql-vol-1` to remove all MySQL data.
-- Remove volume `redis-vol-1` to remove all Redis data.
-- Remove volume `vmail-vol-1` to remove all contents of `/var/vmail` mounted to `dovecot-mailcow`.
-- Remove volume `dkim-vol-1` to remove all DKIM keys.
-- Remove volume `rspamd-vol-1` to remove all Rspamd data.
-
-Running `docker-compose down -v` will **destroy all mailcow: dockerized volumes** and delete any related containers.Reset mailcow admin to `admin:moohoo`:
-
-1. Drop admin table
-
-```
-source mailcow.conf
-docker-compose exec mysql-mailcow mysql -u${DBUSER} -p${DBPASS} ${DBNAME} -e "DROP TABLE admin;"
-```
-
-2. Open mailcow UI to auto-init the db
-
-# Rspamd
-
-## Rspamd CLI tools
-
-```
-docker-compose exec rspamd-mailcow rspamc --help
-docker-compose exec rspamd-mailcow rspamadm --help
-```
-
-See [Rspamd documentation](https://rspamd.com/doc/index.html)
-
-# Adjust service configurations
-The most important configuration files are mounted from the host into the related containers:
-```
-data/conf
-├── bind9
-│   └── named.conf
-├── dovecot
-│   ├── dovecot.conf
-│   ├── dovecot-master.passwd
-│   ├── sieve_after
-│   └── sql
-│       ├── dovecot-dict-sql.conf
-│       └── dovecot-mysql.conf
-├── mysql
-│   └── my.cnf
-├── nginx
-│   ├── dynmaps.conf
-│   ├── site.conf
-│   └── templates
-│       ├── listen_plain.template
-│       ├── listen_ssl.template
-│       └── server_name.template
-├── pdns
-│   ├── pdns_custom.lua
-│   └── recursor.conf
-├── postfix
-│   ├── main.cf
-│   ├── master.cf
-│   ├── postscreen_access.cidr
-│   ├── smtp_dsn_filter
-│   └── sql
-│       ├── mysql_relay_recipient_maps.cf
-│       ├── mysql_tls_enforce_in_policy.cf
-│       ├── mysql_tls_enforce_out_policy.cf
-│       ├── mysql_virtual_alias_domain_catchall_maps.cf
-│       ├── mysql_virtual_alias_domain_maps.cf
-│       ├── mysql_virtual_alias_maps.cf
-│       ├── mysql_virtual_domains_maps.cf
-│       ├── mysql_virtual_mailbox_maps.cf
-│       ├── mysql_virtual_relay_domain_maps.cf
-│       ├── mysql_virtual_sender_acl.cf
-│       └── mysql_virtual_spamalias_maps.cf
-├── rmilter
-│   └── rmilter.conf
-├── rspamd
-│   ├── dynmaps
-│   │   ├── authoritative.php
-│   │   ├── settings.php
-│   │   ├── tags.php
-│   │   └── vars.inc.php -> ../../../web/inc/vars.inc.php
-│   ├── local.d
-│   │   ├── dkim.conf
-│   │   ├── metrics.conf
-│   │   ├── options.inc
-│   │   ├── redis.conf
-│   │   ├── rspamd.conf.local
-│   │   └── statistic.conf
-│   ├── lua
-│   │   └── rspamd.local.lua
-│   └── override.d
-│       ├── logging.inc
-│       ├── worker-controller.inc
-│       └── worker-normal.inc
-└── sogo
-    ├── sieve.creds
-    └── sogo.conf
-
-```
-Just change the according configuration file on the host and restart the related service: `docker-compose restart service-mailcow`
-# Tagging
-
-Mailbox users can tag their mail address like in `me+facebook@example.org` and choose between to setups to handle this tag:
-
-1. Move this message to a subfolder "facebook" (will be created lower case if not existing)
-2. Prepend the tag to the subject: "[facebook] Subject"
-# Two-factor authentication
-
-So far two methods for TFA are impelemented. Both work with the fantastic [Yubikey](https://www.yubico.com). 
-
-While Yubi OTP needs an active internet connection and an API ID/key, U2F will work with any FIDO U2F USB key out of the box.
-
-Both methods support mulitple YubiKeys.
-
-As administrator you are able to temporary disable a domain adminsitrators TFA login until they successfully logged in.
-
-The key used to login will be displayed in green, while other keys remain grey.
-
-## Yubi OTP
-
-The Yubi API ID and Key will be checked against the Yubico Cloud API. When setting up TFA you will be asked for your personal API account for this key.
-The API ID, API key and the first 12 characters (your YubiKeys ID in modhex) are stored in the MySQL table as secret.
-
-## U2F
-
-Only Google Chrome (+derivates) and Opera support U2F authentication to this day natively.
-For Firefox you will need to install the "U2F Support Add-on" as provided on [mozilla.org](https://addons.mozilla.org/en-US/firefox/addon/u2f-support-add-on/).
-U2F works without an internet connection.# Why does mailcow come with a DNS resolver?
-
-For DNS blacklist lookups and DNSSEC.
-
-Most systems use either a public or a local caching DNS resolver.
-That's a very bad idea when it comes to filter spam using DNS-based blackhole lists (DNSBL) or similar technics.
-Most if not all providers apply a rate limit based on the DNS resolver that is used to query their service.
-Using a public resolver like Googles 4x8, OpenDNS or any other shared DNS resolver like your ISPs will hit that limit very soon.
-
-
diff --git a/mkdocs.yml b/mkdocs.yml
deleted file mode 100644
index c0b3d9a0..00000000
--- a/mkdocs.yml
+++ /dev/null
@@ -1,9 +0,0 @@
-site_name: "mailcow: dockerized"
-repo_url: https://github.com/andryyy/mailcow-dockerized/
-remote_branch: gh-pages
-theme: readthedocs
-pages:
-    - 'Overview': 'index.md'
-    - 'Installation': 'install.md'
-    - 'First Steps': 'first_steps.md'
-    - 'Usage & Examples': 'u_and_e.md'