Move documentation to the Wiki and simplify the README

This commit is contained in:
Pierre Jaury
2016-07-31 20:51:05 +02:00
parent c19ba6d69a
commit b8a26baf23
3 changed files with 0 additions and 47 deletions

View File

@@ -15,19 +15,9 @@ 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.
General architecture
====================
The mail infrastructure is based on a standard MTA-LDA pattern :
* Postfix for incoming and outgoing emails ;
* Rmilter as a filtering interface before delivery (with rspamd and ClamAV) ;
* Dovecot as a delivery agent and reading (IMAP) server ;
* Roundcube (or any Webmail) as a user-friendly Web client ;
* Fetchmail as a client to fetch remote accounts (POP/IMAP) ;
* Freeposte (Flask application) as an administration interface.
![Architecture](doc/archi.png)
Running a mail server
=====================
@@ -43,39 +33,3 @@ docker-compose up -d
For a detailed walktrough, see ``INSTALL.md``. Also, see ``MANAGE.md`` for
details about daily maintenance of your mail server.
Development environment
=======================
The administration Web interface requires a proper dev environment that can easily be setup using ``virtualenv`` (make sure you are using Python 3) :
```
cd admin
virtualenv .
source bin/activate
pip install -r requirements.txt
```
You can then export the path to the development database:
```
export SQLALCHEMY_DATABASE_URI=sqlite:///path/to/dev.db
```
And finally run the server with debug enabled:
```
python manage.py runserver
```
Philosophy
==========
The mailserver is designed as a whole, some images are therefore not best
suited for reuse outside this project. All images should however follow
Docker best practices and be as generic as possible :
- even if not suited for reuse, they should be simple enough to
fit as base images for other projects,
- interesting settings should be available as environment variables
- base images should be well-trusted (officiel Alpine or Debian for instance).