Skip to main content

Mail client autoconfiguration service

Project description

automx2

Successor to automx, designed to be easier to configure and use. Written by Ralph Seichter for sys4 AG.

This software is considered to be in Alpha state, so make sure to use protection.

Installing

TODO

Configuring

When run by user alice, automx2 attempts to load configuration data from the following files, in the specified order, stopping at the first match:

  1. Value of AUTOMX2_CONF environment variable (if available)
  2. ~alice/.automx2.conf (note the leading dot)
  3. /etc/automx2/automx2.conf
  4. /etc/automx2.conf

While automx2 can be launched without a configuration file, the internal defaults are only suitable for testing, in particular because an in-memory sqlite database will be used, meaning all data is lost once the application terminates.

The file format is an INI variant. An example configuration file is available here. A minimal configuration file for production use only needs to contain one db_uri entry in the defaults section, pointing to a non-transient database.

Database support

This application uses the excellent SQLAlchemy toolkit which supports various SQL dialects. While you probably already have SQLite support available on your local machine, you may need to install additional Python packages for PostgreSQL, MySQL, etc. Detailed instructions to support a particular database dialect are out of scope for this document, but there are numerous guides available.

Launching

Once configured, you can launch the configured application from a shell on UNIX-like systems:

cd /path/to/automx2
contrib/flask.sh run

See flask.sh for a descriptions of additional parameter you can use, like hostname and port.

Web server integration

In a production environment, it is recommended that you run automx2 behind a web server like Apache or NGINX, with your web server acting as a reverse proxy, potentially also providing HTTPS support.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for automx2, version 0.0.1.dev12
Filename, size File type Python version Upload date Hashes
Filename, size automx2-0.0.1.dev12-py3-none-any.whl (28.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size automx2-0.0.1.dev12.tar.gz (12.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page