docs/index.rst

   1 =======================================
   2 Welcome to Mailman Web's documentation!
   3 =======================================
   4
   5 Mailman 3 web is an umbrella Django project that combines all the web
   6 components of Mailman 3 into a single project that can be installed with a
   7 single command ``mailman-web`` instead of different Django commands.
   8
   9
  10 Install
  11 =======
  12
  13 To install ``mailman-web`` using ``pip`` run the following command::
  14
  15   $ pip install mailman-web
  16
  17
  18 Settings
  19 ========
  20
  21 Mailman Web can be customized using a configuration file at
  22 ``/etc/mailman3/settings.py``. You can change the path to configuration path by
  23 changing ``MAILMAN_WEB_CONFIG`` environment variable.
  24
  25 You can start with a simple configuration file:
  26
  27 .. include:: settings.py
  28     :literal:
  29
  30 You can see a list of all the default configurations supported:
  31
  32 .. toctree::
  33    :maxdepth: 2
  34
  35    settings
  36
  37
  38 Usage
  39 =====
  40
  41 To run Django's development server, you can try::
  42
  43   $ mailman-web migrate
  44   $ mailman-web runserver
  45
  46
  47 Important Links
  48 ===============
  49
  50 * Issue Tracker: https://gitlab.com/mailman/mailman-web/issues
  51 * Documentation: https://mailman-web.readthedocs.io/
  52 * Mailman Suite: https://docs.mailman3.org/
  53 * Mailman Project: https://list.org