Sign inSign up

oled01/automx2

By oled01

•Updated over 1 year ago

Mail User Agent (email client) configuration made easy.

Image
Integration & delivery
0

851

oled01/automx2 repository overview

⁠automx2: Mail User Agent (email client) configuration made easy

⁠Source and documentation

This software is neither developed nor maintained by me. I just made the container. Find the source here⁠ and the documentation here⁠.

⁠Kubernetes and Helm

This container is used in my Helm chart collection⁠.

⁠Docker Setup (docker-compose)

Create a config file like described here⁠ and put it under ./automx2config/provider.json. No need to persist the database. It will be created on every container restart from ./automx2config/provider.json which needs to be mounted to /etc/automx2 in the container. If you wish to persist the database anyway for whatever reason, just add an volume for it and mount it to /var/lib/automx2/. There MUST be two files in your local config folder: provider.json and automx2.conf.

automx2.conf:

[automx2]
# A typical production setup would use loglevel WARNING.
loglevel = DEBUG
# Echo SQL commands into log? Used for debugging.
db_echo = no
# In-memory SQLite database
db_uri = sqlite:///:memory:

# SQLite database in a UNIX-like file system
#db_uri = sqlite:////var/lib/automx2/db.sqlite

# MySQL database on a remote server. This example does not use an encrypted
# connection and is therefore *not* recommended for production use.
#db_uri = mysql://username:[email protected]/db

# Number of proxy servers between automx2 and the client (default: 0).
# If your logs only show 127.0.0.1 or ::1 as the source IP for incoming
# connections, proxy_count probably needs to be changed.
proxy_count = 1

NOTE: It is not recommended to change the db_uri to an persisted path because the start script initialises the db on every pod restart.

provider.json:

{
  "provider": "Example Inc.",
  "domains": ["example.com", "example.net", "example.org"],
  "servers": [
    {"type": "imap", "name": "imap.example.com"},
    {"type": "smtp", "name": "smtp.example.com"},
    {"type": "caldav", "port": 443,
     "url": "https://www.example.net/SOGo/dav/%EMAILADDRESS%/Calendar/personal/"},
    {"type": "carddav", "port": 443,
     "url": "https://www.example.net/SOGo/dav/%EMAILADDRESS%/Contacts/personal/"}
  ]
}
service:
    automx2:
        container_name: automx2
        environment:
            FLASK_APP: automx2.server:app
            FLASK_CONFIG: production
        ports:
            - "4243:4243"
        volumes:
            - ./automx2config:/etc/automx2
        networks:
            - gx_network

Copyright © 2019-2025 Ralph Seichter

automx2 is licensed under the GNU General Public License V3 or later. The project is hosted on GitHub in the rseichter/automx2⁠ repository and published on PyPI.org⁠.

Tag summary

Content type

Image

Digest

sha256:05d3e398e…

Size

252.5 MB

Last updated

over 1 year ago

docker pull oled01/automx2:2025.1.1