chore: add maildump in the docker environment

CONTRIBUTING.rst

@@ -17,24 +17,12 @@ Development environment
 
 You can either run the demo locally or with Docker.
 
-The only tool required for local development is `uv`.
-Make sure to have uv `installed on your computer <https://docs.astral.sh/uv/getting-started/installation/>`_
-to be able to hack Canaille.
-
-Initialize your development environment with:
-
-- ``uv sync --extra front --extra oidc`` to have a minimal working development environment. This will allow you to run the tests with ``uv pytest --backend memory``.
-- ``uv sync --extra front --extra oidc --extra sqlite`` to have a minimal working development environment with SQLite backend support. This will allow you to run the tests with ``uv pytest --backend sql``.
-- ``uv sync --extra front --extra oidc --extra ldap`` to have a minimal working development environment with LDAP backend support. This will allow you to run the tests with ``uv pytest --backend ldap``.
-- ``uv sync --all-extras`` if you want to have everything at your fingertips. Note that it may compile some Python dependencies that would expect things to be installed on your system;
-  Some dependencies of Canaille might need to be compiled, so you probably want to check that `GCC` and `cargo` are available on your computer.
-
 After having launched the demo you have access to several services:
 
-- A canaille server at `localhost:5000 <http://localhost:5000>`__
-- A dummy client at `localhost:5001 <http://localhost:5001>`__
-- Another dummy client at `localhost:5002 <http://localhost:5002>`__
-- A mail catcher at `localhost:1080 <http://localhost:1080>`__
+- A canaille server at `canaille.localhost:5000 <http://canaille.localhost:5000>`__
+- A dummy client at `client1.localhost:5001 <http://client1.localhost:5001>`__
+- Another dummy client at `client2.localhost:5002 <http://client2.localhost:5002>`__
+- A mail catcher at `maildump.localhost:1080 <http://maildump.localhost:1080>`__
 
 The canaille server has some default users:
 
@@ -54,14 +42,22 @@ Canaille comes with several backends:
 - a `sql` backend, based on sqlalchemy
 - a production-ready `LDAP` backend
 
-Docker environment
-~~~~~~~~~~~~~~~~~~
+.. _local_environment:
 
-When launching Canaille with Docker, you have access to:
+Local environment
+~~~~~~~~~~~~~~~~~
 
-- A canaille server at `canaille.localhost:5000 <http://canaille.localhost:5000>`__
-- A dummy client at `client1.localhost:5001 <http://client1.localhost:5001>`__
-- Another dummy client at `client2.localhost:5002 <http://client2client2..localhost:5002>`__
+The only tool required for local development is `uv`.
+Make sure to have uv `installed on your computer <https://docs.astral.sh/uv/getting-started/installation/>`_
+to be able to hack Canaille.
+
+Initialize your development environment with:
+
+- ``uv sync --extra front --extra oidc`` to have a minimal working development environment. This will allow you to run the tests with ``uv pytest --backend memory``.
+- ``uv sync --extra front --extra oidc --extra sqlite`` to have a minimal working development environment with SQLite backend support. This will allow you to run the tests with ``uv pytest --backend sql``.
+- ``uv sync --extra front --extra oidc --extra ldap`` to have a minimal working development environment with LDAP backend support. This will allow you to run the tests with ``uv pytest --backend ldap``.
+- ``uv sync --all-extras`` if you want to have everything at your fingertips. Note that it may compile some Python dependencies that would expect things to be installed on your system;
+  Some dependencies of Canaille might need to be compiled, so you probably want to check that `GCC` and `cargo` are available on your computer.
 
 SQL
 ^^^
@@ -70,8 +66,7 @@ With the SQL backend, the demo instance will load and save data in a local sqlit
 .. code-block:: console
     :caption: Run the demo instance with the SQL backend
 
-    cd demo
-    docker compose up
+    ./demo/run.sh
 
 Memory
 ^^^^^^
