Postoriusのソースを表示

[[Category:メールサーバー]]
[[Category:ウェブアプリケーション]]
[[en:Postorius]]
[https://gitlab.com/mailman/postorius Postorius] は、[[Mailman]] の管理インターフェースのための [[Django]] ベースのツールです。

== インストール ==

Postorius を使うためには、動作する [[ウェブサーバー]] のセットアップが必要です (例えば、[[Apache HTTP Server|Apache]] を使って [[wikipedia:Wsgi|WSGI]] に直接転送するか、[[Nginx]] を使ってリクエストを [[UWSGI]] のようなアプリケーションサーバーに転送します。)

{{Pkg|postorius}} パッケージを [[インストール]] します。

{{Warning|Postorius は、パスワードやユーザーデータをネットワークに公開してしまうため、[[TLS]] 経由でのみアクセスされるべきです (テスト目的でそれを実行しているマシンから直接アクセスされる場合を除く。)}}

== 設定 ==

Web アプリケーションは、{{ic|/etc/webapps/postorius/settings_local.py}} で設定されます。これは、{{ic|/usr/share/webapps/postorius/settings.py}} のデフォルト設定に含まれています。

{{Note|Postorius は、ユーザーの機密データ (sqlite データベースなど) を {{ic|/var/lib/postorius/data/}} に保存する必要があります。このディレクトリには root とアプリケーション自体だけがアクセスできるためです。}}

アプリケーションのデフォルトのシークレットを変更します。

{{hc|/etc/webapps/postorius/settings_local.py|2=
SECRET_KEY = <nowiki>'</nowiki>''something-very-secret''<nowiki>'</nowiki>
}}

運用環境で実行する場合は、必ずデバッグを無効にしてください。

{{hc|/etc/webapps/postorius/settings_local.py|2=
DEBUG = False
}}

実行中の [[mailman]] インスタンスを設定できるようにするには、REST API の設定オプションを postorius の構成に追加する必要があります。

{{hc|/etc/webapps/postorius/settings_local.py|<nowiki>
MAILMAN_REST_API_URL = 'http://localhost:8001'
MAILMAN_REST_API_USER = 'rest_admin'
MAILMAN_REST_API_PASS = 'rest_admin_password'
</nowiki>}}

有効な電子メール設定を追加します ([[Django]] アプリケーションが購読者を確認できるようにします)。

{{hc|/etc/webapps/postorius/settings_local.py|2=
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = 'localhost'
EMAIL_PORT = 25
EMAIL_HOST_USER = ''username''
EMAIL_HOST_PASSWORD = ''password''
}}

{{Note|{{ic|DEFAULT_FROM_EMAIL}} および {{ic|SERVER_EMAIL}} 設定オプションを使用して、それぞれ内部認証とエラー報告のために送信されるメールの {{ic|From:}} ヘッダーを定義できます。}}

アプリケーションの有効なホスト名またはドメイン名を定義する必要があります。

{{hc|/etc/webapps/postorius/settings_local.py|2=
ALLOWED_HOSTS = [
    'localhost',
    'lists.example.com'
]
}}

== ホスティング ==

{{Expansion|[[Apache HTTP Server]] を使ったセットアップの例。}}

{{Note|Postorius はそれ自身のユーザーとグループ (すなわち {{ic|postorius}}) として実行する必要があります。それは設定、静的キャッシュ、および (潜在的に) ソケットのためにそれぞれ {{ic|/etc/webapps/postorius/}}, {{ic|/var/lib/postorius/}}, および {{ic|/run/postorius/}} を使用しています。}}

{{Note|静的ファイルはデフォルトでトップレベルの {{ic|static/}} ディレクトリから提供され、同じ (サブ) ドメイン上の [[hyperkitty]] と競合するため、{{ic|/etc/webapps/postorius/settings_local.py}} の {{ic|STATIC_URL}} 変数をユニークなもの (例: {{ic|'/postorius_static/'}}) に設定することをお勧めします。}}

=== Nginx と uWSGI ===

Postorius は {{ic|/etc/uwsgi/postorius.ini}} にある動作する [[uWSGI]] 設定ファイルが付属しています。

{{Pkg|nginx}} と {{Pkg|uwsgi-plugin-python}} を[[インストール]]し、[[uWSGI]] のアプリケーションごとのソケットを作成し ([[UWSGI#Accessibility of uWSGI socket]] を参照)、{{ic|uwsgi-secure@postorius.socket}} を[[有効化]]してください。

ローカルのテストセットアップで、http://127.0.0.1:80/postorius で Postorius を提供するには、以下の [[Nginx]] 設定をセットアップに追加します:

{{hc|/etc/nginx/postorius.conf|<nowiki>
server {
  listen 80;
  server_name localhost;
  charset utf-8;
  client_max_body_size 75M;
  root /usr/share/webapps/postorius;
  access_log /var/log/nginx/access.postorius.log;
  error_log /var/log/nginx/error.postorius.log;

  location /postorius_static {
    alias /var/lib/postorius/static;
  }

  location ~^/(accounts|admin|postorius)/(.*)$ {
    include /etc/nginx/uwsgi_params;
    uwsgi_pass unix:/run/postorius/postorius.sock;
  }
}
</nowiki>}}

== セットアップ ==

{{Note| 以下のコマンドは {{ic|postorius}} ユーザーとして実行してください (例: [[sudo]] または [[su]] を使用して)。}}

初回インストール後、データベースを生成することを確認してください:

 [postorius]$ django-admin migrate --pythonpath /usr/share/webapps/postorius/ --settings settings

その後、アプリケーションの静的データを収集する必要があります:

 [postorius]$ django-admin collectstatic --pythonpath /usr/share/webapps/postorius/ --settings settings

[[Django]] アプリケーションのスーパーユーザーアカウントを作成します:

 [postorius]$ django-admin createsuperuser --pythonpath /usr/share/webapps/postorius/ --settings settings

== ヒントとテクニック ==

=== エイリアスドメインを設定する ===

[[postfix]] と共に [http://www.postfix.org/ADDRESS_CLASS_README.html#virtual_alias_class 仮想エイリアスドメイン] のセットアップでドメインを使用するためには、ドメインの {{ic|Alias Domain}} を設定する必要があります。ドメイン名は実在しなくても構いません。

{{ic|Alias Domain}} を設定するためには、管理ユーザーでログインします (デフォルトでは {{ic|postorius}}) し、{{ic|Domains}} メニューでドメインの設定を変更します。

== 参照 ==

* [https://postorius.readthedocs.io/en/latest/ Postorius ドキュメンテーション] - アップストリームのドキュメンテーション
* [https://docs.mailman3.org/en/latest/ Mailman Suite ドキュメンテーション] - Mailman Suite (Mailman, Hyperkitty および Postorius) 全体に関する (高レベルの) アップストリームドキュメンテーション