Move documentation to the Wiki and simplify the README

master
Pierre Jaury 8 years ago
parent c19ba6d69a
commit b8a26baf23

@ -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 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.
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 Running a mail server
===================== =====================
@ -43,39 +33,3 @@ docker-compose up -d
For a detailed walktrough, see ``INSTALL.md``. Also, see ``MANAGE.md`` for For a detailed walktrough, see ``INSTALL.md``. Also, see ``MANAGE.md`` for
details about daily maintenance of your mail server. 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).

Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

@ -1 +0,0 @@
<mxfile userAgent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.102 Safari/537.36" version="5.5.0.1" editor="www.draw.io" type="device"><diagram>7Vzvk5q8Fv5r9mMZIAmQj+52t70z3enebuftvR9RssoUxQHcH+9f3xNIEJKoqIhdZ3VGIZADPM/J+ZXoFbqZv37JwuXsPo1YcuXa0esV+nzlug52MXzxlreqxSdO1TDN4kictG54jP9lotEWras4YnnrxCJNkyJethsn6WLBJkWrLcyy9KV92lOatK+6DKfyiuuGx0mY6K2/4qiYVa2B663bv7J4OpNXdjxaHRmHk9/TLF0txPWuXPRUvqrD81DKEg+az8IofWk0oVvANUtTkMy35q83LOHYStiqfncbjtb3nbGFuLftHeAQ7/AcJivx6DdJzPtWd1e8SUSgG4APO9cvs7hgj8twwo+8AP/QNivmCew5sLlMwnjxaVzKu55mYcTF3aRJmsEJi3TBm5/iJJFNgFDweUSu4Q6vxc2wrGBSlfQHKpvE03xh6ZwV2RucIjtIZIXmOVQw89LgUZwya1BIRFsoNGdaS16jBxsCQDOYSAPzezFj2ZXrJXCV6yh+hs0p38xZBk+ZyyMguHHwYrB3qdgfAHthcBrYP6zGSTwxgD9OYJAmcV78DfhTeN31hD+R5lPgj/3h8Cca/vdh8gK3biAgCotwHOZg4C8Lfw+dD3/hmRr4/8iX4TzSwOwEIWAHz9ARwmvC36dRYeQLxRoAwsDgC8P56J93BqGqhUNC6OguUI5x0MaFHOE/5nFSrB0jSG0efW8q6/ttrxeI/SHw1t2eCe/P6TObQEh5EXgjGVWcIcJzdDdnwvsXG/OsI0sXBYNM4CJgd4kY2zKlG863ObpzM1oVnnZNVuM65LgwPXeEiCEQFyZsB+J3GWPLNC+YFacbQdfCP5OkUTSP+c42ETuixPfFpkyVdpEpDM5RZOqBzRZWxtwtb8Vd6zqaTGDobU6nNiYAHZmFIsmSb07ekngRQdzQMRGYgnouDLTSW3vEad2gBXmRpb9Zo4Pt2YGN+4oWRJe6MqbpgbSsTT2Q2nOUHgg/eTI9uJ2HcdI1qbtkUh1fD0lOxaq82x2m+gHM9FP8epmucciQ21Dl63cUHdEVCJt3P7kI9zDZXzIGA7V7zeyShrevFCXqOucQw7tbhnfHismMm9/LHOBD1jAMpczH/34DtPS65CIa8ckmruZJmOdQbW6BWHVgkTbXpMAAQtNVVjLRiL2LMJsyeVoZwulwNeCQj26CI2NJWMTP7dswYSSu8JDGfAqoruu3yfAUkKubF32ac02KGNlPjiJFTPW8mpiSrvqRuzGoZy/DMijGbBcGBTZYarPEGFkOdmyXeNUn0vV/G+Hdue164f3JbssNbMsWIstPAdEJyNej3Huwi1EM7vR87Jc3tZl9xdz5CglCYv/ke54VIM8hgUNdm9qS7DpHFVjuSz6hbUEBtTybgG45xA8oFvlo/9zLyneD+//cjx72Jr7h/Q5TAVGwaqlASeKHCe/IpJ7VfLv/OTyT9eqTDkzKQYUVkGRy2P/w3XSlfWlVBWkDv0di9RUnj2ch1mCldwSlWDIk4Q6GItalIqI5mlhyOmL1vPggYnO4pUI/o2y+g4zjKN8s7nEf0lWTR4ciHQUHhl6aIKxoT4+kG5bdfAfOoaN9kOftj9YdRlrm67XFOxWtoDEWpcT3qOtBNI399jQacrHlIQ/bYHN9iI5krLc36Uq8jVzXwhDZoaD6JKfTAcPSHzG9Pwj5RhddgvwXsE+UJXFIhqjviF/D0iIWxVAIPFs5pBrwB8fSh2fHvmtRmJND4AVwQJF3oFsmtG0EYP2wRWzXg7zJx9gL5EzvDjIBbR7+1Kct+QklL+bL+ridlolEbK0alcANndu3/Emqhbx4+vSUAz9H6pqhcrMaz2NQphRqmcPYk/1jhA9n0pux0eeqqzjCsCp0KPZ35XuKjYDRfDL2Hct2EFieAOYWqIcFvbXaYcsPAg/oQY7je1gox9Hs245VUw+fqtwe2ddrd19//nx4PCP3pcXsXLirxZ6A+8AiMOAxjEU+shUHQokF3gMTqBUGUMiTmnEs9WD2LZtbG1R9dvNLBzAvU5bWNNcw8YUheShd20epriN1pgUIZ6Nu+zQLjBzLg4V09att6CSDvY9emIy2ULB+CTunXnfvOHL746jzzz1yrlfxDjPU7DUu/gfbtsVnjvne/49SCUPhfbv3/tCInjRCL/8N6bpF2NjkfbvnJsFWoKT17L8goNjluli3N9OqIBmGnoBbvcrHuR3KyouktRWWbfDQEhs1jJGBS+90OhRZiHowiYqhHAAFAaGIdS6ALJ8n3o5vEwI1AyVp7ko2hPsWRTYkYgTmahGVy4Klc1erSj1yr1f3zs19mXx2/gVZHZ/0zj2SNq9RxaE+LDtzqVN+9xSEQ8Zn1TL5t6JEPZJ95lKfqY6/o5I7WPKtXonXRGB5hu84MDopPrTU4qumStaSjmYXdtf/I1Cdvv6zBnT7Bw==</diagram></mxfile>
Loading…
Cancel
Save