@@ -80,8 +75,7 @@ With the memory backend, all data is lost when Canaille stops.
 .. code-block:: console
     :caption: Run the demo instance with the memory backend
 
-    cd demo
-    docker compose --file docker-compose-memory.yml up
+    ./demo/run.sh --backend memory
 
 LDAP
 ^^^^
@@ -90,13 +84,25 @@ With the LDAP backend, all data is lost when Canaille stops.
 .. code-block:: console
     :caption: Run the demo instance with the LDAP backend
 
-    cd demo
-    docker compose --file docker-compose-ldap.yml up
+    ./demo/run.sh --backend ldap
 
-.. _local_environment:
+.. note ::
+    If you want to run the demo locally with the LDAP backend, you need to have
+    `OpenLDAP <https://www.openldap.org/>`_ installed on your system.
+    It is generally shipped under the ``slapd`` or ``openldap`` package name.
 
-Local environment
-~~~~~~~~~~~~~~~~~
+.. warning ::
+    On Debian or Ubuntu systems, the OpenLDAP `slapd` binary usage might be restricted by apparmor,
+    and thus makes the tests and the demo fail. This can be mitigated by removing apparmor restrictions
+    on `slapd`.
+
+    .. code-block:: console
+
+        sudo apt install --yes apparmor-utils
+        sudo aa-complain /usr/sbin/slapd
+
+Docker environment
+~~~~~~~~~~~~~~~~~~
 
 SQL
 ^^^
@@ -105,7 +111,8 @@ With the SQL backend, the demo instance will load and save data in a local sqlit
 .. code-block:: console
     :caption: Run the demo instance with the SQL backend
 
-    ./demo/run.sh
+    cd demo
+    docker compose up
 
 Memory
 ^^^^^^
@@ -114,7 +121,8 @@ With the memory backend, all data is lost when Canaille stops.
 .. code-block:: console
     :caption: Run the demo instance with the memory backend
 
-    ./demo/run.sh --backend memory
+    cd demo
+    docker compose --file docker-compose-memory.yml up
 
 LDAP
 ^^^^
@@ -123,22 +131,8 @@ With the LDAP backend, all data is lost when Canaille stops.
 .. code-block:: console
     :caption: Run the demo instance with the LDAP backend
 
-    ./demo/run.sh --backend ldap
-
-.. note ::
-    If you want to run the demo locally with the LDAP backend, you need to have
-    `OpenLDAP <https://www.openldap.org/>`_ installed on your system.
-    It is generally shipped under the ``slapd`` or ``openldap`` package name.
-
-.. warning ::
-    On Debian or Ubuntu systems, the OpenLDAP `slapd` binary usage might be restricted by apparmor,
-    and thus makes the tests and the demo fail. This can be mitigated by removing apparmor restrictions
-    on `slapd`.
-
-    .. code-block:: console
-
-        sudo apt install --yes apparmor-utils
-        sudo aa-complain /usr/sbin/slapd
+    cd demo
+    docker compose --file docker-compose-ldap.yml up
 
 Populate the database
 ~~~~~~~~~~~~~~~~~~~~~

demo/Dockerfile-maildump

@@ -0,0 +1,9 @@
+FROM python:slim
+
+RUN \
+    apt update && \
+    apt --yes upgrade
+
+RUN pip install maildump
+
+ENTRYPOINT ["maildump", "--http-ip", "0.0.0.0", "--smtp-ip", "0.0.0.0"]

demo/conf-docker/canaille-ldap.toml

@@ -8,6 +8,10 @@ FAVICON = "/static/img/canaille-c.webp"
 ENABLE_REGISTRATION = true
 ADMIN_EMAIL = "admin@example.org"
 
