Automx2: Unterschied zwischen den Versionen

pymysql

$ python3 --version
Python 3.9.9

automx2
/srv/web/automx2
# useradd --home-dir /srv/web/automx2 --create-home automx2

# bash -c 'mkdir -p /srv/web/automx2 && chown automx2 /srv/web/automx2'

cd /srv/web/automx2
wget https://github.com/rseichter/automx2/raw/master/contrib/setupvenv.sh
chmod u+x setupvenv.sh

.venv
./setupvenv.sh

.venv/bin
source .venv/bin/activate
pip install automx2

--upgrade
cd /srv/web/automx2
source .venv/bin/activate
pip install --upgrade automx2

%EMAILADDRESS%
env  : AUTOMX2_CONF  
file : ~/.automx2.conf
file : /etc/automx2/automx2.conf
file : /etc/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. 

# connection and is therefore *not* recommended for production use.
#db_uri = mysql://username:password@server.example.com/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

curl http://127.0.0.1:4243/initdb/

curl 'http://127.0.0.1:4243/mail/config-v1.1.xml?emailaddress=user@example.com'

?
contrib
/initdb/
alembic.ini
[automx2]
db_uri = sqlite:////var/lib/automx2/db.sqlite

curl http://127.0.0.1:4243/initdb/

PROVIDER_NAME='Example Inc.'
PROVIDER_SHORTNAME='Example'
PROVIDER_ID=100

DOM='example'
TLD='com'

sqlite3
db_uri
CREATE DATABASE `automx2` COLLATE 'utf8mb4_general_ci';

[automx2]
db_uri = mysql+pymysql://user:pass@dbhost/automx2?charset=utf8mb4

curl http://127.0.0.1:4243/initdb/

RELEASE
export RELEASE="2021.6"
wget https://github.com/rseichter/automx2/archive/refs/tags/$RELEASE.zip
unzip $RELEASE.zip
cd automx2-$RELEASE/alembic

alembic.ini
source /path/to/automx2/.venv/bin/activate
make upgrade

PYTHONPATH=.. 

Running automx2 version 2021.6
INFO  [alembic.runtime.migration] Context impl SQLiteImpl.
INFO  [alembic.runtime.migration] Will assume non-transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade  -> f62e64b43d2f, DB schema for automx2 version 2020.0
Created: 2020-01-17 22:30:05.748651
INFO  [alembic.runtime.migration] Running upgrade f62e64b43d2f -> 5334f8a8282c, Add "prio" column to "server" table.
Created: 2020-12-15 15:04:49.371802
INFO  [alembic.runtime.migration] Running upgrade 5334f8a8282c -> 43ebb40d0578, DAV server support

https://autoconfig.thunderbird.net/v1.1/example.com
https://autoconfig.example.com/mail/config-v1.1.xml?emailaddress=alice@example.com
https://example.com/.well-known/autoconfig/mail/config-v1.1.xml
http://autoconfig.thunderbird.net/v1.1/example.com
http://autoconfig.example.com/mail/config-v1.1.xml?emailaddress=alice@example.com
http://example.com/.well-known/autoconfig/mail/config-v1.1.xml

https://example.com/autodiscover/autodiscover.xml
https://autodiscover.example.com/autodiscover/autodiscover.xml
http://autodiscover.example.com/autodiscover/autodiscover.xml

dns: autodiscover.example.com
dns: _autodiscover._tcp.example.com

CNAME
service.example-provider.com
SRV
_autodiscover._tcp.example.com.  0   443 service.example-provider.com.

SRV
service.example-provider.com
443
_imap._tcp.example.com          SRV  10  20  143  mail.example.com.
_imaps._tcp.example.com         SRV  0   1   993  .
_pop3._tcp.example.com          SRV  0   1   110  .
_pop3s._tcp.example.com         SRV  0   1   995  .
_smtp._tcp.example.com.         SRV  0   1   25   .
_submission._tcp.example.com.   SRV  10  20  587  mail.example.com.

