Merge pull request #168 from HerHde/master

Added links, simple instructions for development and a minor fix

README.md

@@ -2,7 +2,13 @@
 
 # mailcow: dockerized documentation
 
-
 This project aims to provide the mailcow: dockerized documention for the [mailcow: dockerized](https://github.com/mailcow/mailcow-dockerized) project.
 
 https://mailcow.github.io/mailcow-dockerized-docs
+
+To build it locally, you need the [Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/), [MkDocs](https://www.mkdocs.org/) itself and [Pygments](http://pygments.org/). To install these with [pip](https://pip.pypa.io/en/stable/) and get it up and running, fire up your terminal and enter
+
+```
+pip install mkdocs-material
+mkdocs serve
+```

docs/index.md

@@ -1,4 +1,4 @@
- # 🐮 + 🐋 = 💕
+# 🐮 + 🐋 = 💕
 
 ## Help mailcow
 
@@ -41,7 +41,7 @@ You can find a demo at [demo.mailcow.email](https://demo.mailcow.email), use the
 
 The integrated **mailcow UI** allows administrative work on your mail server instance as well as separated domain administrator and mailbox user access:
 
-- DKIM and ARC support
+- [DKIM](http://dkim.org) and [ARC](http://arc-spec.org/) support
 - Black- and whitelists per domain and per user
 - Spam score management per-user (reject spam, mark spam, greylist)
 - Allow mailbox users to create temporary spam aliases
@@ -61,22 +61,22 @@ The integrated **mailcow UI** allows administrative work on your mail server ins
 mailcow: dockerized comes with multiple containers linked in one bridged network.
 Each container represents a single application.
 
-- Dovecot
+- [Dovecot](https://www.dovecot.org/)
-- ClamAV (optional)
+- [ClamAV](https://www.clamav.net/) (optional)
-- Solr (optional)
+- [Solr](http://lucene.apache.org/solr/) (optional)
-- Oletools via Olefy
+- Oletools via [Olefy](https://github.com/HeinleinSupport/olefy)
-- Memcached
+- [Memcached](https://www.memcached.org/)
-- Redis
+- [Redis](https://redis.io/)
-- MySQL
+- MySQL (well, actually [MariaDB](https://mariadb.org/))
-- Unbound (DNS resolver)
+- [Unbound](https://unbound.net/) (DNS resolver)
-- PHP-FPM
+- [PHP-FPM](https://secure.php.net/manual/install.fpm.php)
-- Postfix
+- [Postfix](http://www.postfix.org/)
-- ACME-Client
+- [ACME](https://letsencrypt.org/)-Client
-- Nginx
+- [Nginx](https://nginx.org/)
-- Rspamd
+- [Rspamd](https://www.rspamd.com/)
-- SOGo
+- [SOGo](https://sogo.nu/)
-- Netfilter (Fail2ban-like integration by @mkuron)
+- [Netfilter](https://www.netfilter.org/) (Fail2ban-like integration by [@mkuron](https://github.com/mkuron))
-- Watchdog (basic monitoring)
+- [Watchdog](https://linux.die.net/man/8/watchdog) (basic monitoring)
 
 **Docker volumes** to keep dynamic data - take care of them!