README.rst

   1 =============
   2 Mailman Web
   3 =============
   4
   5 This is a Django project that contains default settings and url settings for
   6 Mailman 3 Web Interface. It consists of the following sub-projects:
   7
   8 * Postorius
   9 * Hyperkitty
  10
  11 Install
  12 =======
  13
  14 To install this project, you run::
  15
  16   $ pip install mailman-web
  17
  18 If you want to install the latest development version from Git, run::
  19
  20   $ pip install git+https://gitlab.com/mailman/mailman-web
  21
  22
  23 Changelog
  24 =========
  25
  26 0.0.10 (xxxx-xx-xx)
  27 ~~~~~~~~~~~~~~~~~~~
  28
  29 * Set ``ACCOUNT_EMAIL_UNKNOWN_ACCOUNTS = False`` in settings/mailman.py.
  30   (Closes Postorius #591)
  31
  32 0.0.9 (2024-03-07)
  33 ~~~~~~~~~~~~~~~~~~
  34
  35 * A spurious warning that ``DJANGO_SETTINGS_MODULE`` and ``MAILMAN_WEB_CONFIG``
  36   are both set in the environment is no longer issued.  (Closes #25)
  37 * Paths in urls.py are reordered to avoid redirecting ``mailman3/`` and
  38   ``archives/`` URLs to ``postorius/`` and ``hyperkitty/`` respectively.
  39
  40 0.0.8 (2023-10-22)
  41 ~~~~~~~~~~~~~~~~~~
  42
  43 * Bump min version dependency on django-mailman3, which will clear all existing
  44   django sessions so that changes in session serializer doesn't cause errors.
  45
  46 0.0.7 (2023-10-21)
  47 ~~~~~~~~~~~~~~~~~~
  48
  49 * [**BREAKING**] Reduce the default no. of workers for qrunner to 2. (Fixes #17)
  50 * [**BREAKING**] Due to change in Django's ``SESSION_SERIALIZER``, it will cause
  51   all existing sessions to cause 500 errors, unless they are removed from the
  52   database. To do that, you can upgrade to django-mailman3 1.3.10, which will
  53   remove all current sessions. (See !25)
  54 * Add a new settings module ``mailman_web.settings.dev`` for development purposes.
  55   To use this, you can run ``export DJANGO_SETTINGS_MODULE=mailman_web.settings.dev``
  56   and then run ``mailman-web`` commands for dev purposes.
  57 * Min Python version has been upgraded to 3.9 since the same is required for Core.
  58 * Print a warning if a user sets both ``DJANGO_SETTINGS_MODULE`` and ``MAILMAN_WEB_CONFIG``
  59   as the former overrides the latter. (Fixes #7)
  60 * Migrate to using pyproject.toml and PDM for mailman-web.
  61
  62 Fixes
  63 -----
  64 * Instead of overriding ``PYTHONPATH`` env var always, append to it if it has
  65   already been defined. (Fixes #19)
  66
  67
  68 Project details
  69 ===============
  70
  71 * Project home: https://gitlab.com/mailman/mailman-web
  72 * Report bugs at: https://gitlab.com/mailman/mailman-web/-/issues
  73 * Documentation: https://mailman-web.readthedocs.io/en/latest/
  74 * Mailman Documentation: https://docs.mailman3.org
  75
  76
  77 License
  78 =======
  79
  80 Mailman suite is licensed under the
  81 `GNU GPL v3.0 or later (GPLv3+) <http://www.gnu.org/licenses/gpl-3.0.html>`_
  82
  83 Copyright (C) 2020 by the Free Software Foundation, Inc.