automx2
automx2.conf
/etc/systemd/system/automx2.service
[Unit]
After=network.target
Description=MUA configuration service
Documentation=https://rseichter.github.io/automx2/

[Service]
Environment=FLASK_APP=automx2.server:app
Environment=FLASK_CONFIG=production
ExecStart=/srv/www/automx2/bin/flask run --host=127.0.0.1 --port=4243
Restart=always
User=automx2
WorkingDirectory=/var/lib/automx2

[Install]
WantedBy=multi-user.target

sudo systemctl daemon-reload

sudo systemctl status automx2
● automx2.service - MUA configuration service
     Loaded: loaded (/etc/systemd/system/automx2.service; disabled; vendor preset: enabled)
     Active: inactive (dead)

sudo systemctl enable automx2 --now
Created symlink /etc/systemd/system/multi-user.target.wants/automx2.service → /etc/systemd/system/automx2.service.

sudo systemctl status automx2
● automx2.service - MUA configuration service
     Loaded: loaded (/etc/systemd/system/automx2.service; enabled; vendor preset: enabled)
     Active: active (running) since Mon 2021-03-01 12:54:31 CET; 19s ago
   Main PID: 126966 (python)
      Tasks: 1 (limit: 4620)
     Memory: 46.1M
     CGroup: /system.slice/automx2.service
             └─126966 /srv/www/automx2/bin/flask run --host=127.0.0.1 --port=4243
[...]
Mar 01 12:54:32 mail python[126966]: Reading /etc/automx2.conf
Mar 01 12:54:32 mail python[126966]: Config.get: loglevel = WARNING
Mar 01 12:54:32 mail python[126966]:  * Running on http://127.0.0.1:4243/ (Press CTRL+C to quit)

.venv/scripts/flask.sh
cd /srv/web/automx2
.venv/scripts/flask.sh run --host=127.0.0.1 --port=4243

curl 'http://127.0.0.1:4243/mail/config-v1.1.xml?emailaddress=user@example.com'
<clientConfig version="1.1">
    <emailProvider id="automx2-100">
        <identity/>
        <domain>example.com</domain>
        <displayName>Example Inc.</displayName>
        <displayShortName>Example</displayShortName>
        <incomingServer type="imap">
            <hostname>mail.example.com</hostname>
            <port>993</port>
            <socketType>SSL</socketType>
            <username>%EMAILADDRESS%</username>
            <authentication>plain</authentication>
        </incomingServer>
        <incomingServer type="pop3">
            <hostname>mail.example.com</hostname>
            <port>110</port>
            <socketType>STARTTLS</socketType>
            <username>%EMAILADDRESS%</username>
            <authentication>plain</authentication>
        </incomingServer>
        <outgoingServer type="smtp">
            <hostname>mail.example.com</hostname>
            <port>587</port>
            <socketType>STARTTLS</socketType>
            <username>%EMAILADDRESS%</username>
            <authentication>plain</authentication>
        </outgoingServer>
    </emailProvider>
</clientConfig>

proxy_count
[automx2]
# A typical production setup would use loglevel = WARNING
loglevel = WARNING

# Disable SQL command echo.  
db_echo = no

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

# 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

ProxyPreserveHost
# Apache 2.4 example configuration snippet to forward incoming requests to automx2.
# vim:ts=4:sw=4:et:ft=apache

<VirtualHost *:80>
    ServerName autoconfig.example.com
    ServerAlias autodiscover.example.com
    ProxyPreserveHost On
    ProxyPass "/" "http://127.0.0.1:4243/"
    ProxyPassReverse "/" "http://127.0.0.1:4243/"
    <Location /initdb>
        # Limit access to clients connecting from localhost
        Order Deny,Allow
        Deny from all
        Allow from 127.0.0.1
    </Location>
</VirtualHost>

@@ Zeile 75: / Zeile 75: @@
 == Optionen ==
 = Konfiguration =
