From 8bdc0c71afc1944000a8226c6c29a8a16bbcd035 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Wed, 14 Nov 2018 14:58:54 +0200 Subject: [PATCH 01/26] Allow for setting a different DB flavor --- core/admin/mailu/configuration.py | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/core/admin/mailu/configuration.py b/core/admin/mailu/configuration.py index 48599d5e..05df8b1f 100644 --- a/core/admin/mailu/configuration.py +++ b/core/admin/mailu/configuration.py @@ -3,8 +3,6 @@ import os DEFAULT_CONFIG = { # Specific to the admin UI - 'SQLALCHEMY_DATABASE_URI': 'sqlite:////data/main.db', - 'SQLALCHEMY_TRACK_MODIFICATIONS': False, 'DOCKER_SOCKET': 'unix:///var/run/docker.sock', 'BABEL_DEFAULT_LOCALE': 'en', 'BABEL_DEFAULT_TIMEZONE': 'UTC', @@ -14,6 +12,14 @@ DEFAULT_CONFIG = { 'DEBUG': False, 'DOMAIN_REGISTRATION': False, 'TEMPLATES_AUTO_RELOAD': True, + # Database settings + 'DB_FLAVOR': 'sqlite', + 'DB_USER': 'mailu', + 'DB_PW': '', + 'DB_URL': 'database', + 'DB_NAME': 'mailu', + 'SQLALCHEMY_DATABASE_URI': 'sqlite:////data/main.db', + 'SQLALCHEMY_TRACK_MODIFICATIONS': False, # Statistics management 'INSTANCE_ID_PATH': '/data/instance', 'STATS_ENDPOINT': '0.{}.stats.mailu.io', @@ -67,8 +73,15 @@ class ConfigManager(dict): key: os.environ.get(key, value) for key, value in DEFAULT_CONFIG.items() }) + if self.config['SQL_FLAVOR'] != 'sqlite' + self.setsql() app.config = self + def setsql(self) + if not self.config['DB_PW'] + self.config['DB_PW'] = self.config['SECRET_KEY'] + self.config['SQLALCHEMY_DATABASE_URI'] = '{driver}://{user}:{pw}@{url}/{db}'.format(driver=DB_FLAVOR,user=DB_USER,pw=DB_PW,url=DB_URL,db=DB_NAME) + def setdefault(self, key, value): if key not in self.config: self.config[key] = value From 79246cf2a3fd08ef58eb484f9eabf9c483a11282 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Sun, 18 Nov 2018 18:35:13 +0200 Subject: [PATCH 02/26] Create Postgresql image --- optional/postgresql/Dockerfile | 23 +++++++ optional/postgresql/conf/pg_hba.conf | 90 ++++++++++++++++++++++++++ optional/postgresql/conf/pg_ident.conf | 45 +++++++++++++ optional/postgresql/conf/queries.sql | 26 ++++++++ optional/postgresql/start.py | 37 +++++++++++ tests/build.yml | 4 ++ 6 files changed, 225 insertions(+) create mode 100644 optional/postgresql/Dockerfile create mode 100644 optional/postgresql/conf/pg_hba.conf create mode 100644 optional/postgresql/conf/pg_ident.conf create mode 100644 optional/postgresql/conf/queries.sql create mode 100755 optional/postgresql/start.py diff --git a/optional/postgresql/Dockerfile b/optional/postgresql/Dockerfile new file mode 100644 index 00000000..dbfc1dc8 --- /dev/null +++ b/optional/postgresql/Dockerfile @@ -0,0 +1,23 @@ +FROM alpine:3.8 +# python3 shared with most images +RUN apk add --no-cache \ + python3 py3-pip \ + && pip3 install --upgrade pip +# Shared layer between rspamd, postfix, dovecot, unbound and nginx +RUN pip3 install jinja2 +# Image specific layers under this line +RUN apk add --no-cache \ + postgresql postgresql-libs \ + && apk add --virtual .build-deps gcc musl-dev postgresql-dev python3-dev \ + && pip3 install psycopg2 anosql \ + && apk --purge del .build-deps + +COPY start.py /start.py +COPY conf /conf + +ENV LANG en_US.UTF-8 +EXPOSE 5432 + +RUN mkdir -p /run/postgresql && chown -R postgres:postgres /run/postgresql && chmod 2777 /run/postgresql + +CMD /start.py diff --git a/optional/postgresql/conf/pg_hba.conf b/optional/postgresql/conf/pg_hba.conf new file mode 100644 index 00000000..ca566f1f --- /dev/null +++ b/optional/postgresql/conf/pg_hba.conf @@ -0,0 +1,90 @@ +# PostgreSQL Client Authentication Configuration File +# =================================================== +# +# Refer to the "Client Authentication" section in the PostgreSQL +# documentation for a complete description of this file. A short +# synopsis follows. +# +# This file controls: which hosts are allowed to connect, how clients +# are authenticated, which PostgreSQL user names they can use, which +# databases they can access. Records take one of these forms: +# +# local DATABASE USER METHOD [OPTIONS] +# host DATABASE USER ADDRESS METHOD [OPTIONS] +# hostssl DATABASE USER ADDRESS METHOD [OPTIONS] +# hostnossl DATABASE USER ADDRESS METHOD [OPTIONS] +# +# (The uppercase items must be replaced by actual values.) +# +# The first field is the connection type: "local" is a Unix-domain +# socket, "host" is either a plain or SSL-encrypted TCP/IP socket, +# "hostssl" is an SSL-encrypted TCP/IP socket, and "hostnossl" is a +# plain TCP/IP socket. +# +# DATABASE can be "all", "sameuser", "samerole", "replication", a +# database name, or a comma-separated list thereof. The "all" +# keyword does not match "replication". Access to replication +# must be enabled in a separate record (see example below). +# +# USER can be "all", a user name, a group name prefixed with "+", or a +# comma-separated list thereof. In both the DATABASE and USER fields +# you can also write a file name prefixed with "@" to include names +# from a separate file. +# +# ADDRESS specifies the set of hosts the record matches. It can be a +# host name, or it is made up of an IP address and a CIDR mask that is +# an integer (between 0 and 32 (IPv4) or 128 (IPv6) inclusive) that +# specifies the number of significant bits in the mask. A host name +# that starts with a dot (.) matches a suffix of the actual host name. +# Alternatively, you can write an IP address and netmask in separate +# columns to specify the set of hosts. Instead of a CIDR-address, you +# can write "samehost" to match any of the server's own IP addresses, +# or "samenet" to match any address in any subnet that the server is +# directly connected to. +# +# METHOD can be "trust", "reject", "md5", "password", "scram-sha-256", +# "gss", "sspi", "ident", "peer", "pam", "ldap", "radius" or "cert". +# Note that "password" sends passwords in clear text; "md5" or +# "scram-sha-256" are preferred since they send encrypted passwords. +# +# OPTIONS are a set of options for the authentication in the format +# NAME=VALUE. The available options depend on the different +# authentication methods -- refer to the "Client Authentication" +# section in the documentation for a list of which options are +# available for which authentication methods. +# +# Database and user names containing spaces, commas, quotes and other +# special characters must be quoted. Quoting one of the keywords +# "all", "sameuser", "samerole" or "replication" makes the name lose +# its special character, and just match a database or username with +# that name. +# +# This file is read on server startup and when the server receives a +# SIGHUP signal. If you edit the file on a running system, you have to +# SIGHUP the server for the changes to take effect, run "pg_ctl reload", +# or execute "SELECT pg_reload_conf()". +# +# Put your actual configuration here +# ---------------------------------- +# +# If you want to allow non-local connections, you need to add more +# "host" records. In that case you will also need to make PostgreSQL +# listen on a non-local interface via the listen_addresses +# configuration parameter, or via the -i or -h command line switches. + + + +# TYPE DATABASE USER ADDRESS METHOD + +# "local" is for Unix domain socket connections only +local all all peer map=local +# IPv4 connections: +host all mailu {{ SUBNET }} md5 +host postgres health 127.0.0.1/32 md5 +# IPv6 local connections: +host all all ::1/128 reject +# Allow replication connections from localhost, by a user with the +# replication privilege. +local replication all reject +host replication all 127.0.0.1/32 reject +host replication all ::1/128 reject diff --git a/optional/postgresql/conf/pg_ident.conf b/optional/postgresql/conf/pg_ident.conf new file mode 100644 index 00000000..dcfa34f3 --- /dev/null +++ b/optional/postgresql/conf/pg_ident.conf @@ -0,0 +1,45 @@ +# PostgreSQL User Name Maps +# ========================= +# +# Refer to the PostgreSQL documentation, chapter "Client +# Authentication" for a complete description. A short synopsis +# follows. +# +# This file controls PostgreSQL user name mapping. It maps external +# user names to their corresponding PostgreSQL user names. Records +# are of the form: +# +# MAPNAME SYSTEM-USERNAME PG-USERNAME +# +# (The uppercase quantities must be replaced by actual values.) +# +# MAPNAME is the (otherwise freely chosen) map name that was used in +# pg_hba.conf. SYSTEM-USERNAME is the detected user name of the +# client. PG-USERNAME is the requested PostgreSQL user name. The +# existence of a record specifies that SYSTEM-USERNAME may connect as +# PG-USERNAME. +# +# If SYSTEM-USERNAME starts with a slash (/), it will be treated as a +# regular expression. Optionally this can contain a capture (a +# parenthesized subexpression). The substring matching the capture +# will be substituted for \1 (backslash-one) if present in +# PG-USERNAME. +# +# Multiple maps may be specified in this file and used by pg_hba.conf. +# +# No map names are defined in the default configuration. If all +# system user names and PostgreSQL user names are the same, you don't +# need anything in this file. +# +# This file is read on server startup and when the postmaster receives +# a SIGHUP signal. If you edit the file on a running system, you have +# to SIGHUP the postmaster for the changes to take effect. You can +# use "pg_ctl reload" to do that. + +# Put your actual configuration here +# ---------------------------------- + +# MAPNAME SYSTEM-USERNAME PG-USERNAME +local postgres postgres +local root postgres +local root health diff --git a/optional/postgresql/conf/queries.sql b/optional/postgresql/conf/queries.sql new file mode 100644 index 00000000..ffea716b --- /dev/null +++ b/optional/postgresql/conf/queries.sql @@ -0,0 +1,26 @@ +-- name: create_user! +-- Create the mailu user if it does not exist. +do $$ +begin + create user mailu; + exception when others then + raise notice 'not creating mailu user -- it already exists'; +end +$$; + +-- name: update_pw! +alter + user mailu + password :pw; + +-- name: check_db +-- check if the mailu db exists +select 1 + from pg_database + where datname = 'mailu'; + +-- name: create_db! +-- create the mailu db +create + database mailu + owner mailu; diff --git a/optional/postgresql/start.py b/optional/postgresql/start.py new file mode 100755 index 00000000..f8bfc7d9 --- /dev/null +++ b/optional/postgresql/start.py @@ -0,0 +1,37 @@ +#!/usr/bin/python3 + +import anosql +import psycopg2 +import jinja2 +import glob +import os + +def setup(): + conn = psycopg2.connect('user=postgres') + queries = anosql.load_queries('postgres', '/conf/queries.sql') + queries.create_user(conn) + queries.update_pw(conn, pw=os.environ.get("SECRET_KEY")) + conn.commit() + # create db cannot be atomic. But this script is the only active connection, this is kinda safe. + if not queries.check_db(conn): + conn.set_isolation_level(0) + queries.create_db(conn) + conn.set_isolation_level(1) + conn.close() + +# Bootstrap the database if postgresql is running for the first time +if not os.path.exists('/var/lib/postgresql/data/pg_hba.conf'): + os.system("chown -R postgres:postgres /var/lib/postgresql") + os.system("su - postgres -c 'initdb -D /var/lib/postgresql/data'") + +convert = lambda src, dst: open(dst, "w").write(jinja2.Template(open(src).read()).render(**os.environ)) +for pg_file in glob.glob("/conf/*.conf"): + convert(pg_file, os.path.join("/var/lib/postgresql/data", os.path.basename(pg_file))) + +# Run postgresql locally for DB and user creation +os.system("su - postgres -c 'pg_ctl start -D /var/lib/postgresql/data -o \"-h localhost\"'") +setup() +os.system("su - postgres -c 'pg_ctl stop -m smart -w -D /var/lib/postgresql/data'") + +# Run postgresql service +os.system("su - postgres -c 'postgres -D /var/lib/postgresql/data -h \*'") diff --git a/tests/build.yml b/tests/build.yml index 8603e4af..2cd0663c 100644 --- a/tests/build.yml +++ b/tests/build.yml @@ -34,6 +34,10 @@ services: image: ${DOCKER_ORG:-mailu}/admin:${MAILU_VERSION:-local} build: ../core/admin + postgresql: + image: ${DOCKER_ORG:-mailu}/postgresql:${MAILU_VERSION:-local} + build: ../optional/postgresql + roundcube: image: ${DOCKER_ORG:-mailu}/roundcube:${MAILU_VERSION:-local} build: ../webmails/roundcube From a2b5b4d2e039be609f01df71f2c141dac56ec382 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Sun, 18 Nov 2018 23:48:20 +0200 Subject: [PATCH 03/26] Declare the data volume properly --- optional/postgresql/Dockerfile | 8 ++++++-- optional/postgresql/start.py | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/optional/postgresql/Dockerfile b/optional/postgresql/Dockerfile index dbfc1dc8..14d11864 100644 --- a/optional/postgresql/Dockerfile +++ b/optional/postgresql/Dockerfile @@ -16,8 +16,12 @@ COPY start.py /start.py COPY conf /conf ENV LANG en_US.UTF-8 + +RUN mkdir -p /var/lib/postgresql/data /run/postgresql \ + && chown -R postgres:postgres /var/lib/postgresql/data /run/postgresql \ + && chmod 2777 /run/postgresql + +VOLUME /var/lib/postgresql/data EXPOSE 5432 -RUN mkdir -p /run/postgresql && chown -R postgres:postgres /run/postgresql && chmod 2777 /run/postgresql - CMD /start.py diff --git a/optional/postgresql/start.py b/optional/postgresql/start.py index f8bfc7d9..5880765e 100755 --- a/optional/postgresql/start.py +++ b/optional/postgresql/start.py @@ -20,7 +20,7 @@ def setup(): conn.close() # Bootstrap the database if postgresql is running for the first time -if not os.path.exists('/var/lib/postgresql/data/pg_hba.conf'): +if not os.path.exists('/var/lib/postgresql/data/pg_wal'): os.system("chown -R postgres:postgres /var/lib/postgresql") os.system("su - postgres -c 'initdb -D /var/lib/postgresql/data'") From 2ced0205133105733a650bf21860d79e5855aacd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Mon, 19 Nov 2018 11:55:41 +0200 Subject: [PATCH 04/26] Create user for healthcheck --- optional/postgresql/conf/queries.sql | 14 ++++++++++++-- optional/postgresql/start.py | 5 ++++- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/optional/postgresql/conf/queries.sql b/optional/postgresql/conf/queries.sql index ffea716b..0aea23b3 100644 --- a/optional/postgresql/conf/queries.sql +++ b/optional/postgresql/conf/queries.sql @@ -1,10 +1,20 @@ --- name: create_user! +-- name: create_mailu_user! -- Create the mailu user if it does not exist. do $$ begin create user mailu; exception when others then - raise notice 'not creating mailu user -- it already exists'; + raise notice 'mailu user not created -- already exists'; +end +$$; + +-- name: create_health_user! +-- Create the mailu user if it does not exist. +do $$ +begin + create user health; + exception when others then + raise notice 'health user not created -- already exists'; end $$; diff --git a/optional/postgresql/start.py b/optional/postgresql/start.py index 5880765e..80c70904 100755 --- a/optional/postgresql/start.py +++ b/optional/postgresql/start.py @@ -9,8 +9,11 @@ import os def setup(): conn = psycopg2.connect('user=postgres') queries = anosql.load_queries('postgres', '/conf/queries.sql') - queries.create_user(conn) + # Mailu user + queries.create_mailu_user(conn) queries.update_pw(conn, pw=os.environ.get("SECRET_KEY")) + # Healthcheck user + queries.create_health_user(conn) conn.commit() # create db cannot be atomic. But this script is the only active connection, this is kinda safe. if not queries.check_db(conn): From 9b9f3731f6fe2c4450d26f688d3c35005e53fa15 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Mon, 19 Nov 2018 19:10:38 +0200 Subject: [PATCH 05/26] Make current migrations work with postgresql --- core/admin/Dockerfile | 5 +++-- core/admin/mailu/configuration.py | 14 ++++++++++---- core/admin/mailu/models.py | 4 ++-- core/admin/migrations/versions/049fed905da7_.py | 6 ++++-- core/admin/migrations/versions/27ae2f102682_.py | 4 ++-- core/admin/migrations/versions/9c28df23f77e_.py | 10 ++++++---- core/admin/requirements-prod.txt | 1 + 7 files changed, 28 insertions(+), 16 deletions(-) diff --git a/core/admin/Dockerfile b/core/admin/Dockerfile index 2d209b32..a5e806d1 100644 --- a/core/admin/Dockerfile +++ b/core/admin/Dockerfile @@ -8,8 +8,9 @@ RUN mkdir -p /app WORKDIR /app COPY requirements-prod.txt requirements.txt -RUN apk add --no-cache openssl curl \ - && apk add --no-cache --virtual build-dep openssl-dev libffi-dev python3-dev build-base \ +RUN apk add --no-cache libressl curl postgresql-client \ + && apk add --no-cache --virtual build-dep \ + libressl-dev libffi-dev python3-dev build-base postgresql-dev \ && pip3 install -r requirements.txt \ && apk del --no-cache build-dep diff --git a/core/admin/mailu/configuration.py b/core/admin/mailu/configuration.py index 05df8b1f..04d545c8 100644 --- a/core/admin/mailu/configuration.py +++ b/core/admin/mailu/configuration.py @@ -73,14 +73,20 @@ class ConfigManager(dict): key: os.environ.get(key, value) for key, value in DEFAULT_CONFIG.items() }) - if self.config['SQL_FLAVOR'] != 'sqlite' + if self.config['DB_FLAVOR'] != 'sqlite': self.setsql() app.config = self - def setsql(self) - if not self.config['DB_PW'] + def setsql(self): + if not self.config['DB_PW']: self.config['DB_PW'] = self.config['SECRET_KEY'] - self.config['SQLALCHEMY_DATABASE_URI'] = '{driver}://{user}:{pw}@{url}/{db}'.format(driver=DB_FLAVOR,user=DB_USER,pw=DB_PW,url=DB_URL,db=DB_NAME) + self.config['SQLALCHEMY_DATABASE_URI'] = '{driver}://{user}:{pw}@{url}/{db}'.format( + driver=self.config['DB_FLAVOR'], + user=self.config['DB_USER'], + pw=self.config['DB_PW'], + url=self.config['DB_URL'], + db=self.config['DB_NAME'] + ) def setdefault(self, key, value): if key not in self.config: diff --git a/core/admin/mailu/models.py b/core/admin/mailu/models.py index c25d30cb..15f95e97 100644 --- a/core/admin/mailu/models.py +++ b/core/admin/mailu/models.py @@ -287,7 +287,7 @@ class User(Base, Email): # Settings displayed_name = db.Column(db.String(160), nullable=False, default="") spam_enabled = db.Column(db.Boolean(), nullable=False, default=True) - spam_threshold = db.Column(db.Integer(), nullable=False, default=80.0) + spam_threshold = db.Column(db.Integer(), nullable=False, default=80) # Flask-login attributes is_authenticated = True @@ -441,7 +441,7 @@ class Fetch(Base): nullable=False) user = db.relationship(User, backref=db.backref('fetches', cascade='all, delete-orphan')) - protocol = db.Column(db.Enum('imap', 'pop3'), nullable=False) + protocol = db.Column(db.Enum('imap', 'pop3', name='protocol'), nullable=False) host = db.Column(db.String(255), nullable=False) port = db.Column(db.Integer(), nullable=False) tls = db.Column(db.Boolean(), nullable=False) diff --git a/core/admin/migrations/versions/049fed905da7_.py b/core/admin/migrations/versions/049fed905da7_.py index ce410844..feca8dbb 100644 --- a/core/admin/migrations/versions/049fed905da7_.py +++ b/core/admin/migrations/versions/049fed905da7_.py @@ -12,11 +12,13 @@ down_revision = '49d77a93118e' from alembic import op import sqlalchemy as sa +from flask import current_app as app def upgrade(): - with op.batch_alter_table('user') as batch: - batch.alter_column('email', type_=sa.String(length=255, collation="NOCASE")) + if app.config['DB_FLAVOR'] == 'sqlite': + with op.batch_alter_table('user') as batch: + batch.alter_column('email', type_=sa.String(length=255, collation="NOCASE")) def downgrade(): diff --git a/core/admin/migrations/versions/27ae2f102682_.py b/core/admin/migrations/versions/27ae2f102682_.py index f821aff2..1f26072a 100644 --- a/core/admin/migrations/versions/27ae2f102682_.py +++ b/core/admin/migrations/versions/27ae2f102682_.py @@ -35,7 +35,7 @@ def upgrade(): ) # set default to 80% with op.batch_alter_table('user') as batch: - batch.alter_column('spam_threshold', default=80.) + batch.alter_column('spam_threshold', server_default='80') def downgrade(): connection = op.get_bind() @@ -50,4 +50,4 @@ def downgrade(): ) # set default to 10/15 with op.batch_alter_table('user') as batch: - batch.alter_column('spam_threshold', default=10.) + batch.alter_column('spam_threshold', server_default='10') diff --git a/core/admin/migrations/versions/9c28df23f77e_.py b/core/admin/migrations/versions/9c28df23f77e_.py index edf8d8ef..1d2d656f 100644 --- a/core/admin/migrations/versions/9c28df23f77e_.py +++ b/core/admin/migrations/versions/9c28df23f77e_.py @@ -12,13 +12,15 @@ down_revision = 'c162ac88012a' from alembic import op import sqlalchemy as sa +from flask import current_app as app def upgrade(): - with op.batch_alter_table('user') as batch: - batch.alter_column('email', type_=sa.String(length=255, collation="NOCASE")) - with op.batch_alter_table('alias') as batch: - batch.alter_column('email', type_=sa.String(length=255, collation="NOCASE")) + if app.config['DB_FLAVOR'] == 'sqlite': + with op.batch_alter_table('user') as batch: + batch.alter_column('email', type_=sa.String(length=255, collation="NOCASE")) + with op.batch_alter_table('alias') as batch: + batch.alter_column('email', type_=sa.String(length=255, collation="NOCASE")) def downgrade(): diff --git a/core/admin/requirements-prod.txt b/core/admin/requirements-prod.txt index 2ca59edc..1281146a 100644 --- a/core/admin/requirements-prod.txt +++ b/core/admin/requirements-prod.txt @@ -44,3 +44,4 @@ visitor==0.1.3 Werkzeug==0.14.1 WTForms==2.2.1 WTForms-Components==0.10.3 +psycopg2 From 0f3c1b9d154ab3cd14b050385273ea1a7d438ab2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Tue, 20 Nov 2018 14:41:17 +0200 Subject: [PATCH 06/26] Implement CIText as NOCASE alternative in postgresql --- core/admin/mailu/models.py | 8 +++++- .../migrations/versions/049fed905da7_.py | 12 +++++--- .../migrations/versions/9400a032eb1a_.py | 10 +++++-- .../migrations/versions/9c28df23f77e_.py | 28 +++++++++++++++---- .../migrations/versions/ff0417f4318f_.py | 2 +- core/admin/requirements-prod.txt | 1 + optional/postgresql/Dockerfile | 2 +- optional/postgresql/conf/queries.sql | 7 +++++ optional/postgresql/start.py | 6 +++- 9 files changed, 60 insertions(+), 16 deletions(-) diff --git a/core/admin/mailu/models.py b/core/admin/mailu/models.py index 15f95e97..b4f0efa0 100644 --- a/core/admin/mailu/models.py +++ b/core/admin/mailu/models.py @@ -1,10 +1,11 @@ -from mailu import dkim +from mailu import dkim, configuration from sqlalchemy.ext import declarative from passlib import context, hash from datetime import datetime, date from email.mime import text from flask import current_app as app +from citext import CIText import flask_sqlalchemy import sqlalchemy @@ -18,6 +19,7 @@ import dns db = flask_sqlalchemy.SQLAlchemy() +config = configuration.ConfigManager() class IdnaDomain(db.TypeDecorator): @@ -56,6 +58,10 @@ class IdnaEmail(db.TypeDecorator): idna.decode(domain_name), ) + def __init__(self): + if config['DB_FLAVOR'] == 'postgresql': + self.impl = CIText() + class CommaSeparatedList(db.TypeDecorator): """ Stores a list as a comma-separated string, compatible with Postfix. diff --git a/core/admin/migrations/versions/049fed905da7_.py b/core/admin/migrations/versions/049fed905da7_.py index feca8dbb..c30c9b9b 100644 --- a/core/admin/migrations/versions/049fed905da7_.py +++ b/core/admin/migrations/versions/049fed905da7_.py @@ -13,12 +13,16 @@ down_revision = '49d77a93118e' from alembic import op import sqlalchemy as sa from flask import current_app as app - +from citext import CIText def upgrade(): - if app.config['DB_FLAVOR'] == 'sqlite': - with op.batch_alter_table('user') as batch: - batch.alter_column('email', type_=sa.String(length=255, collation="NOCASE")) + if app.config['DB_FLAVOR'] == "postgresql": + email_type = CIText() + else: + email_type = sa.String(length=255, collation="NOCASE") + + with op.batch_alter_table('user') as batch: + batch.alter_column('email', type_=email_type) def downgrade(): diff --git a/core/admin/migrations/versions/9400a032eb1a_.py b/core/admin/migrations/versions/9400a032eb1a_.py index f629a7eb..cb9aeb27 100644 --- a/core/admin/migrations/versions/9400a032eb1a_.py +++ b/core/admin/migrations/versions/9400a032eb1a_.py @@ -12,15 +12,21 @@ down_revision = '9c28df23f77e' from alembic import op import sqlalchemy as sa - +from flask import current_app as app +from citext import CIText def upgrade(): + if app.config['DB_FLAVOR'] == "postgresql": + email_type = CIText() + else: + email_type = sa.String(length=255, collation="NOCASE") + op.create_table('token', sa.Column('created_at', sa.Date(), nullable=False), sa.Column('updated_at', sa.Date(), nullable=True), sa.Column('comment', sa.String(length=255), nullable=True), sa.Column('id', sa.Integer(), nullable=False), - sa.Column('user_email', sa.String(length=255), nullable=False), + sa.Column('user_email', email_type), sa.Column('password', sa.String(length=255), nullable=False), sa.Column('ip', sa.String(length=255), nullable=True), sa.ForeignKeyConstraint(['user_email'], ['user.email'], ), diff --git a/core/admin/migrations/versions/9c28df23f77e_.py b/core/admin/migrations/versions/9c28df23f77e_.py index 1d2d656f..bbff9329 100644 --- a/core/admin/migrations/versions/9c28df23f77e_.py +++ b/core/admin/migrations/versions/9c28df23f77e_.py @@ -13,14 +13,30 @@ down_revision = 'c162ac88012a' from alembic import op import sqlalchemy as sa from flask import current_app as app - +from citext import CIText def upgrade(): - if app.config['DB_FLAVOR'] == 'sqlite': - with op.batch_alter_table('user') as batch: - batch.alter_column('email', type_=sa.String(length=255, collation="NOCASE")) - with op.batch_alter_table('alias') as batch: - batch.alter_column('email', type_=sa.String(length=255, collation="NOCASE")) + if app.config['DB_FLAVOR'] == "postgresql": + email_type = CIText() + with op.batch_alter_table('fetch') as batch: + batch.drop_constraint('fetch_user_email_fkey') + with op.batch_alter_table('manager') as batch: + batch.drop_constraint('manager_user_email_fkey') + else: + email_type = sa.String(length=255, collation="NOCASE") + + with op.batch_alter_table('user') as batch: + batch.alter_column('email', type_=email_type) + with op.batch_alter_table('alias') as batch: + batch.alter_column('email', type_=email_type) + with op.batch_alter_table('fetch') as batch: + batch.alter_column('user_email', type_=email_type) + if app.config['DB_FLAVOR'] == "postgresql": + batch.create_foreign_key("fetch_user_email_fkey", "user", ["user_email"], ["email"]) + with op.batch_alter_table('manager') as batch: + batch.alter_column('user_email', type_=email_type) + if app.config['DB_FLAVOR'] == "postgresql": + batch.create_foreign_key("manager_user_email_fkey", "user", ["user_email"], ["email"]) def downgrade(): diff --git a/core/admin/migrations/versions/ff0417f4318f_.py b/core/admin/migrations/versions/ff0417f4318f_.py index ca3b6d5a..0ae7552c 100644 --- a/core/admin/migrations/versions/ff0417f4318f_.py +++ b/core/admin/migrations/versions/ff0417f4318f_.py @@ -64,7 +64,7 @@ def upgrade(): sa.Column('comment', sa.String(length=255), nullable=True), sa.Column('id', sa.Integer(), nullable=False), sa.Column('user_email', sa.String(length=255), nullable=False), - sa.Column('protocol', sa.Enum('imap', 'pop3'), nullable=False), + sa.Column('protocol', sa.Enum('imap', 'pop3', name='protocol'), nullable=False), sa.Column('host', sa.String(length=255), nullable=False), sa.Column('port', sa.Integer(), nullable=False), sa.Column('tls', sa.Boolean(), nullable=False), diff --git a/core/admin/requirements-prod.txt b/core/admin/requirements-prod.txt index 1281146a..0b9489cc 100644 --- a/core/admin/requirements-prod.txt +++ b/core/admin/requirements-prod.txt @@ -45,3 +45,4 @@ Werkzeug==0.14.1 WTForms==2.2.1 WTForms-Components==0.10.3 psycopg2 +sqlalchemy-citext diff --git a/optional/postgresql/Dockerfile b/optional/postgresql/Dockerfile index 14d11864..f8d5dced 100644 --- a/optional/postgresql/Dockerfile +++ b/optional/postgresql/Dockerfile @@ -7,7 +7,7 @@ RUN apk add --no-cache \ RUN pip3 install jinja2 # Image specific layers under this line RUN apk add --no-cache \ - postgresql postgresql-libs \ + postgresql postgresql-libs postgresql-contrib \ && apk add --virtual .build-deps gcc musl-dev postgresql-dev python3-dev \ && pip3 install psycopg2 anosql \ && apk --purge del .build-deps diff --git a/optional/postgresql/conf/queries.sql b/optional/postgresql/conf/queries.sql index 0aea23b3..3a058a94 100644 --- a/optional/postgresql/conf/queries.sql +++ b/optional/postgresql/conf/queries.sql @@ -34,3 +34,10 @@ select 1 create database mailu owner mailu; + +-- name: create_citext! +-- Install the CIText extension +create + extension + if not exists + citext; diff --git a/optional/postgresql/start.py b/optional/postgresql/start.py index 80c70904..58c94006 100755 --- a/optional/postgresql/start.py +++ b/optional/postgresql/start.py @@ -7,7 +7,7 @@ import glob import os def setup(): - conn = psycopg2.connect('user=postgres') + conn = psycopg2.connect(user = 'postgres') queries = anosql.load_queries('postgres', '/conf/queries.sql') # Mailu user queries.create_mailu_user(conn) @@ -21,6 +21,10 @@ def setup(): queries.create_db(conn) conn.set_isolation_level(1) conn.close() + conn = psycopg2.connect(user = 'postgres', database= 'mailu') + queries.create_citext(conn) + conn.commit() + conn.close() # Bootstrap the database if postgresql is running for the first time if not os.path.exists('/var/lib/postgresql/data/pg_wal'): From 47a3fd47b5b2a4fdc10275f6f8442cb07feb355b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Tue, 20 Nov 2018 18:18:33 +0200 Subject: [PATCH 07/26] Fix DB_FLAVOR condition testing for models.py --- core/admin/mailu/configuration.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/core/admin/mailu/configuration.py b/core/admin/mailu/configuration.py index 04d545c8..65fd3907 100644 --- a/core/admin/mailu/configuration.py +++ b/core/admin/mailu/configuration.py @@ -66,16 +66,20 @@ class ConfigManager(dict): def __init__(self): self.config = dict() + self.parse_env() def init_app(self, app): self.config.update(app.config) + self.parse_env() + if self.config['DB_FLAVOR'] != 'sqlite': + self.setsql() + app.config = self + + def parse_env(self): self.config.update({ key: os.environ.get(key, value) for key, value in DEFAULT_CONFIG.items() }) - if self.config['DB_FLAVOR'] != 'sqlite': - self.setsql() - app.config = self def setsql(self): if not self.config['DB_PW']: From 436055f02cfe37435dac8ed45affefd2f733850b Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Wed, 21 Nov 2018 13:43:06 +0100 Subject: [PATCH 08/26] Created function for returning email type --- core/admin/mailu/models.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/core/admin/mailu/models.py b/core/admin/mailu/models.py index b4f0efa0..cb581929 100644 --- a/core/admin/mailu/models.py +++ b/core/admin/mailu/models.py @@ -21,6 +21,11 @@ import dns db = flask_sqlalchemy.SQLAlchemy() config = configuration.ConfigManager() +def email_type(): + if config['DB_FLAVOR'] == 'postgresql': + return CIText() + else: + return db.String(255, collation="NOCASE") class IdnaDomain(db.TypeDecorator): """ Stores a Unicode string in it's IDNA representation (ASCII only) @@ -58,9 +63,6 @@ class IdnaEmail(db.TypeDecorator): idna.decode(domain_name), ) - def __init__(self): - if config['DB_FLAVOR'] == 'postgresql': - self.impl = CIText() class CommaSeparatedList(db.TypeDecorator): @@ -443,7 +445,7 @@ class Fetch(Base): __tablename__ = "fetch" id = db.Column(db.Integer(), primary_key=True) - user_email = db.Column(db.String(255), db.ForeignKey(User.email), + user_email = db.Column(email_type(), db.ForeignKey(User.email), nullable=False) user = db.relationship(User, backref=db.backref('fetches', cascade='all, delete-orphan')) From e3a503a559af4c1415c53b708ce2d5dd6fd5dec7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Wed, 21 Nov 2018 12:30:35 +0200 Subject: [PATCH 09/26] Move data to the root directory, for simplification --- optional/postgresql/Dockerfile | 6 +++--- optional/postgresql/start.py | 14 +++++++------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/optional/postgresql/Dockerfile b/optional/postgresql/Dockerfile index f8d5dced..54d833c3 100644 --- a/optional/postgresql/Dockerfile +++ b/optional/postgresql/Dockerfile @@ -17,11 +17,11 @@ COPY conf /conf ENV LANG en_US.UTF-8 -RUN mkdir -p /var/lib/postgresql/data /run/postgresql \ - && chown -R postgres:postgres /var/lib/postgresql/data /run/postgresql \ +RUN mkdir -p /data /run/postgresql \ + && chown -R postgres:postgres /data /run/postgresql \ && chmod 2777 /run/postgresql -VOLUME /var/lib/postgresql/data +VOLUME /data EXPOSE 5432 CMD /start.py diff --git a/optional/postgresql/start.py b/optional/postgresql/start.py index 58c94006..18295776 100755 --- a/optional/postgresql/start.py +++ b/optional/postgresql/start.py @@ -27,18 +27,18 @@ def setup(): conn.close() # Bootstrap the database if postgresql is running for the first time -if not os.path.exists('/var/lib/postgresql/data/pg_wal'): - os.system("chown -R postgres:postgres /var/lib/postgresql") - os.system("su - postgres -c 'initdb -D /var/lib/postgresql/data'") +if not os.path.exists('/data/pg_wal'): + os.system("chown -R postgres:postgres /data") + os.system("su - postgres -c 'initdb -D /data'") convert = lambda src, dst: open(dst, "w").write(jinja2.Template(open(src).read()).render(**os.environ)) for pg_file in glob.glob("/conf/*.conf"): - convert(pg_file, os.path.join("/var/lib/postgresql/data", os.path.basename(pg_file))) + convert(pg_file, os.path.join("/data", os.path.basename(pg_file))) # Run postgresql locally for DB and user creation -os.system("su - postgres -c 'pg_ctl start -D /var/lib/postgresql/data -o \"-h localhost\"'") +os.system("su - postgres -c 'pg_ctl start -D /data -o \"-h localhost\"'") setup() -os.system("su - postgres -c 'pg_ctl stop -m smart -w -D /var/lib/postgresql/data'") +os.system("su - postgres -c 'pg_ctl stop -m smart -w -D /data'") # Run postgresql service -os.system("su - postgres -c 'postgres -D /var/lib/postgresql/data -h \*'") +os.system("su - postgres -c 'postgres -D /data -h \*'") From 479b410f19ede69728a6b397df91ff74679d1aff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Thu, 22 Nov 2018 07:46:57 +0200 Subject: [PATCH 10/26] Implement WAL archiving --- optional/postgresql/Dockerfile | 5 +- optional/postgresql/conf/postgresql.conf | 658 +++++++++++++++++++++++ optional/postgresql/start.py | 6 + 3 files changed, 667 insertions(+), 2 deletions(-) create mode 100644 optional/postgresql/conf/postgresql.conf diff --git a/optional/postgresql/Dockerfile b/optional/postgresql/Dockerfile index 54d833c3..7a63e6eb 100644 --- a/optional/postgresql/Dockerfile +++ b/optional/postgresql/Dockerfile @@ -17,11 +17,12 @@ COPY conf /conf ENV LANG en_US.UTF-8 -RUN mkdir -p /data /run/postgresql \ - && chown -R postgres:postgres /data /run/postgresql \ +RUN mkdir -p /data /backup /run/postgresql \ + && chown -R postgres:postgres /run/postgresql \ && chmod 2777 /run/postgresql VOLUME /data +VOLUME /backup EXPOSE 5432 CMD /start.py diff --git a/optional/postgresql/conf/postgresql.conf b/optional/postgresql/conf/postgresql.conf new file mode 100644 index 00000000..92f81307 --- /dev/null +++ b/optional/postgresql/conf/postgresql.conf @@ -0,0 +1,658 @@ +# ----------------------------- +# PostgreSQL configuration file +# ----------------------------- +# +# This file consists of lines of the form: +# +# name = value +# +# (The "=" is optional.) Whitespace may be used. Comments are introduced with +# "#" anywhere on a line. The complete list of parameter names and allowed +# values can be found in the PostgreSQL documentation. +# +# The commented-out settings shown in this file represent the default values. +# Re-commenting a setting is NOT sufficient to revert it to the default value; +# you need to reload the server. +# +# This file is read on server startup and when the server receives a SIGHUP +# signal. If you edit the file on a running system, you have to SIGHUP the +# server for the changes to take effect, run "pg_ctl reload", or execute +# "SELECT pg_reload_conf()". Some parameters, which are marked below, +# require a server shutdown and restart to take effect. +# +# Any parameter can also be given as a command-line option to the server, e.g., +# "postgres -c log_connections=on". Some parameters can be changed at run time +# with the "SET" SQL command. +# +# Memory units: kB = kilobytes Time units: ms = milliseconds +# MB = megabytes s = seconds +# GB = gigabytes min = minutes +# TB = terabytes h = hours +# d = days + + +#------------------------------------------------------------------------------ +# FILE LOCATIONS +#------------------------------------------------------------------------------ + +# The default values of these variables are driven from the -D command-line +# option or PGDATA environment variable, represented here as ConfigDir. + +#data_directory = 'ConfigDir' # use data in another directory + # (change requires restart) +#hba_file = 'ConfigDir/pg_hba.conf' # host-based authentication file + # (change requires restart) +#ident_file = 'ConfigDir/pg_ident.conf' # ident configuration file + # (change requires restart) + +# If external_pid_file is not explicitly set, no extra PID file is written. +#external_pid_file = '' # write an extra PID file + # (change requires restart) + + +#------------------------------------------------------------------------------ +# CONNECTIONS AND AUTHENTICATION +#------------------------------------------------------------------------------ + +# - Connection Settings - + +listen_addresses = '*' # what IP address(es) to listen on; + # comma-separated list of addresses; + # defaults to 'localhost'; use '*' for all + # (change requires restart) +#port = 5432 # (change requires restart) +max_connections = 100 # (change requires restart) +#superuser_reserved_connections = 3 # (change requires restart) +unix_socket_directories = '/run/postgresql,/tmp' # comma-separated list of directories + # (change requires restart) +#unix_socket_group = '' # (change requires restart) +#unix_socket_permissions = 0777 # begin with 0 to use octal notation + # (change requires restart) +#bonjour = off # advertise server via Bonjour + # (change requires restart) +#bonjour_name = '' # defaults to the computer name + # (change requires restart) + +# - Security and Authentication - + +#authentication_timeout = 1min # 1s-600s +#ssl = off +#ssl_ciphers = 'HIGH:MEDIUM:+3DES:!aNULL' # allowed SSL ciphers +#ssl_prefer_server_ciphers = on +#ssl_ecdh_curve = 'prime256v1' +#ssl_dh_params_file = '' +#ssl_cert_file = 'server.crt' +#ssl_key_file = 'server.key' +#ssl_ca_file = '' +#ssl_crl_file = '' +#password_encryption = md5 # md5 or scram-sha-256 +#db_user_namespace = off +#row_security = on + +# GSSAPI using Kerberos +#krb_server_keyfile = '' +#krb_caseins_users = off + +# - TCP Keepalives - +# see "man 7 tcp" for details + +#tcp_keepalives_idle = 0 # TCP_KEEPIDLE, in seconds; + # 0 selects the system default +#tcp_keepalives_interval = 0 # TCP_KEEPINTVL, in seconds; + # 0 selects the system default +#tcp_keepalives_count = 0 # TCP_KEEPCNT; + # 0 selects the system default + + +#------------------------------------------------------------------------------ +# RESOURCE USAGE (except WAL) +#------------------------------------------------------------------------------ + +# - Memory - + +shared_buffers = 128MB # min 128kB + # (change requires restart) +#huge_pages = try # on, off, or try + # (change requires restart) +#temp_buffers = 8MB # min 800kB +#max_prepared_transactions = 0 # zero disables the feature + # (change requires restart) +# Caution: it is not advisable to set max_prepared_transactions nonzero unless +# you actively intend to use prepared transactions. +#work_mem = 4MB # min 64kB +#maintenance_work_mem = 64MB # min 1MB +#replacement_sort_tuples = 150000 # limits use of replacement selection sort +#autovacuum_work_mem = -1 # min 1MB, or -1 to use maintenance_work_mem +#max_stack_depth = 2MB # min 100kB +dynamic_shared_memory_type = posix # the default is the first option + # supported by the operating system: + # posix + # sysv + # windows + # mmap + # use none to disable dynamic shared memory + # (change requires restart) + +# - Disk - + +#temp_file_limit = -1 # limits per-process temp file space + # in kB, or -1 for no limit + +# - Kernel Resource Usage - + +#max_files_per_process = 1000 # min 25 + # (change requires restart) +#shared_preload_libraries = '' # (change requires restart) + +# - Cost-Based Vacuum Delay - + +#vacuum_cost_delay = 0 # 0-100 milliseconds +#vacuum_cost_page_hit = 1 # 0-10000 credits +#vacuum_cost_page_miss = 10 # 0-10000 credits +#vacuum_cost_page_dirty = 20 # 0-10000 credits +#vacuum_cost_limit = 200 # 1-10000 credits + +# - Background Writer - + +#bgwriter_delay = 200ms # 10-10000ms between rounds +#bgwriter_lru_maxpages = 100 # 0-1000 max buffers written/round +#bgwriter_lru_multiplier = 2.0 # 0-10.0 multiplier on buffers scanned/round +#bgwriter_flush_after = 512kB # measured in pages, 0 disables + +# - Asynchronous Behavior - + +#effective_io_concurrency = 1 # 1-1000; 0 disables prefetching +#max_worker_processes = 8 # (change requires restart) +#max_parallel_workers_per_gather = 2 # taken from max_parallel_workers +#max_parallel_workers = 8 # maximum number of max_worker_processes that + # can be used in parallel queries +#old_snapshot_threshold = -1 # 1min-60d; -1 disables; 0 is immediate + # (change requires restart) +#backend_flush_after = 0 # measured in pages, 0 disables + + +#------------------------------------------------------------------------------ +# WRITE AHEAD LOG +#------------------------------------------------------------------------------ + +# - Settings - + +wal_level = replica # minimal, replica, or logical + # (change requires restart) +#fsync = on # flush data to disk for crash safety + # (turning this off can cause + # unrecoverable data corruption) +#synchronous_commit = on # synchronization level; + # off, local, remote_write, remote_apply, or on +#wal_sync_method = fsync # the default is the first option + # supported by the operating system: + # open_datasync + # fdatasync (default on Linux) + # fsync + # fsync_writethrough + # open_sync +#full_page_writes = on # recover from partial page writes +#wal_compression = off # enable compression of full-page writes +#wal_log_hints = off # also do full page writes of non-critical updates + # (change requires restart) +#wal_buffers = -1 # min 32kB, -1 sets based on shared_buffers + # (change requires restart) +#wal_writer_delay = 200ms # 1-10000 milliseconds +#wal_writer_flush_after = 1MB # measured in pages, 0 disables + +#commit_delay = 0 # range 0-100000, in microseconds +#commit_siblings = 5 # range 1-1000 + +# - Checkpoints - + +checkpoint_timeout = 60s # range 30s-1d +#max_wal_size = 1GB +#min_wal_size = 80MB +#checkpoint_completion_target = 0.5 # checkpoint target duration, 0.0 - 1.0 +#checkpoint_flush_after = 256kB # measured in pages, 0 disables +checkpoint_warning = 15s # 0 disables + +# - Archiving - + +archive_mode = on # enables archiving; off, on, or always + # (change requires restart) +archive_command = 'test ! -f /backup/wal_archive/%f && cp %p /backup/wal_archive/%f' # command to use to archive a logfile segment + # placeholders: %p = path of file to archive + # %f = file name only + # e.g. 'test ! -f /mnt/server/archivedir/%f && cp %p /mnt/server/archivedir/%f' +archive_timeout = 60 # force a logfile segment switch after this + # number of seconds; 0 disables + + +#------------------------------------------------------------------------------ +# REPLICATION +#------------------------------------------------------------------------------ + +# - Sending Server(s) - + +# Set these on the master and on any standby that will send replication data. + +#max_wal_senders = 10 # max number of walsender processes + # (change requires restart) +#wal_keep_segments = 0 # in logfile segments, 16MB each; 0 disables +#wal_sender_timeout = 60s # in milliseconds; 0 disables + +#max_replication_slots = 10 # max number of replication slots + # (change requires restart) +#track_commit_timestamp = off # collect timestamp of transaction commit + # (change requires restart) + +# - Master Server - + +# These settings are ignored on a standby server. + +#synchronous_standby_names = '' # standby servers that provide sync rep + # method to choose sync standbys, number of sync standbys, + # and comma-separated list of application_name + # from standby(s); '*' = all +#vacuum_defer_cleanup_age = 0 # number of xacts by which cleanup is delayed + +# - Standby Servers - + +# These settings are ignored on a master server. + +#hot_standby = on # "off" disallows queries during recovery + # (change requires restart) +#max_standby_archive_delay = 30s # max delay before canceling queries + # when reading WAL from archive; + # -1 allows indefinite delay +#max_standby_streaming_delay = 30s # max delay before canceling queries + # when reading streaming WAL; + # -1 allows indefinite delay +#wal_receiver_status_interval = 10s # send replies at least this often + # 0 disables +#hot_standby_feedback = off # send info from standby to prevent + # query conflicts +#wal_receiver_timeout = 60s # time that receiver waits for + # communication from master + # in milliseconds; 0 disables +#wal_retrieve_retry_interval = 5s # time to wait before retrying to + # retrieve WAL after a failed attempt + +# - Subscribers - + +# These settings are ignored on a publisher. + +#max_logical_replication_workers = 4 # taken from max_worker_processes + # (change requires restart) +#max_sync_workers_per_subscription = 2 # taken from max_logical_replication_workers + + +#------------------------------------------------------------------------------ +# QUERY TUNING +#------------------------------------------------------------------------------ + +# - Planner Method Configuration - + +#enable_bitmapscan = on +#enable_hashagg = on +#enable_hashjoin = on +#enable_indexscan = on +#enable_indexonlyscan = on +#enable_material = on +#enable_mergejoin = on +#enable_nestloop = on +#enable_seqscan = on +#enable_sort = on +#enable_tidscan = on + +# - Planner Cost Constants - + +#seq_page_cost = 1.0 # measured on an arbitrary scale +#random_page_cost = 4.0 # same scale as above +#cpu_tuple_cost = 0.01 # same scale as above +#cpu_index_tuple_cost = 0.005 # same scale as above +#cpu_operator_cost = 0.0025 # same scale as above +#parallel_tuple_cost = 0.1 # same scale as above +#parallel_setup_cost = 1000.0 # same scale as above +#min_parallel_table_scan_size = 8MB +#min_parallel_index_scan_size = 512kB +#effective_cache_size = 4GB + +# - Genetic Query Optimizer - + +#geqo = on +#geqo_threshold = 12 +#geqo_effort = 5 # range 1-10 +#geqo_pool_size = 0 # selects default based on effort +#geqo_generations = 0 # selects default based on effort +#geqo_selection_bias = 2.0 # range 1.5-2.0 +#geqo_seed = 0.0 # range 0.0-1.0 + +# - Other Planner Options - + +#default_statistics_target = 100 # range 1-10000 +#constraint_exclusion = partition # on, off, or partition +#cursor_tuple_fraction = 0.1 # range 0.0-1.0 +#from_collapse_limit = 8 +#join_collapse_limit = 8 # 1 disables collapsing of explicit + # JOIN clauses +#force_parallel_mode = off + + +#------------------------------------------------------------------------------ +# ERROR REPORTING AND LOGGING +#------------------------------------------------------------------------------ + +# - Where to Log - + +#log_destination = 'stderr' # Valid values are combinations of + # stderr, csvlog, syslog, and eventlog, + # depending on platform. csvlog + # requires logging_collector to be on. + +# This is used when logging to stderr: +#logging_collector = off # Enable capturing of stderr and csvlog + # into log files. Required to be on for + # csvlogs. + # (change requires restart) + +# These are only used if logging_collector is on: +#log_directory = 'log' # directory where log files are written, + # can be absolute or relative to PGDATA +#log_filename = 'postgresql-%Y-%m-%d_%H%M%S.log' # log file name pattern, + # can include strftime() escapes +#log_file_mode = 0600 # creation mode for log files, + # begin with 0 to use octal notation +#log_truncate_on_rotation = off # If on, an existing log file with the + # same name as the new log file will be + # truncated rather than appended to. + # But such truncation only occurs on + # time-driven rotation, not on restarts + # or size-driven rotation. Default is + # off, meaning append to existing files + # in all cases. +#log_rotation_age = 1d # Automatic rotation of logfiles will + # happen after that time. 0 disables. +#log_rotation_size = 10MB # Automatic rotation of logfiles will + # happen after that much log output. + # 0 disables. + +# These are relevant when logging to syslog: +#syslog_facility = 'LOCAL0' +#syslog_ident = 'postgres' +#syslog_sequence_numbers = on +#syslog_split_messages = on + +# This is only relevant when logging to eventlog (win32): +# (change requires restart) +#event_source = 'PostgreSQL' + +# - When to Log - + +#client_min_messages = notice # values in order of decreasing detail: + # debug5 + # debug4 + # debug3 + # debug2 + # debug1 + # log + # notice + # warning + # error + +#log_min_messages = warning # values in order of decreasing detail: + # debug5 + # debug4 + # debug3 + # debug2 + # debug1 + # info + # notice + # warning + # error + # log + # fatal + # panic + +#log_min_error_statement = error # values in order of decreasing detail: + # debug5 + # debug4 + # debug3 + # debug2 + # debug1 + # info + # notice + # warning + # error + # log + # fatal + # panic (effectively off) + +#log_min_duration_statement = -1 # -1 is disabled, 0 logs all statements + # and their durations, > 0 logs only + # statements running at least this number + # of milliseconds + + +# - What to Log - + +#debug_print_parse = off +#debug_print_rewritten = off +#debug_print_plan = off +#debug_pretty_print = on +#log_checkpoints = off +#log_connections = off +#log_disconnections = off +#log_duration = off +#log_error_verbosity = default # terse, default, or verbose messages +#log_hostname = off +#log_line_prefix = '%m [%p] ' # special values: + # %a = application name + # %u = user name + # %d = database name + # %r = remote host and port + # %h = remote host + # %p = process ID + # %t = timestamp without milliseconds + # %m = timestamp with milliseconds + # %n = timestamp with milliseconds (as a Unix epoch) + # %i = command tag + # %e = SQL state + # %c = session ID + # %l = session line number + # %s = session start timestamp + # %v = virtual transaction ID + # %x = transaction ID (0 if none) + # %q = stop here in non-session + # processes + # %% = '%' + # e.g. '<%u%%%d> ' +#log_lock_waits = off # log lock waits >= deadlock_timeout +#log_statement = 'none' # none, ddl, mod, all +#log_replication_commands = off +#log_temp_files = -1 # log temporary files equal or larger + # than the specified size in kilobytes; + # -1 disables, 0 logs all temp files +log_timezone = 'UTC' + + +# - Process Title - + +#cluster_name = '' # added to process titles if nonempty + # (change requires restart) +#update_process_title = on + + +#------------------------------------------------------------------------------ +# RUNTIME STATISTICS +#------------------------------------------------------------------------------ + +# - Query/Index Statistics Collector - + +#track_activities = on +#track_counts = on +#track_io_timing = off +#track_functions = none # none, pl, all +#track_activity_query_size = 1024 # (change requires restart) +#stats_temp_directory = 'pg_stat_tmp' + + +# - Statistics Monitoring - + +#log_parser_stats = off +#log_planner_stats = off +#log_executor_stats = off +#log_statement_stats = off + + +#------------------------------------------------------------------------------ +# AUTOVACUUM PARAMETERS +#------------------------------------------------------------------------------ + +#autovacuum = on # Enable autovacuum subprocess? 'on' + # requires track_counts to also be on. +#log_autovacuum_min_duration = -1 # -1 disables, 0 logs all actions and + # their durations, > 0 logs only + # actions running at least this number + # of milliseconds. +#autovacuum_max_workers = 3 # max number of autovacuum subprocesses + # (change requires restart) +#autovacuum_naptime = 1min # time between autovacuum runs +#autovacuum_vacuum_threshold = 50 # min number of row updates before + # vacuum +#autovacuum_analyze_threshold = 50 # min number of row updates before + # analyze +#autovacuum_vacuum_scale_factor = 0.2 # fraction of table size before vacuum +#autovacuum_analyze_scale_factor = 0.1 # fraction of table size before analyze +#autovacuum_freeze_max_age = 200000000 # maximum XID age before forced vacuum + # (change requires restart) +#autovacuum_multixact_freeze_max_age = 400000000 # maximum multixact age + # before forced vacuum + # (change requires restart) +#autovacuum_vacuum_cost_delay = 20ms # default vacuum cost delay for + # autovacuum, in milliseconds; + # -1 means use vacuum_cost_delay +#autovacuum_vacuum_cost_limit = -1 # default vacuum cost limit for + # autovacuum, -1 means use + # vacuum_cost_limit + + +#------------------------------------------------------------------------------ +# CLIENT CONNECTION DEFAULTS +#------------------------------------------------------------------------------ + +# - Statement Behavior - + +#search_path = '"$user", public' # schema names +#default_tablespace = '' # a tablespace name, '' uses the default +#temp_tablespaces = '' # a list of tablespace names, '' uses + # only default tablespace +#check_function_bodies = on +#default_transaction_isolation = 'read committed' +#default_transaction_read_only = off +#default_transaction_deferrable = off +#session_replication_role = 'origin' +#statement_timeout = 0 # in milliseconds, 0 is disabled +#lock_timeout = 0 # in milliseconds, 0 is disabled +#idle_in_transaction_session_timeout = 0 # in milliseconds, 0 is disabled +#vacuum_freeze_min_age = 50000000 +#vacuum_freeze_table_age = 150000000 +#vacuum_multixact_freeze_min_age = 5000000 +#vacuum_multixact_freeze_table_age = 150000000 +#bytea_output = 'hex' # hex, escape +#xmlbinary = 'base64' +#xmloption = 'content' +#gin_fuzzy_search_limit = 0 +#gin_pending_list_limit = 4MB + +# - Locale and Formatting - + +datestyle = 'iso, mdy' +#intervalstyle = 'postgres' +timezone = 'UTC' +#timezone_abbreviations = 'Default' # Select the set of available time zone + # abbreviations. Currently, there are + # Default + # Australia (historical usage) + # India + # You can create your own file in + # share/timezonesets/. +#extra_float_digits = 0 # min -15, max 3 +#client_encoding = sql_ascii # actually, defaults to database + # encoding + +# These settings are initialized by initdb, but they can be changed. +lc_messages = 'C' # locale for system error message + # strings +lc_monetary = 'C' # locale for monetary formatting +lc_numeric = 'C' # locale for number formatting +lc_time = 'C' # locale for time formatting + +# default configuration for text search +default_text_search_config = 'pg_catalog.english' + +# - Other Defaults - + +#dynamic_library_path = '$libdir' +#local_preload_libraries = '' +#session_preload_libraries = '' + + +#------------------------------------------------------------------------------ +# LOCK MANAGEMENT +#------------------------------------------------------------------------------ + +#deadlock_timeout = 1s +#max_locks_per_transaction = 64 # min 10 + # (change requires restart) +#max_pred_locks_per_transaction = 64 # min 10 + # (change requires restart) +#max_pred_locks_per_relation = -2 # negative values mean + # (max_pred_locks_per_transaction + # / -max_pred_locks_per_relation) - 1 +#max_pred_locks_per_page = 2 # min 0 + + +#------------------------------------------------------------------------------ +# VERSION/PLATFORM COMPATIBILITY +#------------------------------------------------------------------------------ + +# - Previous PostgreSQL Versions - + +#array_nulls = on +#backslash_quote = safe_encoding # on, off, or safe_encoding +#default_with_oids = off +#escape_string_warning = on +#lo_compat_privileges = off +#operator_precedence_warning = off +#quote_all_identifiers = off +#standard_conforming_strings = on +#synchronize_seqscans = on + +# - Other Platforms and Clients - + +#transform_null_equals = off + + +#------------------------------------------------------------------------------ +# ERROR HANDLING +#------------------------------------------------------------------------------ + +#exit_on_error = off # terminate session on any error? +#restart_after_crash = on # reinitialize after backend crash? + + +#------------------------------------------------------------------------------ +# CONFIG FILE INCLUDES +#------------------------------------------------------------------------------ + +# These options allow settings to be loaded from files other than the +# default postgresql.conf. + +#include_dir = 'conf.d' # include files ending in '.conf' from + # directory 'conf.d' +#include_if_exists = 'exists.conf' # include file only if it exists +#include = 'special.conf' # include file + + +#------------------------------------------------------------------------------ +# CUSTOMIZED OPTIONS +#------------------------------------------------------------------------------ + +# Add settings for extensions here diff --git a/optional/postgresql/start.py b/optional/postgresql/start.py index 18295776..59d89044 100755 --- a/optional/postgresql/start.py +++ b/optional/postgresql/start.py @@ -31,6 +31,12 @@ if not os.path.exists('/data/pg_wal'): os.system("chown -R postgres:postgres /data") os.system("su - postgres -c 'initdb -D /data'") +# Create backup directory structure, if it does not yet exist +os.system("mkdir -p /backup/dump") +os.system("mkdir -p /backup/wal_archive") +os.system("chown -R postgres:postgres /backup") + +# Render config files convert = lambda src, dst: open(dst, "w").write(jinja2.Template(open(src).read()).render(**os.environ)) for pg_file in glob.glob("/conf/*.conf"): convert(pg_file, os.path.join("/data", os.path.basename(pg_file))) From ddd4be8f9af97213f1a1438d7771c88d9ef98a84 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Fri, 23 Nov 2018 14:12:22 +0200 Subject: [PATCH 11/26] Changed admin and user creation command --- tests/compose/core/00_create_users.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/compose/core/00_create_users.sh b/tests/compose/core/00_create_users.sh index fd998a15..b12d22fd 100755 --- a/tests/compose/core/00_create_users.sh +++ b/tests/compose/core/00_create_users.sh @@ -1,4 +1,4 @@ echo "Creating users ..." -docker-compose -f tests/compose/core/docker-compose.yml exec admin python manage.py admin admin mailu.io password || exit 1 -docker-compose -f tests/compose/core/docker-compose.yml exec admin python manage.py user --hash_scheme='SHA512-CRYPT' user mailu.io 'password' || exit 1 +docker-compose -f tests/compose/core/docker-compose.yml exec admin flask mailu admin admin mailu.io password || exit 1 +docker-compose -f tests/compose/core/docker-compose.yml exec admin flask mailu user --hash_scheme='SHA512-CRYPT' user mailu.io 'password' || exit 1 echo "Admin and user successfully created!" \ No newline at end of file From e668d360e80580dd508fe982f2d326fb9c91de70 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Fri, 23 Nov 2018 14:37:55 +0200 Subject: [PATCH 12/26] Changed user creation command --- tests/compose/core/00_create_users.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/compose/core/00_create_users.sh b/tests/compose/core/00_create_users.sh index b12d22fd..40d0bd6e 100755 --- a/tests/compose/core/00_create_users.sh +++ b/tests/compose/core/00_create_users.sh @@ -1,4 +1,4 @@ echo "Creating users ..." docker-compose -f tests/compose/core/docker-compose.yml exec admin flask mailu admin admin mailu.io password || exit 1 -docker-compose -f tests/compose/core/docker-compose.yml exec admin flask mailu user --hash_scheme='SHA512-CRYPT' user mailu.io 'password' || exit 1 -echo "Admin and user successfully created!" \ No newline at end of file +docker-compose -f tests/compose/core/docker-compose.yml exec admin flask mailu user user mailu.io 'password' 'SHA512-CRYPT' || exit 1 +echo "Admin and user successfully created!" From ef6a0727acdbe11558973577b83c9350036e5db5 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Tue, 27 Nov 2018 15:11:46 +0200 Subject: [PATCH 13/26] Updated setup with optional psql db --- setup/flavors/compose/docker-compose.yml | 10 ++++++ setup/flavors/compose/mailu.env | 12 +++++++ setup/static/render.js | 44 +++++++++++++++++++++++- setup/templates/steps/database.html | 39 +++++++++++++++++++++ setup/templates/wizard.html | 1 + 5 files changed, 105 insertions(+), 1 deletion(-) create mode 100644 setup/templates/steps/database.html diff --git a/setup/flavors/compose/docker-compose.yml b/setup/flavors/compose/docker-compose.yml index cc45ca99..12490189 100644 --- a/setup/flavors/compose/docker-compose.yml +++ b/setup/flavors/compose/docker-compose.yml @@ -13,6 +13,16 @@ services: restart: always volumes: - "{{ root }}/redis:/data" + + {% if db_flavor == 'postgresql' and postgresql == 'internal' %} + database: + image: ${DOCKER_ORG:-mailu}/postgresql:${MAILU_VERSION:-{{ version }}} + restart: always + env_file: {{ env }} + volumes: + - "{{ root }}/data/psql_db:/data" + - "{{ root }}/data/psql_backup:/backup" + {% endif %} # Core services front: diff --git a/setup/flavors/compose/mailu.env b/setup/flavors/compose/mailu.env index 3f67b0dd..b0da2127 100644 --- a/setup/flavors/compose/mailu.env +++ b/setup/flavors/compose/mailu.env @@ -158,3 +158,15 @@ REAL_IP_FROM={{ real_ip_from }} # choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no) REJECT_UNLISTED_RECIPIENT={{ reject_unlisted_recipient }} + +################################### +# Advanced settings +################################### +DB_FLAVOR = {{ db_flavor }} +{% if postgresql == 'external' %} +DB_USER={{ db_user }} +DB_PW={{ db_pw }} +DB_URL={{ db_url }} +DB_NAME={{ db_name }} +{% endif %} + diff --git a/setup/static/render.js b/setup/static/render.js index a1c3fb0d..2a265139 100644 --- a/setup/static/render.js +++ b/setup/static/render.js @@ -31,4 +31,46 @@ $(document).ready(function() { $("#admin_path").attr("value", ""); } }); -}); \ No newline at end of file +}); + +$(document).ready(function() { + if ($("#database").val() == 'sqlite') { + $("#postgres_db").hide(); + } else { + $("#postgres_db").show(); + } + if ($('#external_psql').prop('checked')) { + $("#external_db").show(); + } + $("#database").click(function() { + if (this.value == 'sqlite') { + $("#postgres_db").hide(); + } else { + $("#postgres_db").show(); + } + }); + $("#external_psql").change(function() { + if ($(this).is(":checked")) { + $("#external_db").show(); + $("#db_user").prop('required',true); + $("#db_pw").prop('required',true); + $("#db_url").prop('required',true); + $("#db_name").prop('required',true); + } else { + $("#external_db").hide(); + } + }); + $("#internal_psql").change(function() { + if ($(this).is(":checked")) { + $("#external_db").hide(); + $("#db_user").val(""); + $("#db_pw").val(""); + $("#db_url").val(""); + $("#db_name").val(""); + $("#db_user").prop('required',false); + $("#db_pw").prop('required',false); + $("#db_url").prop('required',false); + $("#db_name").prop('required',false); + } + }); +}); diff --git a/setup/templates/steps/database.html b/setup/templates/steps/database.html new file mode 100644 index 00000000..811be2e0 --- /dev/null +++ b/setup/templates/steps/database.html @@ -0,0 +1,39 @@ +{% call macros.panel("info", "Database preferences") %} + +
+ +
+ +

+ +
+ +{% endcall %} \ No newline at end of file diff --git a/setup/templates/wizard.html b/setup/templates/wizard.html index 05de5a5c..e618b716 100644 --- a/setup/templates/wizard.html +++ b/setup/templates/wizard.html @@ -19,6 +19,7 @@ {%for file in steps %} {% include "steps/" + flavor + "/" + file %} {% endfor %} + {% include "steps/database.html" %} {% endif %} From e89d354834dd4ac229ecb08278e740e5aecc0179 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Tue, 27 Nov 2018 19:36:24 +0200 Subject: [PATCH 14/26] Encrypted input db password --- setup/flavors/stack/docker-compose.yml | 6 ++++++ setup/server.py | 3 +++ 2 files changed, 9 insertions(+) diff --git a/setup/flavors/stack/docker-compose.yml b/setup/flavors/stack/docker-compose.yml index 98ba61b1..1506e761 100644 --- a/setup/flavors/stack/docker-compose.yml +++ b/setup/flavors/stack/docker-compose.yml @@ -13,6 +13,12 @@ services: volumes: - "{{ root }}/redis:/data" + {% if db_flavor == 'postgresql' and postgresql == 'internal' %} + database: + image: ${DOCKER_ORG:-mailu}/postgresql:${MAILU_VERSION:-{{ version }}} + env_file: {{ env }} + {% endif %} + # Core services front: image: ${DOCKER_ORG:-mailu}/nginx:${MAILU_VERSION:-{{ version }}} diff --git a/setup/server.py b/setup/server.py index 6f60c3c0..8c506a64 100644 --- a/setup/server.py +++ b/setup/server.py @@ -8,6 +8,7 @@ import uuid import string import random import ipaddress +import hashlib app = flask.Flask(__name__) @@ -77,6 +78,8 @@ def build_app(path): data = flask.request.form.copy() data['uid'] = str(uuid.uuid4()) data['dns'] = str(ipaddress.IPv4Network(data['subnet'])[-2]) + md5_password = hashlib.md5(data['db_pw'].encode()) + data['db_pw'] = md5_password.hexdigest() db.set(data['uid'], json.dumps(data)) return flask.redirect(flask.url_for('.setup', uid=data['uid'])) From e8d05c657f401cdb26200e2e1e33a83ebc19cab7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Wed, 28 Nov 2018 18:41:31 +0200 Subject: [PATCH 15/26] Automatic pg_basebackup and wal_archive cleaning --- optional/postgresql/Dockerfile | 6 +++++- optional/postgresql/basebackup.sh | 30 ++++++++++++++++++++++++++++ optional/postgresql/conf/pg_hba.conf | 2 +- optional/postgresql/postgres_crontab | 1 + optional/postgresql/start.py | 6 +++++- 5 files changed, 42 insertions(+), 3 deletions(-) create mode 100755 optional/postgresql/basebackup.sh create mode 100644 optional/postgresql/postgres_crontab diff --git a/optional/postgresql/Dockerfile b/optional/postgresql/Dockerfile index 7a63e6eb..f0e603e9 100644 --- a/optional/postgresql/Dockerfile +++ b/optional/postgresql/Dockerfile @@ -7,14 +7,18 @@ RUN apk add --no-cache \ RUN pip3 install jinja2 # Image specific layers under this line RUN apk add --no-cache \ - postgresql postgresql-libs postgresql-contrib \ + postgresql postgresql-libs postgresql-contrib busybox-suid \ && apk add --virtual .build-deps gcc musl-dev postgresql-dev python3-dev \ && pip3 install psycopg2 anosql \ && apk --purge del .build-deps COPY start.py /start.py +COPY basebackup.sh /basebackup.sh COPY conf /conf +COPY postgres_crontab /etc/postgres_crontab +RUN crontab /etc/postgres_crontab + ENV LANG en_US.UTF-8 RUN mkdir -p /data /backup /run/postgresql \ diff --git a/optional/postgresql/basebackup.sh b/optional/postgresql/basebackup.sh new file mode 100755 index 00000000..04f3d1d0 --- /dev/null +++ b/optional/postgresql/basebackup.sh @@ -0,0 +1,30 @@ +#!/bin/sh + +dest="/backup/base-$(date +%F-%H%M)" +last=$(ls -d /backup/base* | tail -n1) +mkdir $dest || exit $? + +pg_basebackup --pgdata=$dest --format=tar --gzip --username=postgres || exit $? + +# Clean old base backups, keep the last and the current. +for d in /backup/base*; do + if [ "$d" == "$last" ] || [ "$d" == "$dest" ]; then + continue + fi + rm -r $d || exit $? +done + +# Clean the wall archive +cd /backup/wal_archive || exit $? +if [ $(ls *.*.backup | wc -l) -lt 2 ]; then + ls /backup/wal_archive + exit 0 +fi +# Find the single last wal.backup point +prev_wal_start="$(ls *.*.backup | tail -n2 | head -n1)" +for f in $(ls) ; do + if [ "$f" \< "$prev_wal_start" ] || [ "$f" \= "$prev_wal_start" ]; then + rm -v /backup/wal_archive/$f + fi +done +ls /backup/wal_archive diff --git a/optional/postgresql/conf/pg_hba.conf b/optional/postgresql/conf/pg_hba.conf index ca566f1f..f1333b20 100644 --- a/optional/postgresql/conf/pg_hba.conf +++ b/optional/postgresql/conf/pg_hba.conf @@ -85,6 +85,6 @@ host postgres health 127.0.0.1/32 md5 host all all ::1/128 reject # Allow replication connections from localhost, by a user with the # replication privilege. -local replication all reject +local replication all peer map=local host replication all 127.0.0.1/32 reject host replication all ::1/128 reject diff --git a/optional/postgresql/postgres_crontab b/optional/postgresql/postgres_crontab new file mode 100644 index 00000000..2d45c5a2 --- /dev/null +++ b/optional/postgresql/postgres_crontab @@ -0,0 +1 @@ +11 4 * * * /basebackup.sh > /proc/1/fd/1 2>/proc/1/fd/2 diff --git a/optional/postgresql/start.py b/optional/postgresql/start.py index 59d89044..65f0a57c 100755 --- a/optional/postgresql/start.py +++ b/optional/postgresql/start.py @@ -5,6 +5,7 @@ import psycopg2 import jinja2 import glob import os +import subprocess def setup(): conn = psycopg2.connect(user = 'postgres') @@ -32,7 +33,6 @@ if not os.path.exists('/data/pg_wal'): os.system("su - postgres -c 'initdb -D /data'") # Create backup directory structure, if it does not yet exist -os.system("mkdir -p /backup/dump") os.system("mkdir -p /backup/wal_archive") os.system("chown -R postgres:postgres /backup") @@ -46,5 +46,9 @@ os.system("su - postgres -c 'pg_ctl start -D /data -o \"-h localhost\"'") setup() os.system("su - postgres -c 'pg_ctl stop -m smart -w -D /data'") +out=open("/proc/1/fd/1", "w") +err=open("/proc/1/fd/2", "w") +# Run the cron deamon +subprocess.Popen(["crond", "-f", "-d7"], stdout=out, stderr=err) # Run postgresql service os.system("su - postgres -c 'postgres -D /data -h \*'") From fa879dd9abb44c1e127f5074e91887f54fad72b7 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Thu, 29 Nov 2018 11:34:59 +0200 Subject: [PATCH 16/26] Removed empty space --- setup/flavors/compose/mailu.env | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup/flavors/compose/mailu.env b/setup/flavors/compose/mailu.env index b0da2127..ed967686 100644 --- a/setup/flavors/compose/mailu.env +++ b/setup/flavors/compose/mailu.env @@ -162,7 +162,7 @@ REJECT_UNLISTED_RECIPIENT={{ reject_unlisted_recipient }} ################################### # Advanced settings ################################### -DB_FLAVOR = {{ db_flavor }} +DB_FLAVOR={{ db_flavor }} {% if postgresql == 'external' %} DB_USER={{ db_user }} DB_PW={{ db_pw }} From 92bdc6e0a355f74c4536c3ac686be421f9c0b863 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Thu, 29 Nov 2018 16:59:18 +0200 Subject: [PATCH 17/26] Added network if postgresql used --- setup/flavors/compose/docker-compose.yml | 2 +- setup/flavors/compose/mailu.env | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/setup/flavors/compose/docker-compose.yml b/setup/flavors/compose/docker-compose.yml index 12490189..88823c18 100644 --- a/setup/flavors/compose/docker-compose.yml +++ b/setup/flavors/compose/docker-compose.yml @@ -157,7 +157,7 @@ services: - imap {% endif %} -{% if resolver_enabled %} +{% if resolver_enabled or db_flavor == 'postgresql' %} networks: default: driver: bridge diff --git a/setup/flavors/compose/mailu.env b/setup/flavors/compose/mailu.env index ed967686..da6798b2 100644 --- a/setup/flavors/compose/mailu.env +++ b/setup/flavors/compose/mailu.env @@ -160,7 +160,7 @@ REAL_IP_FROM={{ real_ip_from }} REJECT_UNLISTED_RECIPIENT={{ reject_unlisted_recipient }} ################################### -# Advanced settings +# Database settings ################################### DB_FLAVOR={{ db_flavor }} {% if postgresql == 'external' %} From de3f125ed327c6520bdd5d940e4dc45b315a2821 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Fri, 30 Nov 2018 13:54:12 +0200 Subject: [PATCH 18/26] Implement health checking --- optional/postgresql/Dockerfile | 3 ++- optional/postgresql/conf/pg_hba.conf | 2 +- optional/postgresql/conf/pg_ident.conf | 1 - optional/postgresql/conf/queries.sql | 6 ++++++ optional/postgresql/start.py | 11 ++++++----- 5 files changed, 15 insertions(+), 8 deletions(-) diff --git a/optional/postgresql/Dockerfile b/optional/postgresql/Dockerfile index f0e603e9..6a78f600 100644 --- a/optional/postgresql/Dockerfile +++ b/optional/postgresql/Dockerfile @@ -7,7 +7,7 @@ RUN apk add --no-cache \ RUN pip3 install jinja2 # Image specific layers under this line RUN apk add --no-cache \ - postgresql postgresql-libs postgresql-contrib busybox-suid \ + postgresql postgresql-libs postgresql-contrib busybox-suid sudo\ && apk add --virtual .build-deps gcc musl-dev postgresql-dev python3-dev \ && pip3 install psycopg2 anosql \ && apk --purge del .build-deps @@ -30,3 +30,4 @@ VOLUME /backup EXPOSE 5432 CMD /start.py +HEALTHCHECK CMD psql -h 127.0.0.1 -d postgres -U health -c "select 1 as ok;" || exit 1 diff --git a/optional/postgresql/conf/pg_hba.conf b/optional/postgresql/conf/pg_hba.conf index f1333b20..af5122e8 100644 --- a/optional/postgresql/conf/pg_hba.conf +++ b/optional/postgresql/conf/pg_hba.conf @@ -80,7 +80,7 @@ local all all peer map=local # IPv4 connections: host all mailu {{ SUBNET }} md5 -host postgres health 127.0.0.1/32 md5 +host postgres health 127.0.0.1/32 trust # IPv6 local connections: host all all ::1/128 reject # Allow replication connections from localhost, by a user with the diff --git a/optional/postgresql/conf/pg_ident.conf b/optional/postgresql/conf/pg_ident.conf index dcfa34f3..4538ff9c 100644 --- a/optional/postgresql/conf/pg_ident.conf +++ b/optional/postgresql/conf/pg_ident.conf @@ -42,4 +42,3 @@ # MAPNAME SYSTEM-USERNAME PG-USERNAME local postgres postgres local root postgres -local root health diff --git a/optional/postgresql/conf/queries.sql b/optional/postgresql/conf/queries.sql index 3a058a94..999efbb2 100644 --- a/optional/postgresql/conf/queries.sql +++ b/optional/postgresql/conf/queries.sql @@ -18,6 +18,12 @@ begin end $$; +-- name: grant_health! +-- Grant connect permission for the health user +grant connect + on database postgres + to health; + -- name: update_pw! alter user mailu diff --git a/optional/postgresql/start.py b/optional/postgresql/start.py index 65f0a57c..1ee540d5 100755 --- a/optional/postgresql/start.py +++ b/optional/postgresql/start.py @@ -15,6 +15,7 @@ def setup(): queries.update_pw(conn, pw=os.environ.get("SECRET_KEY")) # Healthcheck user queries.create_health_user(conn) + queries.grant_health(conn) conn.commit() # create db cannot be atomic. But this script is the only active connection, this is kinda safe. if not queries.check_db(conn): @@ -30,7 +31,7 @@ def setup(): # Bootstrap the database if postgresql is running for the first time if not os.path.exists('/data/pg_wal'): os.system("chown -R postgres:postgres /data") - os.system("su - postgres -c 'initdb -D /data'") + os.system("sudo -u postgres initdb -D /data") # Create backup directory structure, if it does not yet exist os.system("mkdir -p /backup/wal_archive") @@ -42,13 +43,13 @@ for pg_file in glob.glob("/conf/*.conf"): convert(pg_file, os.path.join("/data", os.path.basename(pg_file))) # Run postgresql locally for DB and user creation -os.system("su - postgres -c 'pg_ctl start -D /data -o \"-h localhost\"'") +os.system("sudo -u postgres pg_ctl start -D /data -o '-h \"''\" '") setup() -os.system("su - postgres -c 'pg_ctl stop -m smart -w -D /data'") +os.system("sudo -u postgres pg_ctl stop -m smart -w -D /data") out=open("/proc/1/fd/1", "w") err=open("/proc/1/fd/2", "w") # Run the cron deamon -subprocess.Popen(["crond", "-f", "-d7"], stdout=out, stderr=err) +subprocess.Popen(["crond", "-f"], stdout=out, stderr=err) # Run postgresql service -os.system("su - postgres -c 'postgres -D /data -h \*'") +os.system("sudo -u postgres postgres -D /data -h \*") From 3ce73f5bc081272879f529eda841857e4d489703 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Fri, 30 Nov 2018 16:59:03 +0200 Subject: [PATCH 19/26] Automatic restore of backups when /data is empty --- optional/postgresql/Dockerfile | 2 +- optional/postgresql/basebackup.sh | 2 +- optional/postgresql/start.py | 24 ++++++++++++++++++++---- 3 files changed, 22 insertions(+), 6 deletions(-) diff --git a/optional/postgresql/Dockerfile b/optional/postgresql/Dockerfile index 6a78f600..65e21109 100644 --- a/optional/postgresql/Dockerfile +++ b/optional/postgresql/Dockerfile @@ -7,7 +7,7 @@ RUN apk add --no-cache \ RUN pip3 install jinja2 # Image specific layers under this line RUN apk add --no-cache \ - postgresql postgresql-libs postgresql-contrib busybox-suid sudo\ + postgresql postgresql-libs postgresql-contrib busybox-suid sudo tar \ && apk add --virtual .build-deps gcc musl-dev postgresql-dev python3-dev \ && pip3 install psycopg2 anosql \ && apk --purge del .build-deps diff --git a/optional/postgresql/basebackup.sh b/optional/postgresql/basebackup.sh index 04f3d1d0..14e3f804 100755 --- a/optional/postgresql/basebackup.sh +++ b/optional/postgresql/basebackup.sh @@ -4,7 +4,7 @@ dest="/backup/base-$(date +%F-%H%M)" last=$(ls -d /backup/base* | tail -n1) mkdir $dest || exit $? -pg_basebackup --pgdata=$dest --format=tar --gzip --username=postgres || exit $? +pg_basebackup --wal-method=none --pgdata=$dest --format=tar --gzip --username=postgres || exit $? # Clean old base backups, keep the last and the current. for d in /backup/base*; do diff --git a/optional/postgresql/start.py b/optional/postgresql/start.py index 1ee540d5..7049e687 100755 --- a/optional/postgresql/start.py +++ b/optional/postgresql/start.py @@ -28,10 +28,23 @@ def setup(): conn.commit() conn.close() -# Bootstrap the database if postgresql is running for the first time -if not os.path.exists('/data/pg_wal'): +# Check if /data is empty +if not os.listdir("/data"): os.system("chown -R postgres:postgres /data") - os.system("sudo -u postgres initdb -D /data") + os.system("chmod 0700 /data") + base_backups=glob.glob("/backup/base-*") + if base_backups: + # Restore the latest backup + subprocess.call(["tar", "--same-owner", "-zpxvf", base_backups[-1] + "/base.tar.gz" , "-C", "/data"]) + if os.listdir("/backup/wal_archive"): + with open("/data/recovery.conf", "w") as rec: + rec.write("restore_command = 'cp /backup/wal_archive/%f %p'\n") + rec.write("standby_mode = off\n") + os.system("chown postgres:postgres /data/recovery.conf") + #os.system("sudo -u postgres pg_ctl start -D /data -o '-h \"''\" '") + else: + # Bootstrap the database + os.system("sudo -u postgres initdb -D /data") # Create backup directory structure, if it does not yet exist os.system("mkdir -p /backup/wal_archive") @@ -42,8 +55,11 @@ convert = lambda src, dst: open(dst, "w").write(jinja2.Template(open(src).read() for pg_file in glob.glob("/conf/*.conf"): convert(pg_file, os.path.join("/data", os.path.basename(pg_file))) -# Run postgresql locally for DB and user creation +# (Re)start postgresql locally for DB and user creation os.system("sudo -u postgres pg_ctl start -D /data -o '-h \"''\" '") +while os.path.isfile("recovery.conf"): + pass +os.system("sudo -u postgres pg_ctl -D /data promote") setup() os.system("sudo -u postgres pg_ctl stop -m smart -w -D /data") From 2cb27a9f32fa729e077b51ed22579ab412a9fbee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Fri, 30 Nov 2018 17:43:03 +0200 Subject: [PATCH 20/26] Fix sorting of /backup/base-* directories --- optional/postgresql/start.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/optional/postgresql/start.py b/optional/postgresql/start.py index 7049e687..ea278d56 100755 --- a/optional/postgresql/start.py +++ b/optional/postgresql/start.py @@ -32,10 +32,10 @@ def setup(): if not os.listdir("/data"): os.system("chown -R postgres:postgres /data") os.system("chmod 0700 /data") - base_backups=glob.glob("/backup/base-*") + base_backups=sorted(glob.glob("/backup/base-*")) if base_backups: # Restore the latest backup - subprocess.call(["tar", "--same-owner", "-zpxvf", base_backups[-1] + "/base.tar.gz" , "-C", "/data"]) + subprocess.call(["tar", "--same-owner", "-zpxf", base_backups[-1] + "/base.tar.gz" , "-C", "/data"]) if os.listdir("/backup/wal_archive"): with open("/data/recovery.conf", "w") as rec: rec.write("restore_command = 'cp /backup/wal_archive/%f %p'\n") From 44dae7353c3fdc631e315176be50448fb829a9e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Fri, 30 Nov 2018 17:46:59 +0200 Subject: [PATCH 21/26] Gzip wal_archives --- optional/postgresql/conf/postgresql.conf | 2 +- optional/postgresql/postgres_crontab | 2 +- optional/postgresql/start.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/optional/postgresql/conf/postgresql.conf b/optional/postgresql/conf/postgresql.conf index 92f81307..97c5391f 100644 --- a/optional/postgresql/conf/postgresql.conf +++ b/optional/postgresql/conf/postgresql.conf @@ -216,7 +216,7 @@ checkpoint_warning = 15s # 0 disables archive_mode = on # enables archiving; off, on, or always # (change requires restart) -archive_command = 'test ! -f /backup/wal_archive/%f && cp %p /backup/wal_archive/%f' # command to use to archive a logfile segment +archive_command = 'test ! -f /backup/wal_archive/%f && gzip < %p > /backup/wal_archive/%f' # command to use to archive a logfile segment # placeholders: %p = path of file to archive # %f = file name only # e.g. 'test ! -f /mnt/server/archivedir/%f && cp %p /mnt/server/archivedir/%f' diff --git a/optional/postgresql/postgres_crontab b/optional/postgresql/postgres_crontab index 2d45c5a2..ce87e1e2 100644 --- a/optional/postgresql/postgres_crontab +++ b/optional/postgresql/postgres_crontab @@ -1 +1 @@ -11 4 * * * /basebackup.sh > /proc/1/fd/1 2>/proc/1/fd/2 +11 4 * * 7 /basebackup.sh > /proc/1/fd/1 2>/proc/1/fd/2 diff --git a/optional/postgresql/start.py b/optional/postgresql/start.py index ea278d56..5d5b2bc6 100755 --- a/optional/postgresql/start.py +++ b/optional/postgresql/start.py @@ -38,7 +38,7 @@ if not os.listdir("/data"): subprocess.call(["tar", "--same-owner", "-zpxf", base_backups[-1] + "/base.tar.gz" , "-C", "/data"]) if os.listdir("/backup/wal_archive"): with open("/data/recovery.conf", "w") as rec: - rec.write("restore_command = 'cp /backup/wal_archive/%f %p'\n") + rec.write("restore_command = 'gunzip < /backup/wal_archive/%f > %p'\n") rec.write("standby_mode = off\n") os.system("chown postgres:postgres /data/recovery.conf") #os.system("sudo -u postgres pg_ctl start -D /data -o '-h \"''\" '") From bdcf69b0e6f3286ade0b726916ff76c475646baf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Fri, 30 Nov 2018 18:12:23 +0200 Subject: [PATCH 22/26] Keep one more WAL archive, to enable single-last backup recovery --- optional/postgresql/basebackup.sh | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/optional/postgresql/basebackup.sh b/optional/postgresql/basebackup.sh index 14e3f804..907da2ef 100755 --- a/optional/postgresql/basebackup.sh +++ b/optional/postgresql/basebackup.sh @@ -17,14 +17,12 @@ done # Clean the wall archive cd /backup/wal_archive || exit $? if [ $(ls *.*.backup | wc -l) -lt 2 ]; then - ls /backup/wal_archive exit 0 fi # Find the single last wal.backup point -prev_wal_start="$(ls *.*.backup | tail -n2 | head -n1)" +prev_wal_start="$(ls *.*.backup | tail -n2 | head -n1 | cut -d '.' -f 1)" for f in $(ls) ; do - if [ "$f" \< "$prev_wal_start" ] || [ "$f" \= "$prev_wal_start" ]; then + if [ "$f" \< "$prev_wal_start" ]; then rm -v /backup/wal_archive/$f fi done -ls /backup/wal_archive From 7b8835070d95c2bbae6eae0b12876f468d027133 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Mon, 3 Dec 2018 15:25:10 +0200 Subject: [PATCH 23/26] Added tenacity retry fir migrations connection --- core/admin/migrations/env.py | 4 +++- core/admin/requirements-prod.txt | 1 + core/admin/requirements.txt | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/core/admin/migrations/env.py b/core/admin/migrations/env.py index 45938160..bb43fc55 100755 --- a/core/admin/migrations/env.py +++ b/core/admin/migrations/env.py @@ -3,6 +3,8 @@ from alembic import context from sqlalchemy import engine_from_config, pool from logging.config import fileConfig import logging +import tenacity +from tenacity import retry # this is the Alembic Config object, which provides # access to the values within the .ini file in use. @@ -68,8 +70,8 @@ def run_migrations_online(): engine = engine_from_config(config.get_section(config.config_ini_section), prefix='sqlalchemy.', poolclass=pool.NullPool) + connection = retry(engine.connect, stop=tenacity.stop_after_attempt(100), wait=tenacity.wait_random(min=2, max=5))() - connection = engine.connect() context.configure(connection=connection, target_metadata=target_metadata, process_revision_directives=process_revision_directives, diff --git a/core/admin/requirements-prod.txt b/core/admin/requirements-prod.txt index 0b9489cc..ba206f12 100644 --- a/core/admin/requirements-prod.txt +++ b/core/admin/requirements-prod.txt @@ -46,3 +46,4 @@ WTForms==2.2.1 WTForms-Components==0.10.3 psycopg2 sqlalchemy-citext +tenacity diff --git a/core/admin/requirements.txt b/core/admin/requirements.txt index 95a65bbe..70372dee 100644 --- a/core/admin/requirements.txt +++ b/core/admin/requirements.txt @@ -17,3 +17,4 @@ PyYAML PyOpenSSL dnspython bcrypt +tenacity From dd16ed4cba3a17e8c49854148ad0fa5228dbede8 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Mon, 3 Dec 2018 16:44:48 +0200 Subject: [PATCH 24/26] Removed password hashing --- setup/server.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/setup/server.py b/setup/server.py index 8c506a64..6b1514fd 100644 --- a/setup/server.py +++ b/setup/server.py @@ -78,8 +78,6 @@ def build_app(path): data = flask.request.form.copy() data['uid'] = str(uuid.uuid4()) data['dns'] = str(ipaddress.IPv4Network(data['subnet'])[-2]) - md5_password = hashlib.md5(data['db_pw'].encode()) - data['db_pw'] = md5_password.hexdigest() db.set(data['uid'], json.dumps(data)) return flask.redirect(flask.url_for('.setup', uid=data['uid'])) From 7809d1373adaa880f5da57fcf22b6cf7cd21a529 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Mon, 3 Dec 2018 17:57:43 +0200 Subject: [PATCH 25/26] Moved postgresql image in optional --- setup/flavors/compose/docker-compose.yml | 20 ++++++++++---------- setup/flavors/stack/docker-compose.yml | 14 ++++++++------ 2 files changed, 18 insertions(+), 16 deletions(-) diff --git a/setup/flavors/compose/docker-compose.yml b/setup/flavors/compose/docker-compose.yml index 88823c18..f4c978f5 100644 --- a/setup/flavors/compose/docker-compose.yml +++ b/setup/flavors/compose/docker-compose.yml @@ -14,16 +14,6 @@ services: volumes: - "{{ root }}/redis:/data" - {% if db_flavor == 'postgresql' and postgresql == 'internal' %} - database: - image: ${DOCKER_ORG:-mailu}/postgresql:${MAILU_VERSION:-{{ version }}} - restart: always - env_file: {{ env }} - volumes: - - "{{ root }}/data/psql_db:/data" - - "{{ root }}/data/psql_backup:/backup" - {% endif %} - # Core services front: image: ${DOCKER_ORG:-mailu}/nginx:${MAILU_VERSION:-{{ version }}} @@ -157,6 +147,16 @@ services: - imap {% endif %} + {% if db_flavor == 'postgresql' and postgresql == 'internal' %} + database: + image: ${DOCKER_ORG:-mailu}/postgresql:${MAILU_VERSION:-{{ version }}} + restart: always + env_file: {{ env }} + volumes: + - "{{ root }}/data/psql_db:/data" + - "{{ root }}/data/psql_backup:/backup" + {% endif %} + {% if resolver_enabled or db_flavor == 'postgresql' %} networks: default: diff --git a/setup/flavors/stack/docker-compose.yml b/setup/flavors/stack/docker-compose.yml index 1506e761..1bc4806f 100644 --- a/setup/flavors/stack/docker-compose.yml +++ b/setup/flavors/stack/docker-compose.yml @@ -13,12 +13,6 @@ services: volumes: - "{{ root }}/redis:/data" - {% if db_flavor == 'postgresql' and postgresql == 'internal' %} - database: - image: ${DOCKER_ORG:-mailu}/postgresql:${MAILU_VERSION:-{{ version }}} - env_file: {{ env }} - {% endif %} - # Core services front: image: ${DOCKER_ORG:-mailu}/nginx:${MAILU_VERSION:-{{ version }}} @@ -149,6 +143,14 @@ services: replicas: 1 {% endif %} + {% if db_flavor == 'postgresql' and postgresql == 'internal' %} + database: + image: ${DOCKER_ORG:-mailu}/postgresql:${MAILU_VERSION:-{{ version }}} + env_file: {{ env }} + volumes: + - "{{ root }}/data/psql_backup:/backup" + {% endif %} + networks: default: driver: overlay From 55cf328ce259e1932c0941dae77d19db22a90740 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Mon, 3 Dec 2018 19:01:32 +0200 Subject: [PATCH 26/26] Documentation how to use Postgresql --- docs/database.rst | 77 ++++++++++++++++++++++++++++ optional/postgresql/conf/pg_hba.conf | 2 +- 2 files changed, 78 insertions(+), 1 deletion(-) create mode 100644 docs/database.rst diff --git a/docs/database.rst b/docs/database.rst new file mode 100644 index 00000000..066e8762 --- /dev/null +++ b/docs/database.rst @@ -0,0 +1,77 @@ +Changing the database back-end +============================== + +By default Mailu uses a SQLite database. Recently, we have changed the internals of Mailu +to enable the support of alternative database solutions. At this moment we have only included +the possibility to use a Postgresql database. This functionality should still be considered +experimental! + +Mailu Postgresql +---------------- + +Mailu optionally comes with a pre-configured Postgresql image. +This images has the following features: + +- Automatic creation of users, db, extensions and password; +- TCP connections are only allowed from the mailu `SUBNET`; +- Automatic minutely *wal archiving* and weekly `pg_basebackup`; +- Automatic cleaning of *wal archives* and *base backups*; + Two versions always remain available; +- When `/data` is empty and backups are present, the backups are restored automatically; + Useful in swarm environments, since the /data directory should not be on any network + filesystem (performance). + +To make use of this functionality, just select *Postgresql* as database flavor. +Don't select the usage of an external database. The ``docker-compose.yml`` and ``mailu.env`` +will pull in ``mailu/postgresql``. This image and ``mailu/admin`` contain all the scripts +to automatically setup the database. + +After bring up the service, it might be useful to check the logs with: + +.. code-block:: bash + + docker-compose logs -f admin database + +External Postgresql +------------------- + +It is also possible to use a Postgresql database server, hosted elsewhere. +In this case you'll have to take to create an empty database for Mailu, corresponding user, +password and sufficient privileges on the database to ``CREATE TABLE``, ``DROP`` etc. +Usually making the user owner of the database would be the easiest thing to do. +Don't forget to set ``pg_hba.conf`` accordingly. + +The database will also need the Citext extension installed. +This is usually included in a package called "postgresql-contrib". +The exact name may vary between distributions. + +The following commands can serve as an example on how to set up postgresql for Mailu usage. +Adjust this to your own liking. + +.. code-block:: bash + + $ sudo su - postgres + $ psql + psql (10.6) + Type "help" for help. + + postgres=# create user mailu; + CREATE ROLE + postgres=# alter user mailu password 'my_secure_pass'; + ALTER ROLE + postgres=# create database mailu owner mailu; + CREATE DATABASE + postgres=# \c mailu + You are now connected to database "mailu" as user "postgres". + mailu=# create extension citext; + CREATE EXTENSION + mailu=# \q + +In ``pg_hba.conf`` there should be a line like this: + +.. code-block:: bash + + host mailu mailu /32 md5 + +Note that this example is the bare-minimum to get Mailu working. It goes without saying that +the database admin will have to setup his own means of backups and TLS encrypted connections. diff --git a/optional/postgresql/conf/pg_hba.conf b/optional/postgresql/conf/pg_hba.conf index af5122e8..883fa3ad 100644 --- a/optional/postgresql/conf/pg_hba.conf +++ b/optional/postgresql/conf/pg_hba.conf @@ -79,7 +79,7 @@ # "local" is for Unix domain socket connections only local all all peer map=local # IPv4 connections: -host all mailu {{ SUBNET }} md5 +host mailu mailu {{ SUBNET }} md5 host postgres health 127.0.0.1/32 trust # IPv6 local connections: host all all ::1/128 reject