mongo-mail-web 0.1.1

Web UI for Mongo Mail Server

Demo:

• URL: http://188.165.254.60:8083
• Login: [e-mail]
• Password: password

Table of Contents

• Screenshots
• Installation
• Configuration With Environment
• Configuration With local_settings
• TODO
• Contributing

Screenshots

Bootswatch themes

Messages Statistics

Country Map

Multi Top Ten

Messages Tables

Messages Search

Messages show

Metrics tables

Installation

Without Docker

Required:

• MongoDB Server
• Mongo Mail Server
• Python 2.7.6+ (< 3.x)
• python-gevent 1.0+
• recent setuptools and pip installer
• Nginx (optionnal)

Installation:

$ pip install --process-dependency-links mongo-mail-web

OR

$ git clone https://github.com/srault95/mongo-mail-web.git && cd mongo-mail-web
$ pip install --process-dependency-links .

$ mongo-mail-web --help

Create admin user:

$ mongo-mail-web create-superadmin

With Docker

In progress…

See demonstration environment: Mongo Mail Demo

Configuration With Environment

MMW_SETTINGS

Module Setting

Default: mongo_mail_web.settings.Prod

# with command mode
$ export MMW_SETTINGS=mongo_mail_web.settings.Prod

# with docker environ
$ docker run -e MMW_SETTINGS=mongo_mail_web.settings.Prod

# with command arguments
$ mongo-mail-web -c mongo_mail_web.settings.Prod <CMD>

MMW_MONGODB_URI

Default: mongodb://localhost/message

http://docs.mongodb.org/manual/reference/connection-string/

MMW_SUPERADMIN_EMAIL and MMW_SUPERADMIN_PASSWORD

Default: [e-mail] / password

Configuration With local_settings

# local_settings.py in PYTHONPATH or current Path
SECRET_KEY = "A1234"

$ mongo-mail-web -c mongo_mail_web.settings.Custom <CMD>

TODO

• Tests
• Wizard configuration
• Websocket
• Outsourcing jobs to celery to share with Mongo Mail Server
• Specifics features for Filter mode, Turing Filter, Quarantine…
• Purge task
• PDF Exporting
• Mail Reporting
• Rest API

Contributing

To contribute to the project, fork it on GitHub and send a pull request, all contributions and suggestions are welcome.