From 2500a32234042d2453589a45400331bdb4700c50 Mon Sep 17 00:00:00 2001 From: kaiyou Date: Mon, 6 Nov 2017 13:24:40 +0100 Subject: [PATCH 1/5] Use a template to replace the version tag (cherry picked from commit 5831221c0e3ffcc326e28df8d304c31e3e27580b) --- docs/_templates/page.html | 4 ++++ docs/compose/setup.rst | 6 +++--- docs/conf.py | 19 +------------------ 3 files changed, 8 insertions(+), 21 deletions(-) create mode 100644 docs/_templates/page.html diff --git a/docs/_templates/page.html b/docs/_templates/page.html new file mode 100644 index 00000000..97296793 --- /dev/null +++ b/docs/_templates/page.html @@ -0,0 +1,4 @@ +{%- extends "layout.html" %} +{% block body %} + {{ body|replace("VERSION_TAG", version) }} +{% endblock %} diff --git a/docs/compose/setup.rst b/docs/compose/setup.rst index 4dded51e..8870613c 100644 --- a/docs/compose/setup.rst +++ b/docs/compose/setup.rst @@ -19,12 +19,12 @@ Docker Compose configuration is stored in a file named :download:`docker-compose.yml`. Additionally, Mailu relies on a :download:`.env` file for various settings. Download the proper template files from the git repository. To download the configuration -for the ``{{ github_version }}`` branch, use: +for the ``VERSION_TAG`` branch, use: .. code-block:: bash - wget https://mailu.io/{{ github_version }}/_downloads/docker-compose.yml - wget https://mailu.io/{{ github_version }}/_downloads/.env + wget https://mailu.io/VERSION_TAG/_downloads/docker-compose.yml + wget https://mailu.io/VERSION_TAG/_downloads/.env Then open the ``.env`` file to setup the mail server. Modify the ``ROOT`` setting to match your setup directory if different from ``/mailu``. diff --git a/docs/conf.py b/docs/conf.py index 276d2260..3c522f20 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,10 +2,7 @@ # -*- coding: utf-8 -*- # -import os, sys, docutils - -sys.path.append(os.path.dirname(__file__)) -extensions = ['sphinx.ext.imgmath', 'sphinx.ext.viewcode', 'conf'] +extensions = ['sphinx.ext.imgmath', 'sphinx.ext.viewcode'] templates_path = ['_templates'] source_suffix = '.rst' master_doc = 'index' @@ -40,20 +37,6 @@ html_context = { } -def setup(app): - """ The conf itself is an extension for parsing rst. - """ - def rstjinja(app, docname, source): - """ Render our pages as a jinja template for fancy templating. - """ - if app.builder.format != 'html': - return - source[0] = app.builder.templates.render_string( - source[0], app.config.html_context) - - app.connect("source-read", rstjinja) - - # Upload function when the script is called directly if __name__ == "__main__": import os, sys, paramiko From 1ac0576af0f16466f0a57d9e4790101d29418381 Mon Sep 17 00:00:00 2001 From: kaiyou Date: Mon, 6 Nov 2017 13:46:22 +0100 Subject: [PATCH 2/5] Fix the documentation about exposing the admin interface --- docs/compose/setup.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/compose/setup.rst b/docs/compose/setup.rst index 8870613c..478852b0 100644 --- a/docs/compose/setup.rst +++ b/docs/compose/setup.rst @@ -68,10 +68,10 @@ configuration option must be one of the following: - ``rainloop`` will run the popular Rainloop Webmail. The administration interface is not exposed on the public address by default, -you will need to set the ``EXPOSE_ADMIN`` variable accordingly: +you will need to set the ``ADMIN`` variable accordingly: -- ``yes`` will expose the admin interface in ``/admin``; -- ``no`` (or any other value) will disable this behaviour. +- ``true`` will expose the admin interface in ``/admin``; +- ``false`` (or any other value) will disable this behaviour. A Webdav server exposes a Dav interface over HTTP so that clients can store contacts or calendars using the mail account. This can be enabled using the `WEBDAV` From 6d4a0507f2a5fd15f70fac7715b4e3b5860d1848 Mon Sep 17 00:00:00 2001 From: kaiyou Date: Tue, 7 Nov 2017 16:05:46 +0100 Subject: [PATCH 3/5] Add a note about the stable branch --- docs/releases.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/releases.rst b/docs/releases.rst index 64634b01..275c0ea1 100644 --- a/docs/releases.rst +++ b/docs/releases.rst @@ -28,6 +28,16 @@ the main frontend container and terminates all connections, performing TLS and authentication directly. Letsencrypt support is now more complete, with various TLS "flavors" for all kinds of setup. +Finally, a big change about how versions are managed: the ``stable`` branch +will be deprecated with the end of branch ``1.4``. Mailu will now only publish +branches per version, as any version jump requires manual updates anyway. This +will avoid confusion about which branch is currently considered *the* stable +one. End of support for branches will happen after 2 version changes (e.g. +end of support for branch ``1.4`` will happen when branch ``1.6`` is released). +Finally, intermediary versions backporting some important features will be +branched as subversions first (branch ``1.5.1`` for instance), then merge in +the branch version once enough testing has happened. + More details about the changes are available in the `changelog`_, and this release will be followed by a short-term upgrade including some more features and bug fixes. From 41c73ac6b703fae2d3fac5bf61535d2c1d351eb7 Mon Sep 17 00:00:00 2001 From: kaiyou Date: Tue, 7 Nov 2017 16:08:42 +0100 Subject: [PATCH 4/5] Update the version in .env --- docs/compose/.env | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/compose/.env b/docs/compose/.env index eb4d7e44..07f30adf 100644 --- a/docs/compose/.env +++ b/docs/compose/.env @@ -11,8 +11,8 @@ # Set this to the path where Mailu data and configuration is stored ROOT=/mailu -# Mailu version to run (stable, 1.0, 1.1, etc. or latest) -VERSION=stable +# Mailu version to run (1.0, 1.1, etc. or master) +VERSION=1.5 # Set to a randomly generated 16 bytes string SECRET_KEY=ChangeMeChangeMe From 8f70d40ac3a02dbac3de7a1e229f3e7f98c55d2a Mon Sep 17 00:00:00 2001 From: kaiyou Date: Wed, 8 Nov 2017 00:26:08 +0100 Subject: [PATCH 5/5] Add a missing volume for dkim to work on rspamd (cherry picked from commit 8cab079af6b563e939831c3d6247f4ebae7e02a0) --- docs/compose/docker-compose.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/compose/docker-compose.yml b/docs/compose/docker-compose.yml index 0900e5b5..397e4d33 100644 --- a/docs/compose/docker-compose.yml +++ b/docs/compose/docker-compose.yml @@ -57,6 +57,7 @@ services: env_file: .env volumes: - "$ROOT/filter:/var/lib/rspamd" + - "$ROOT/dkim:/dkim" - "$ROOT/overrides/rspamd:/etc/rspamd/override.d" antivirus: