Scott.Idem/OSIT-Mailman3
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
Files
26c384e7508372ccc0736c0010990e63f161024e
OSIT-Mailman3/web/README.md
Abhilash Raj 32796a5a18 Add separate Readme for each image.
2017-04-07 15:47:36 -07:00

2.4 KiB
Raw Blame History

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.

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

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

  • DJANGO_HOST_IP: IP of the container from which the django will be served. Default value is 172.19.199.3.

  • 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.

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.

Reference in New Issue View Git Blame Copy Permalink