faq.rst 4.13 KB
Newer Older
1
=================================
2
3
4
5
6
Frequenty Asked Questions (Admin)
=================================

Frequently asked questions by Mailman 3 administrators.

7
8
9
.. contents::
   :depth: 4
   :local:
10
11

1. Confirmation emails to Users has wrong domain name (example.com!)
12
--------------------------------------------------------------------
13

14
15
16
This happens when your reverse (SSL) proxy isn't setting up the correct headers
when proxying requests. Fix this by setting the right ``proxy_set_header``
directives::
17
18
19
20
21
22
23
24

    # For Nginx.
    location / {
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Host $host;
        proxy_pass http://localhost:8000/;
    }

25
26
Appropriate headers for different web servers needs to be set if something
other than Nginx is being used.
27
28
29


2. The domain name displayed in Hyperkitty shows example.com or something else.
30
-------------------------------------------------------------------------------
31

32
33
34
35
The name of the domain comes from the :setting:`django:SITE_ID` which should be
to set to the domain you want to display. If you have Postorius >= 1.3.3 The
Domains view will show you the :setting:`django:SITE_ID` for the domain and has
an `Edit` link the the Django admin UI entry for that site.
36

37
38
39
Otherwise, you can go to the Django admin `Sites` view (``/admin`` or
``/<prefix>/admin``) and see the DOMAIN NAME and DISPLAY NAME for each defined
site, and you can edit the domain name.
Abhilash Raj's avatar
Abhilash Raj committed
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77


3. How to enable debug logging in Mailman Core?
------------------------------------------------

There are a couple of loggers in Mailman Core which can be individually cofigured
with log levels. Available loggers are:

- archiver        --  All archiver output
- bounce          --  All bounce processing logs go here
- config          --  Configuration issues
- database        --  Database logging (SQLAlchemy and Alembic)
- debug           --  Only used for development
- error           --  All exceptions go to this log
- fromusenet      --  Information related to the Usenet to Mailman gateway
- http            --  Internal wsgi-based web interface
- locks           --  Lock state changes
- mischief        --  Various types of hostile activity
- plugins         --  Plugin logs
- runner          --  Runner process start/stops
- smtp            --  SMTP activity
- subscribe       --  Information about leaves/joins
- vette           --  Message vetting information

You can set their log levels by adding the following to your ``mailman.cfg``::

    [logging.http]
    level: DEBUG


4. How to print logs to standard out instead of regular files in Mailman Core?
-------------------------------------------------------------------------------

For each of the available loggers (listed in FAQ #3), you can set the ``path`` 
for each logger separately in ``mailman.cfg``::

   [logging.root]
   path: /dev/stdout
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92


5. What is Mailman-web?
-----------------------

Mailman web is basically a set of configuration files for deploying Mailman's
web frontend packaged in a single Python package. It provides a command line,
``mailman-web`` which can be used to run administrative commands.

If you are familiar with Django, or have seen older versions of this
documentation, ``mailman-web`` command is equivalent of running
``django-admin --pythonpath /etc/mailman3/ --settings settings``. It just makes
it simpler to run administrative commands and simplify user documentation.

See `documentation for Mailman-web <https://mailman-web.readthedocs.io/>`_.
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

6. How to disable signup?
-------------------------

To disable signup/registartion for new users, while continuing to allow signed
up users to login, you can add the following to your ``settings.py``::


  # /etc/mailman3/settings.py
  ACCOUNT_ADAPTER = 'django_mailman3.views.user_adapter.DisableSignupAdapter'


To disable only social account signups, but keep the signups open, you can add
the following to your ``settings.py``::

  # /etc/mailman3/settings.py
  SOCIALACCOUNT_ADAPTER = 'django_mailman3.views.user_adapter.DisableSocialSignupAdapter'

You would need **django-mailman3 >= 1.3.6** for these settings to work.
Abhilash Raj's avatar
Abhilash Raj committed
112
113
114
115
116
117

7. How to change language in Mailman 3?
---------------------------------------

TODO