self-hosted/Mailu
1
0
Fork 0
mirror of https://github.com/Mailu/Mailu.git synced 2025-06-06 23:36:26 +02:00
Code Issues Releases Activity

Add two sections to the README

Browse Source
This commit is contained in:
Pierre Jaury 2016-07-31 20:52:02 +02:00
parent b8a26baf23
commit 93aad40a25
1 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -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 at little cost while running only FOSS, applying the KISS principle and being
able to fine-tune some details if needed. 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 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 is a proper system with Docker and Compose installed, then simply download
the ``docker-compose.yml`` and sample ``freeposte.env``, tune them to your the ``docker-compose.yml`` and sample ``freeposte.env``, tune them to your
needs and fire up the mail server: needs and fire up the mail server:
@ -31,5 +41,14 @@ needs and fire up the mail server:
docker-compose up -d docker-compose up -d
``` ```
For a detailed walktrough, see ``INSTALL.md``. Also, see ``MANAGE.md`` for For a detailed walktrough, see the [Setup Guide](https://github.com/kaiyou/freeposte.io/wiki/Setup-Guide).
details about daily maintenance of your mail server.
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).