+automx2 verwendet eine Datei, um Laufzeitanweisungen zu lesen, und eine Datenbank, um Konfigurationsdaten für E-Mail-Konten nachzuschlagen.
+=== Platzhalter  ===
+Um die Konfiguration bequemer zu machen, unterstützt automx2 [https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat#Placeholders Platzhalter im Mozilla-Stil ].
+* Zum Beispiel die Zeichenfolge <tt>%EMAILADDRESS%</tt>in Datenbankeinträgen wird durch die bei der Abfrage angegebene E-Mail-Adresse ersetzt.
+* Obwohl automx2 auf einer proprietären Funktion von Autoconfig basiert, wendet es Platzhalter auch auf Autodiscover- und Mobileconfig-Antworten an.
+=== Laufzeitkonfiguration  ===
+Die Konfigurationsdatei definiert das Laufzeitverhalten von automx2 und gibt das Backend an, aus dem automx2 die Konfigurationsdaten des Postfachkontos lesen soll.
+{|| class="wikitable sortable"
+|-
+|| Läuft ohne Laufzeitkonfiguration
+Wenn Sie automx2 ohne Konfigurationsdatei starten, verwendet es interne Standardeinstellungen.
+* Diese sind nur zum Testen geeignet.
+* Wird es ohne Konfiguration gestartet, verwendet es eine In-Memory-SQLite-Datenbank und alle Daten gehen verloren, sobald die Anwendung beendet wird.
+|-
+|}
+Während des Starts sucht automx2 an den folgenden Stellen nach Anweisungen zur Laufzeitkonfiguration.
+* Die erste Übereinstimmung bestimmt die verwendete Konfiguration.
+ env  : AUTOMX2_CONF
+ file : ~/.automx2.conf
+ file : /etc/automx2/automx2.conf
+ file : /etc/automx2.conf
+{|| class="wikitable sortable"
+|-
+|| Falls vorhanden, muss die Umgebungsvariable AUTOMX2_CONF auf den absoluten Pfad einer Konfigurationsdatei zeigen.
+|-
+|}
+Um Parameter und Optionen anzugeben, verwendet automx2 eine [https://docs.python.org/3.9/library/configparser.html#supported-ini-file-structure INI Dateisyntax ].
+* Die [https://github.com/rseichter/automx2/blob/master/contrib/automx2-sample.conf Beispiel Konfiguration ], die mit automx2 geliefert wird, sieht so aus:
+ [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:password@server.example.com/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
+Platzieren Sie den Inhalt der Beispielkonfiguration an einem der von automx2 gesuchten Konfigurationsorte und passen Sie ihn an Ihre Bedürfnisse an.
+* Konfigurieren Sie dann das Datenbank-Backend mit Daten, die zu Ihrem Setup passen, wie unten beschrieben.
+=== Automx2 eigenständig testen  ===
+Wenn Sie überprüfen möchten, ob eine Vanilla-Installation von automx2 funktioniert, können Sie sie mit internen Testdaten füllen.
+* Starten Sie automx2 wie im Abschnitt [https://rseichter.github.io/automx2/#run Ausführen von automx2 ]und senden Sie die folgende Anfrage, um Ihre Datenbank zu füllen:
+ curl http://127.0.0.1:4243/initdb/
+Dieses Beispiel geht davon aus, dass Sie automx2 auf localhost ausführen und TCP-Port 4243 abhören, was der vorgeschlagene Standardport ist.
+Nachdem Sie die Datenbank mit Beispieldaten gefüllt haben, können Sie testen, ob automx2 funktioniert.
+* Verwenden Sie curl, um eine Kontokonfigurationsanforderung für user@example.com zu senden:
+ curl 'http://127.0.0.1:4243/mail/config-v1.1.xml?emailaddress=user@example.com'
+Achten Sie, wie im Beispiel gezeigt, darauf, die URL nach Bedarf in Anführungszeichen zu setzen.
+* Andernfalls führt Ihre Befehlsshell möglicherweise einen Musterabgleich für Zeichen wie das Fragezeichen durch <tt>?</tt>(FISCH tut es).
+=== Datenbankkonfiguration  ===
+automx2 verwendet das SQLAlchemy-Toolkit, um auf Datenbanken zuzugreifen.
+* Dadurch können verschiedene Datenbanken, auch [https://docs.sqlalchemy.org/en/latest/dialects/ Dialekte genannt ], verwendet werden, indem einfach die entsprechende Verbindungs-URL definiert wird.
+{|| class="wikitable sortable"
+|-
+|| API-basierte Konfiguration
+Ich erwäge das Hinzufügen einer API für Konfigurationsänderungen in einer kommenden Version, habe aber noch nicht entschieden, wann dies geschehen könnte.
+* können Sie mich gerne kontaktieren [https://rseichter.github.io/automx2/#sponsorship Patenschaft ].
+|-
+|}
+==== Datenbankunterstützung  ====
+Während Sie wahrscheinlich bereits SQLite-Unterstützung auf Ihrem lokalen Computer haben, müssen Sie möglicherweise zusätzliche Python-Pakete für PostgreSQL, MySQL usw.
+* installieren.
+* Detaillierte Anweisungen zur Unterstützung eines bestimmten Datenbankdialekts sind in diesem Dokument nicht enthalten.
+* Bitte suchen Sie im Internet nach detaillierten Anweisungen zur Unterstützung eines bestimmten Dialekts.
+* Die SQLAlchemy-Dokumentation bietet einen nützlichen Ausgangspunkt.
+Während <tt>contrib</tt>Verzeichnis Beispieldatenbankschemata enthält, die Sie als Referenz verwenden können, empfehle ich die Verwendung der integrierten Methode, um die erforderliche DB-Struktur von Grund auf neu zu erstellen, indem Sie auf die zugreifen <tt>/initdb/</tt>Dienstendpunkt.
+* Dadurch wird die Datenbank auch mit einigen Beispieldaten gefüllt.
+Wenn Sie von einer frühen automx2-Version aktualisieren und Ihre vorhandene Datenbank migrieren möchten, können Sie die integrierte Alembic-Unterstützung verwenden.
+* Dies erfordert jedoch das Klonen des Git-Repositorys, das Ändern <tt>alembic.ini</tt>und Aufrufen der Migration von der Befehlszeile.
+* Es ist normalerweise einfacher, Ihre vorhandenen Daten zu exportieren, eine neue DB zu erstellen und die Daten zu importieren.
+==== SQLite  ====
+Dieser Abschnitt zeigt, was Sie tun müssen, um SQLite Version 3 oder höher als Backend-Datenbank für automx2 zu verwenden.
+Schritt 1: Legen Sie den Datenbank-URI in Ihrer automx2-Konfiguration fest.
+* Bitte beachten Sie, dass die Angabe eines absoluten Pfades für die Datenbank insgesamt vier Schrägstriche nach der Schema-Kennung erfordert:
+ [automx2]
+ db_uri = sqlite:////var/lib/automx2/db.sqlite
+Schritt 2: Starten Sie automx2 und greifen Sie auf die DB-Initialisierungs-URL zu:
+ curl http://127.0.0.1:4243/initdb/
+Das Git-Repository enthält ein [https://rseichter.github.io/contrib/sqlite-generate.sh sqlite-generate.sh-Hilfsskript ], das demonstriert, wie die Datenbank programmgesteuert gefüllt werden kann.
+* Sie müssen nur wenige Einstellungen Ihren Bedürfnissen anpassen:
+ PROVIDER_NAME='Example Inc.'
+ PROVIDER_SHORTNAME='Example'
+ PROVIDER_ID=100
+ DOM='example'
+ TLD='com'
+Das Skript gibt die SQL-Anweisungen auf der Standardausgabe aus, an die weitergeleitet werden kann <tt>sqlite3</tt>zum Bearbeiten.
+* Stellen Sie sicher, dass die automx2.conf übereinstimmt <tt>db_uri</tt>Einstellung bei der Angabe der Datenbank.
+contrib/sqlite-generate.sh | sqlite3 /var/lib/automx2/db.sqlite
+Sobald Sie die Datenbank gefüllt haben, ist automx2 betriebsbereit.
+==== MySQL  ====
+Schritt 1: Erstellen Sie eine Datenbank.
+ CREATE DATABASE `automx2` COLLATE 'utf8mb4_general_ci';
+Schritt 2: Legen Sie den Datenbank-URI in Ihrer automx2-Konfiguration fest.
+* Das folgende Beispiel verwendet ''pymysql ''als DB-Treiber, der nicht in der automx2-Distribution enthalten ist.
+ [automx2]
+ db_uri = mysql+pymysql://user:pass@dbhost/automx2?charset=utf8mb4
+Schritt 3: Starten Sie automx2 und greifen Sie auf die DB-Initialisierungs-URL zu:
+ curl http://127.0.0.1:4243/initdb/
+=== Destillierkolben  ===
+Wie in einem vorherigen Abschnitt erwähnt, können Sie [https://alembic.sqlalchemy.org/ Alembic ], um Ihre Datenbank zu erstellen oder zu aktualisieren.
+* Sie müssen Ihren ersten Lauf mit einer leeren Datenbank starten, damit dies funktioniert, da Alembic Versionsinformationen in dieser Datenbank speichert.
+* Datenbank-Upgrades basieren auf diesen Informationen.
+* Befolgen Sie die nachstehenden Schritte, um die einzustellen <tt>RELEASE</tt>-Variable zum GitHub-Tag oder zur Release-Nummer Ihrer Wahl.
+ export RELEASE="2021.6"
+ wget https://github.com/rseichter/automx2/archive/refs/tags/$RELEASE.zip
+ unzip $RELEASE.zip
+ cd automx2-$RELEASE/alembic
+Ändern Sie als Nächstes den Wert für ''sqlalchemy.url ''in <tt>alembic.ini</tt>passend zu Ihrer automx2-Konfiguration.
+* Erstellen Sie eine leere Datenbank, es sei denn, Sie verwenden SQLite.
+* In diesem Fall erstellt Alembic die Datenbank für Sie.
+* Die letzten Schritte sind die Aktivierung der virtuellen Python-Umgebung automx2 und das Aufrufen ''von make ''.
+ source /path/to/automx2/.venv/bin/activate
+ make upgrade
+Sie sollten eine Ausgabe ähnlich der folgenden sehen:
+ PYTHONPATH=..
+* FLASK_APP=automx2.server:app flask db upgrade -d .
+ Running automx2 version 2021.6
+ INFO  [alembic.runtime.migration] Context impl SQLiteImpl.
+ INFO  [alembic.runtime.migration] Will assume non-transactional DDL.
+ INFO  [alembic.runtime.migration] Running upgrade  -> f62e64b43d2f, DB schema for automx2 version 2020.0
+ Created: 2020-01-17 22:30:05.748651
+ INFO  [alembic.runtime.migration] Running upgrade f62e64b43d2f -> 5334f8a8282c, Add "prio" column to "server" table.
+ Created: 2020-12-15 15:04:49.371802
+ INFO  [alembic.runtime.migration] Running upgrade 5334f8a8282c -> 43ebb40d0578, DAV server support
 == Dateien ==

Automx2: Unterschied zwischen den Versionen

Version vom 17. März 2022, 13:41 Uhr

Beschreibung

Wie funktioniert automx2?

Installation

Syntax

Parameter

Optionen

Konfiguration

Platzhalter

Laufzeitkonfiguration

Automx2 eigenständig testen

Datenbankkonfiguration

Datenbankunterstützung

SQLite

MySQL

Destillierkolben

Dateien

Anwendungen

Dokumentation

Man-Pages

Info-Pages

Links

Intern

Weblinks

Testfragen

TMP

Wie funktioniert die automatische Konfiguration?

Autokonfig

Automatische Erkennung

Mobileconfig

DNS-SRV-Ressourceneinträge

Ausführen von automx2

Als Systemdienst

Manuell aus einer Shell

Automx2 lokal testen

Konfigurieren eines Webservers

Apache