WebUI GUI in Flask Python3

This Page contains Ideas about a new WebUI/GUI implementation in Flask/Python3.

Requirements

• Flask/Python3
• Bootstrap
• Fontawesome or other iconset
• Responsive UI
• DB abstraction with SQLAlchemy
  • http://docs.sqlalchemy.org/en/latest/core/engines.html

Install & Upgrade

If you get some Duplicate index warnings - ignore them.

install a new vexim DB

Create a DB and a DB user.

Then simply call:

bash dbreinit.sh <targetDBname>

This will create tables in the DB . If <targetDBname> is ommited, 'veximdbtest' will be used. This script will copy app/models/models_orig.py with the <targetDBname> as DB to app/models/models.py

upgrade an existing vexim2 DB

Migration will be done to a new DB. (in-place-migration is not supported)

Create a DB user for the new DB.

Then call (with 3 parameters):

bash dbmigration-mysql.sh <dumpfile.sql> <originDBname> <targetDBname>

You will be prompted for a target DB host, port, user and password. It will call the bash dbreinit.sh <targetDBname> script in the end. More information can be found inside this script file.

Already implemented

• Full login support for Siteadmin, Postmaster and Users with a role System.

• Intelligent login: try first given login, then add domain from actual URI and try to strip subdomain parts (one by one)

• List-Views for Local Domains

  • Domain name
  • IP where an Relay points to
  • Number of Local Accounts, Account-List-Button, Account-Add-Button
  • Number of Alias Accounts, Account-List-Button, Account-Add-Button
  • Number of Postmasters
  • Number of Aliases pointing to this Domain
  • Domain-Enabled-Button to indicate and change state
  • Domain-Edit-Button
  • Domain-Delete-Button

• List-Views for Alias Domains

  • Domain name
  • Domain name where an Alias points to
  • Domain-Enabled-Button to indicate and change state
  • Domain-Edit-Button
  • Domain-Delete-Button

• List-Views for Relay Domains

  • Domain name
  • Domain-Enabled-Button to indicate and change state
  • Domain-Edit-Button
  • Domain-Delete-Button

• List-Views for Local Accounts

  • Realname
  • Username
  • Loclpart
  • Piped
  • Forwarded
  • Siteadmin
  • Postmaster
  • Account-Enabled-Button to indicate and change state
  • Account-Edit-Button
  • Account-Delete-Button

• View for add/edit Alias Domain

• Enable/Disable for Domains and Accounts.

• Add/Edit/Delete Domain

• Add/Edit/Delete Local Account

• Branding. Logo in header from domain related ressource directory

Wishlist

• List-Views for Local Accounts
  • Quota/Used, with colored %-bar
• Views for different kinds of accounts, add/edit accounts
• Plug-in system
• 2-Factor-Authentication (U2F) for the web-interface.
  • https://blog.miguelgrinberg.com/post/two-factor-authentication-with-flask
  • https://www.twilio.com/docs/authy/tutorials/two-factor-authentication-python-flask
• Authentication backends (ldap, oauth,...)
• easier UI customization
• Flexible config system
• REST API
• Command line interface
  • http://flask.pocoo.org/docs/1.0/cli/
• Installation scripts fot mysql
• Installation scripts fot pgsql
• Instructions for integration in PHP websites

Needed changes

• Add role field to user table
• Add enabled field to domainalias table

Screenshots

Domainlist

Accountlist

Add/edit domain