Public | Automated Build

Last pushed: 5 days ago
Short Description
GNU Mailman 3 web frontend, includes Postorius & Hyperkitty.
Full Description

Mailman 3 Web UI

This image consists of Mailman3's Web UI(Postorius) and Archiver
(Hyperkitty). This image is built from latest sources on gitlab. In future,
latest and stable releases will be seperate. I am looking forward to the release
of Mailman Suite 3.1 before that.

Configuration

These are the settings that you MUST change before deploying:

  • SERVE_FROM_DOMAIN: The domain name from which Django will be served. To be
    added to ALLOWED_HOSTS in django settings. Default value is not set. This
    also replaces Django's default example.com SITE and becomes the default SITE
    (with SITE_ID=1).

  • HYPERKITTY_API_KEY: Hyperkitty's API Key, should be set to the same value as
    set for the mailman-core.

  • MAILMAN_ADMIN_USER: The username for the admin user to be created by default.

  • MAILMAN_ADMIN_EMAIL: The email for the admin user to be created by default.

  • SECRET_KEY: Django's secret key, mainly used for signing cookies and others.

These are the settings that are set to sane default and you do not need to
change them unless you know what you want.

  • DATABASE_URL: URL of the type
    driver://user:password@hostname:port/databasename for the django to use. If
    not set, the default is set to
    sqlite:///opt/mailman-web-data/mailmanweb.db. The standard
    docker-compose.yaml comes with it set to a postgres database. It is not must
    to change this if you are happy with postgresql.

  • MAILMAN_REST_URL: The URL to the Mailman core's REST API server. Defaut
    value is http://mailman-core:8001.

  • MAILMAN_REST_USER: Mailman's REST API username. Default value is restadmin

  • MAILMAN_REST_PASSWORD: Mailman's REST API user's password. Default value is
    restpass

  • MAILMAN_HOST_IP: IP of the Container from which Mailman will send emails to
    hyperkitty (django). Set to 172.19.199.2 by default.

  • SMTP_HOST: IP Address/hostname from which you will be sending
    emails. Default value is 172.19.199.1, which is the address of the Host OS.

  • SMTP_PORT: Port used for SMTP. Default is 25.

  • DJANGO_LOG_URL: Path to the django's log file. Defaults to
    /opt/mailman-web-data/logs/mailmanweb.log.

  • DJANGO_ALLOWED_HOSTS: Entry to add to ALLOWED_HOSTS in Django
    configuration. This is a separate configuration fromSERVE_FROM_DOMAIN as
    latter is used for other purposes too.

Running

It is highly recommended that you run this using the docker-compose.yaml
provided in the github repo of this project. You will need to proxy the
requests the container that you create with this image using an actual web
server like Nginx. The github repo provides the setup instructions for
Nginx.

Since the setup has USE_SSL set to True in django's settings.py, you may
also want to get a SSL certificate if you don't already have one. Lets
Encrypt
provides free SSL certiticates for everyone and there are some
instructions about that also.

After the first run, you can create a superuser for django using the following
command:

    $ docker exec -it mailman-web python manage.py createsuperuser
Docker Pull Command
Owner
maxking
Source Repository