<commit_before>============================
Web UI for Mongo Mail Server
============================

|pypi downloads| |pypi dev_status| |pypi version| |pypi licence| |pypi py_versions|

**Demo:**

- URL: http://192.168.3.11:8083
- Login: <EMAIL>
- Password: password

.. contents:: **Table of Contents**
    :depth: 1
    :backlinks: none

UI
==

Bootswatch themes
-----------------

.. image:: http://espace-groupware.com/docs/mongo-mail/img/mongo-mail-web-dashboards-mini.png
   :align: center

   
Messages Statistics
-------------------

.. image:: http://espace-groupware.com/docs/mongo-mail/img/dashboard-default-tb.png
   :align: center

   
Country Map
-----------

.. image:: http://espace-groupware.com/docs/mongo-mail/img/dashboard-country-tb.png
   :align: center


Multi Top Ten
-------------
   
.. image:: http://espace-groupware.com/docs/mongo-mail/img/dashboard-top-ten-tb.png
   :align: center

   
Messages Tables
---------------

.. image:: http://espace-groupware.com/docs/mongo-mail/img/message-table-tb.png
   :align: center

Messages Search
---------------

.. image:: http://espace-groupware.com/docs/mongo-mail/img/message-table-search-tb.png
   :align: center



Messages show
-------------
   
.. image:: http://espace-groupware.com/docs/mongo-mail/img/show-message-tb.png
   :align: center

   
Metrics tables
--------------

.. image:: http://espace-groupware.com/docs/mongo-mail/img/metrics-table-tb.png
   :align: center

   
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:**

.. code:: bash

    $ pip install mongo-mail-web

    $ mongo-mail-web --help

With Docker
-----------

In progress...

See demonstration environment: `Mongo Mail Demo`_

Configuration With Environment
==============================

MMW_SETTINGS
------------

Module Setting 

Default: mongo_mail_web.settings.Prod

.. code:: bash

    # 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>
    <commit_msg>fix install<commit_after>============================
Web UI for Mongo Mail Server
============================

|pypi downloads| |pypi dev_status| |pypi version| |pypi licence| |pypi py_versions|

**Demo:**

- URL: http://192.168.3.11:8083
- Login: <EMAIL>
- Password: password

.. contents:: **Table of Contents**
    :depth: 1
    :backlinks: none

UI
==

Bootswatch themes
-----------------

.. image:: http://espace-groupware.com/docs/mongo-mail/img/mongo-mail-web-dashboards-mini.png
   :align: center

   
Messages Statistics
-------------------

.. image:: http://espace-groupware.com/docs/mongo-mail/img/dashboard-default-tb.png
   :align: center

   
Country Map
-----------

.. image:: http://espace-groupware.com/docs/mongo-mail/img/dashboard-country-tb.png
   :align: center


Multi Top Ten
-------------
   
.. image:: http://espace-groupware.com/docs/mongo-mail/img/dashboard-top-ten-tb.png
   :align: center

   
Messages Tables
---------------

.. image:: http://espace-groupware.com/docs/mongo-mail/img/message-table-tb.png
   :align: center

Messages Search
---------------

.. image:: http://espace-groupware.com/docs/mongo-mail/img/message-table-search-tb.png
   :align: center



Messages show
-------------
   
.. image:: http://espace-groupware.com/docs/mongo-mail/img/show-message-tb.png
   :align: center

   
Metrics tables
--------------

.. image:: http://espace-groupware.com/docs/mongo-mail/img/metrics-table-tb.png
   :align: center

   
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:**

.. code:: bash

    # fix in progress...
    # $ pip install mongo-mail-web
    
    $ git clone https://github.com/srault95/mongo-mail-web.git
    $ cd mongo-mail-web
    $ python setup.py install 

    $ mongo-mail-web --help

With Docker
-----------

In progress...

See demonstration environment: `Mongo Mail Demo`_

Configuration With Environment
==============================

MMW_SETTINGS
------------

Module Setting 

Default: mongo_mail_web.settings.Prod

.. code:: bash

    # 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>
    
{'fraction_non_alphanumeric': 0.2259554808903822, 'fraction_numerical': 0.00881982360352793, 'mean_word_length': 2.486822840409956, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 7, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3971405', 'n_tokens_mistral': 1642, 'n_tokens_neox': 1549, 'n_words': 312}