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]] 経由でのみアクセスされるべきです (テスト目的でそれを実行しているマシンから直接アクセスされる場合を除く)。}}

== Configuration ==

The web application is configured in {{ic|/etc/webapps/postorius/settings_local.py}} which is included by the default configuration in {{ic|/usr/share/webapps/postorius/settings.py}}.

{{Note|Postorius should store user sensitive data (e.g. sqlite database) in {{ic|/var/lib/postorius/data/}}, as that directory is only accessible by root and the application itself.}}

Change the default secret for the application:

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

Make sure to disable debugging when running in production:

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

To be able to configure a running [[mailman]] instance configuration options for its REST API have to be added to postorius' configuration.

{{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>}}

Add a valid email configuration (so that the [[Django]] application can verify subscribers):

{{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|The {{ic|DEFAULT_FROM_EMAIL}} and {{ic|SERVER_EMAIL}} configuration options can be used to define the {{ic|From:}} header of mails sent for internal authentication and error reporting (respectively).}}

The valid hosts or domain names for the application need to be defined:

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

== Hosting ==

{{Expansion|Example for a setup using [[Apache HTTP Server]].}}

{{Note|Postorius needs to be run as its own user and group (i.e. {{ic|postorius}}). It is using {{ic|/etc/webapps/postorius/}}, {{ic|/var/lib/postorius/}} and {{ic|/run/postorius/}} for configurations, static caches and (potentially) sockets, respectively.}}

{{Note|As the static files are by default served from a top-level {{ic|static/}} directory, which will conflict with [[hyperkitty]] on the same (sub)domain, it is advisable to set the {{ic|STATIC_URL}} variable in {{ic|/etc/webapps/postorius/settings_local.py}} to something unique (e.g. {{ic|'/postorius_static/'}}).}}

=== Nginx and uWSGI ===

Postorius comes with a working [[uWSGI]] configuration file in {{ic|/etc/uwsgi/postorius.ini}}.

[[Install]] {{Pkg|nginx}} and {{Pkg|uwsgi-plugin-python}}, create a per-application socket for [[uWSGI]] (see [[UWSGI#Accessibility of uWSGI socket]] for reference) and [[enable]] {{ic|uwsgi-secure@postorius.socket}}.

For a local test setup, serving Postorius at http://127.0.0.1:80/postorius add the following [[Nginx]] configuration to your setup:

{{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>}}

== Setup ==

{{Note| Run the following commands as the {{ic|postorius}} user (e.g. using [[sudo]] or [[su]]).}}

After first installation make sure to generate a database:

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

Afterwards, the static data for the application needs to be collected:

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

Create a superuser account for the [[Django]] application:

 [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}} メニューでドメインの設定を変更します。

== See also ==

* [https://postorius.readthedocs.io/en/latest/ Postorius Documentation] - The upstream documentation
* [https://docs.mailman3.org/en/latest/ Mailman Suite Documentation] - The (high level) upstream documentation for the entire Mailman Suite (Mailman, Hyperkitty and Postorius)