From 93aad40a25479d0f714bbe9471fc9991e6264e51 Mon Sep 17 00:00:00 2001 From: Pierre Jaury Date: Sun, 31 Jul 2016 20:52:02 +0200 Subject: [PATCH] Add two sections to the README --- README.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b38bdc30..93936ef8 100644 --- a/README.md +++ b/README.md @@ -15,14 +15,24 @@ same level of functionality and still be able to host a complete mail server at little cost while running only FOSS, applying the KISS principle and being able to fine-tune some details if needed. +Features +======== +Main features include: +- **Standard email server**, IMAP and IMAP+, SMTP and Submission +- **Web access**, Roundcube-based Webmail and adminitration interface +- **User features**, aliases, auto-reply, auto-forward, fetched accounts +- **Admin features**, global admins, per-domain delegation, quotas +- **Security**, enforced TLS, outgoing DKIM, anti-virus scanner +- **Antispam**, auto-learn, greylisting, DMARC and SPF +![Creating a new user](http://freeposte.io/screenshots/create.png) Running a mail server ===================== -Freeposte runs on top of Docker for easy packaging and upgrades. All you need +Freeposte.io runs on top of Docker for easy packaging and upgrades. All you need is a proper system with Docker and Compose installed, then simply download the ``docker-compose.yml`` and sample ``freeposte.env``, tune them to your needs and fire up the mail server: @@ -31,5 +41,14 @@ needs and fire up the mail server: docker-compose up -d ``` -For a detailed walktrough, see ``INSTALL.md``. Also, see ``MANAGE.md`` for -details about daily maintenance of your mail server. +For a detailed walktrough, see the [Setup Guide](https://github.com/kaiyou/freeposte.io/wiki/Setup-Guide). + +Contributing +============ + +Freeposte.io is free software, open to suggestions and contributions. All +components are free software and compatible with the MIT license. All +specific configuration files, Dockerfiles and code are placed under the +MIT license. + +For details, see the [Contributor Guide](https://github.com/kaiyou/freeposte.io/wiki/Contributors-Guide).