From be96941bce7e3ff22a66a88689d29f3700c21092 Mon Sep 17 00:00:00 2001 From: HerHde Date: Sat, 19 Oct 2019 14:49:43 +0200 Subject: [PATCH 1/4] Remove space in front of title --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 0b3e8a521..9036deab7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ - # 🐮 + 🐋 = 💕 +# 🐮 + 🐋 = 💕 ## Help mailcow From 29930dc305900e4d5ccc2e299c2f8cf043f60a72 Mon Sep 17 00:00:00 2001 From: HerHde Date: Sat, 19 Oct 2019 15:05:39 +0200 Subject: [PATCH 2/4] Add links to the mentioned applications --- docs/index.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/index.md b/docs/index.md index 9036deab7..123719c06 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 -- ClamAV (optional) -- Solr (optional) -- Oletools via Olefy -- Memcached -- Redis -- MySQL -- Unbound (DNS resolver) -- PHP-FPM -- Postfix -- ACME-Client -- Nginx -- Rspamd -- SOGo -- Netfilter (Fail2ban-like integration by @mkuron) -- Watchdog (basic monitoring) +- [Dovecot](https://www.dovecot.org/) +- [ClamAV](https://www.clamav.net/) (optional) +- [Solr](http://lucene.apache.org/solr/) (optional) +- Oletools via [Olefy](https://github.com/HeinleinSupport/olefy) +- [Memcached](https://www.memcached.org/) +- [Redis](https://redis.io/) +- [MySQL](https://redis.io/) +- [Unbound](https://unbound.net/) (DNS resolver) +- [PHP-FPM](https://secure.php.net/manual/install.fpm.php) +- [Postfix](http://www.postfix.org/) +- [ACME](https://letsencrypt.org/)-Client +- [Nginx](https://nginx.org/) +- [Rspamd](https://www.rspamd.com/) +- [SOGo](https://sogo.nu/) +- [Netfilter](https://www.netfilter.org/) (Fail2ban-like integration by [@mkuron](https://github.com/mkuron)) +- [Watchdog](https://linux.die.net/man/8/watchdog) (basic monitoring) **Docker volumes** to keep dynamic data - take care of them! From edaa19da92b4558a21a0c5b32761d766114f8227 Mon Sep 17 00:00:00 2001 From: HerHde Date: Sat, 19 Oct 2019 15:21:39 +0200 Subject: [PATCH 3/4] Add simple dev instructions --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cbfe05d9..223d04a6d 100644 --- a/README.md +++ b/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 +``` \ No newline at end of file From 72fb3906fc5e4ca77ec26da9dbb23ffff969d92c Mon Sep 17 00:00:00 2001 From: HerHde Date: Sat, 19 Oct 2019 15:29:51 +0200 Subject: [PATCH 4/4] Remove wrong MySQL link and add MariaDB --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 123719c06..cd9cd9eda 100644 --- a/docs/index.md +++ b/docs/index.md @@ -67,7 +67,7 @@ Each container represents a single application. - Oletools via [Olefy](https://github.com/HeinleinSupport/olefy) - [Memcached](https://www.memcached.org/) - [Redis](https://redis.io/) -- [MySQL](https://redis.io/) +- MySQL (well, actually [MariaDB](https://mariadb.org/)) - [Unbound](https://unbound.net/) (DNS resolver) - [PHP-FPM](https://secure.php.net/manual/install.fpm.php) - [Postfix](http://www.postfix.org/)