Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.73 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.73 KB
Raw

OpenSMTPD-Admin

Web interface for OpenSMTPD that manages credentials for virtual email accounts. Currently limited to only regular users. Extended version with role based access management will be implemented later on. Statistics for password updates and email traffic are provided on a per-user basis.

Requirements

Assuming you have OpenSMTPD configured with virtual user support and some type of database storage, the only external dependencies required are Python 3.11 together with pip. Make sure to install pipenv globally first: pip install --user pipenv. All internal dependencies are handled through pipenv.

Development

Get started with local development in two steps:

Configuration

Replace the values in the provided .env with your desired values:

  • ENVIRONMENT: The environment to run your app in (either development or production)
  • FLASK_DEBUG: Whether to enable debug logging (either True or False)
  • SECRET_KEY: Randomly generated string of characters used to encrypt app data (RTFM)
  • SQLALCHEMY_DATABASE_URI: Connection URI of a SQL database

Installation

Bootstrap and start the application with pipenv

git clone [email protected]:alenmeister/opensmtpd-admin.git
cd opensmtpd-admin
pipenv install --dev --python 3.11
pipenv run uwsgi --http :5000 --wsgi-file wsgi.py --callable app

TODO

  • Use pipenv to manage virtualenvs and packages
  • Validate fields using regex when updating password
  • Add last_changed column to credentials table
  • Implement logic for role based identities
  • Fetch statistics from the reporting API provided by OpenSMTPd
  • Deploy and execute a dry-run on OpenBSD with httpd as proxy