Postorius is a Django-based web user interface for Mailman 3, which makes it easier to manage mailing lists. In this tutorial, we will guide you through the steps involved in installing Postorius on Debian Latest.
Before we start, you need to have the following requirements:
First, log in to your Debian system and update your system packages to the latest version by running the following command:
sudo apt update && sudo apt upgrade
Next, to run Postorius, you need to install some necessary packages, including:
Run the following command to install the required packages:
sudo apt install django python3-django-postorius python3-dev python3-pip
Generate a new Django project using the following command:
django-admin startproject postorius
Navigate to the project directory:
cd postorius
To configure Postorius, we need to create a new Django app using the following command:
python3 manage.py startapp postorius_settings
Next, we will create a new file named postorius_settings.py in the newly created directory postorius_settings.
nano postorius_settings.py
Add the following code to the file:
from django.urls import reverse_lazy
INSTALLED_APPS += [
'postorius',
'django_mailman3',
]
MIDDLEWARE += [
'postorius.middleware.PostoriusCommonMiddleware',
'postorius.middleware.PostoriusAllAuthMiddleware',
]
# Load the overridden default urls of both django-mailman3 and postorius.
ROOT_URLCONF = 'postorius_settings.urls'
# Verify the email sent from mailman is DKIM signed.
MAILMAN_ARCHIVER_VERP_DELIMITER = '-'
# Setup the authentication backend and email backend to use mailman authentication and mailman SMTP server.
AUTHENTICATION_BACKENDS = (
'allauth.account.auth_backends.AuthenticationBackend',
'django_mailman3.auth_backends.MailmanCoreBackend',
)
ALLAUTH_ACCOUNT_AUTHENTICATION_METHOD = 'username_email'
ALLAUTH_ACCOUNT_EMAIL_REQUIRED = True
ALLAUTH_ACCOUNT_USERNAME_REQUIRED = True
# URL of the Mailman core:
MAILMAN_REST_API_URL = 'http://localhost:8001/3.1/'
# Always redirect to the login page if the user is not authenticated.
LOGIN_REDIRECT_URL = reverse_lazy('postorius_list_index')
# Setup mailman related configurations
MAILMAN_ARCHIVER_API_KEY = 'REST API key of the mailman-archives'
MAILMAN_API_USER = 'username'
MAILMAN_API_PASS = 'password'
MAILMAN_API_URL = MAILMAN_REST_API_URL
Update the following values in the postorius_settings.py file to match your environment settings:
We need to create a new file urls.py in the postorius_settings directory using the following command:
nano postorius_settings/urls.py
Insert the following code in the file:
from django.urls import include, path
from postorius.views import IndexView
urlpatterns = [
path('admin/', include('django.contrib.admin.urls')),
path('', IndexView.as_view(), name='index'),
path('lists/', include('postorius.urls')),
path('accounts/', include('allauth.urls')),
]
In this step, run the following command in your project root directory to create database tables:
python3 manage.py migrate --run-syncdb
Create an initial superuser account using the following command:
python3 manage.py createsuperuser
Enter a username, email, and password for the new superuser.
Start the Django development server using the following command:
python3 manage.py runserver
Open your web browser and navigate to http://localhost:8000.
Postorius should now be running. You can log in with your superuser account and create new mailing lists or manage existing ones.
Congratulations! You have successfully installed Postorius on Debian Latest.
If you want to self-host in an easy, hands free way, need an external IP address, or simply want your data in your own hands, give IPv6.rs a try!
