Skip to content

Commit

Permalink
Add two sections to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
kaiyou committed Jul 31, 2016
1 parent b8a26ba commit 93aad40
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Expand Up @@ -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:
Expand All @@ -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).

0 comments on commit 93aad40

Please sign in to comment.