From 12e4b0d5612f2b1f3190802ad80a747dfcaa4e36 Mon Sep 17 00:00:00 2001 From: Jean-Yves <7360784+docjyJ@users.noreply.github.com> Date: Fri, 16 Aug 2024 16:40:35 +0200 Subject: [PATCH 1/3] Update readme.md Signed-off-by: Jean-Yves <7360784+docjyJ@users.noreply.github.com> --- community-containers/stalwart/readme.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/community-containers/stalwart/readme.md b/community-containers/stalwart/readme.md index cdd1db04..ff37e744 100644 --- a/community-containers/stalwart/readme.md +++ b/community-containers/stalwart/readme.md @@ -1,23 +1,17 @@ > [!WARNING] -> The Stalwart server is under development. +> Be aware that the mail server is the most difficult service to deploy. > -> The stability of Stalwart services is not guaranteed. -> Do not use this feature as a main mail server without a redundancy system and without knowledge. -> -> To learn or use as a secondary server enjoy it and please report bugs at [docjyj/aio-stalwart](https://github.com/docjyj/aio-stalwart/issues). +> Do not use this feature as a main mail server or without a redundancy system and without knowledge. ## Stalwart mail server This container bundles stalwart mail server and auto-configures it for you. ### Notes -- This is only intended to run on a VPS with static ip-address. -- Check with `sudo netstat -tulpn` that no other service is using port 25, 143, 465, 587, 993 nor 4190 yet as otherwise the container will fail to start. -- You need to configure a reverse proxy in order to run this container since stalwart needs a dedicated (sub)domain! For that, you might have a look at https://github.com/nextcloud/all-in-one/tree/main/community-containers/caddy. -- Currently, only `mail.$NC_DOMAIN` is supported as subdomain! So if Nextcloud is using `your-domain.com`, Stalwart will use `mail.your-domain.com`. -- The data of Stalwart will be automatically included in AIOs backup solution! -- After adding and starting the container, you need to run `docker inspect nextcloud-aio-stalwart | grep STALWART_USER_PASS` to obtain the system administrator password (username: `admin`). With this information, you can log in to the web interface at `https://mail.your-domain.com/login` -- See https://stalw.art/docs/install/docker/ for next steps. -- Additionally, you might want to install and configure [snappymail](https://apps.nextcloud.com/apps/snappymail) or [mail](https://apps.nextcloud.com/apps/mail) inside Nextcloud in order to use your mail accounts for sending and retrieving mails. +Documentation is available on the container repository. +This documentation is regularly updated and is intended to be as simple and detailed as possible. +Thanks for all your feedback! + +- See https://github.com/docjyJ/aio-stalwart#getting-started for geting start with this container. - See https://stalw.art/docs/faq for further faq and docs on the project - See https://github.com/nextcloud/all-in-one/tree/main/community-containers#community-containers how to add it to the AIO stack From 1792d4c2fc6ab654d327e40f80921a49f9c7c9e3 Mon Sep 17 00:00:00 2001 From: Jean-Yves <7360784+docjyJ@users.noreply.github.com> Date: Fri, 16 Aug 2024 16:41:41 +0200 Subject: [PATCH 2/3] Delete community-containers/stalwart/upgrading.md Signed-off-by: Jean-Yves <7360784+docjyJ@users.noreply.github.com> --- community-containers/stalwart/upgrading.md | 29 ---------------------- 1 file changed, 29 deletions(-) delete mode 100644 community-containers/stalwart/upgrading.md diff --git a/community-containers/stalwart/upgrading.md b/community-containers/stalwart/upgrading.md deleted file mode 100644 index 958f4355..00000000 --- a/community-containers/stalwart/upgrading.md +++ /dev/null @@ -1,29 +0,0 @@ -> [!NOTE] -> Unless the starting script tells you, you have no action to do to update. - -# UPGRADING - -During a major server update, this message will be displayed: - -> Your data is in an old format. -> -> Make a backup and see https://github.com/nextcloud/all-in-one/blob/main/community-containers/stalwart/upgrading.md -> -> To avoid any loss of data, Stalwart will not launch. - -If there is no update, delete the `/opt/stalwart-mail/aio.lock` file from the container. Beware of data loss. - -See https://github.com/stalwartlabs/mail-server/blob/main/UPGRADING.md - -> [!CAUTION] -> Before each update don't forget to make a backup. - -## Upgrading from 0.7.x to 0.8.x - -Before upgrading, do a backup of your data ! - -```bash -sudo docker run --rm -v nextcloud_aio_stalwart:/opt/stalwart-mail -it --entrypoint /usr/local/bin/stalwart-mail stalwartlabs/mail-server:v0.7.3 --config /opt/stalwart-mail/etc/config.toml --export /opt/stalwart-mail/export -sudo docker run --rm -v nextcloud_aio_stalwart:/opt/stalwart-mail -it --entrypoint /usr/local/bin/stalwart-mail stalwartlabs/mail-server:v0.8.0 --config /opt/stalwart-mail/etc/config.toml --import /opt/stalwart-mail/export -sudo docker run --rm -v nextcloud_aio_stalwart:/opt/stalwart-mail -it --entrypoint /bin/rm alpine /opt/stalwart-mail/aio.lock -``` From d7caa2a7b4520738748f065e805b322adfdc13ba Mon Sep 17 00:00:00 2001 From: Jean-Yves <7360784+docjyJ@users.noreply.github.com> Date: Sun, 25 Aug 2024 11:54:52 +0200 Subject: [PATCH 3/3] Fix Signed-off-by: Jean-Yves <7360784+docjyJ@users.noreply.github.com> --- community-containers/stalwart/readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/community-containers/stalwart/readme.md b/community-containers/stalwart/readme.md index ff37e744..b34f04db 100644 --- a/community-containers/stalwart/readme.md +++ b/community-containers/stalwart/readme.md @@ -1,4 +1,4 @@ -> [!WARNING] +> [!CAUTION] > Be aware that the mail server is the most difficult service to deploy. > > Do not use this feature as a main mail server or without a redundancy system and without knowledge. @@ -11,7 +11,7 @@ Documentation is available on the container repository. This documentation is regularly updated and is intended to be as simple and detailed as possible. Thanks for all your feedback! -- See https://github.com/docjyJ/aio-stalwart#getting-started for geting start with this container. +- See https://github.com/docjyJ/aio-stalwart#getting-started for getting start with this container. - See https://stalw.art/docs/faq for further faq and docs on the project - See https://github.com/nextcloud/all-in-one/tree/main/community-containers#community-containers how to add it to the AIO stack