+[CANAILLE.SMTP]
+HOST = "maildump.localhost"
+PORT = 1025
+
 [CANAILLE.ACL.DEFAULT]
 PERMISSIONS = ["edit_self", "use_oidc"]
 READ = [

demo/conf-docker/canaille-memory.toml

@@ -5,10 +5,13 @@ SERVER_NAME = "canaille.localhost"
 [CANAILLE]
 LOGO = "/static/img/canaille-head.webp"
 FAVICON = "/static/img/canaille-c.webp"
-EMAIL_CONFIRMATION = false
 ENABLE_REGISTRATION = true
 ADMIN_EMAIL = "admin@example.org"
 
+[CANAILLE.SMTP]
+HOST = "maildump.localhost"
+PORT = 1025
+
 [CANAILLE.ACL.DEFAULT]
 PERMISSIONS = ["edit_self", "use_oidc"]
 READ = [

demo/conf-docker/canaille-sql.toml

@@ -5,10 +5,13 @@ SERVER_NAME = "canaille.localhost"
 [CANAILLE]
 LOGO = "/static/img/canaille-head.webp"
 FAVICON = "/static/img/canaille-c.webp"
-EMAIL_CONFIRMATION = false
 ENABLE_REGISTRATION = true
 ADMIN_EMAIL = "admin@example.org"
 
+[CANAILLE.SMTP]
+HOST = "maildump.localhost"
+PORT = 1025
+
 [CANAILLE.ACL.DEFAULT]
 PERMISSIONS = ["edit_self", "use_oidc"]
 READ = [

demo/conf/canaille-ldap.toml

@@ -5,12 +5,11 @@ SERVER_NAME = "canaille.localhost"
 [CANAILLE]
 LOGO = "/static/img/canaille-head.webp"
 FAVICON = "/static/img/canaille-c.webp"
-EMAIL_CONFIRMATION = false
 ENABLE_REGISTRATION = true
 ADMIN_EMAIL = "admin@example.org"
 
 [CANAILLE.SMTP]
-HOST = "localhost"
+HOST = "maildump.localhost"
 PORT = 1025
 
 [CANAILLE.ACL.DEFAULT]

demo/conf/canaille-memory.toml

@@ -9,7 +9,7 @@ ENABLE_REGISTRATION = true
 ADMIN_EMAIL = "admin@example.org"
 
 [CANAILLE.SMTP]
-HOST = "localhost"
+HOST = "maildump.localhost"
 PORT = 1025
 
 [CANAILLE.ACL.DEFAULT]

demo/conf/canaille-sql.toml

@@ -9,7 +9,7 @@ ENABLE_REGISTRATION = true
 ADMIN_EMAIL = "admin@example.org"
 
 [CANAILLE.SMTP]
-HOST = "localhost"
+HOST = "maildump.localhost"
 PORT = 1025
 
 [CANAILLE.ACL.DEFAULT]

demo/docker-compose-ldap.yml

@@ -77,3 +77,12 @@ services:
     command: --port=5002
     ports:
       - 5002:5002
+
+  maildump:
+    hostname: maildump.localhost
+    build:
+      context: ..
+      dockerfile: demo/Dockerfile-maildump
+    ports:
+      - 1025:1025
+      - 1080:1080

demo/docker-compose-memory.yml

@@ -55,3 +55,12 @@ services:
     command: --port=5002
     ports:
       - 5002:5002
+
+  maildump:
+    hostname: maildump.localhost
+    build:
+      context: ..
+      dockerfile: demo/Dockerfile-maildump
+    ports:
+      - 1025:1025
+      - 1080:1080

demo/docker-compose-sql.yml

@@ -55,3 +55,12 @@ services:
     command: --port=5002
     ports:
       - 5002:5002
+
+  maildump:
+    hostname: maildump.localhost
+    build:
+      context: ..
+      dockerfile: demo/Dockerfile-maildump
+    ports:
+      - 1025:1025
+      - 1080:1080

demo/docker-compose.yml

@@ -55,3 +55,12 @@ services:
     command: --port=5002
     ports:
       - 5002:5002
+
+  maildump:
+    hostname: maildump.localhost
+    build:
+      context: ..
+      dockerfile: demo/Dockerfile-maildump
+    ports:
+      - 1025:1025
+      - 1080:1080