From 11996375f307e68a9e30aa5dbd5b8b4ab6bfeeca Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Thu, 29 Jun 2023 14:41:16 +0200 Subject: [PATCH] Optimized README.md with Chat-GPT --- roles/server_docker-mailu/README.md | 170 +++++++++++++++++----------- 1 file changed, 106 insertions(+), 64 deletions(-) diff --git a/roles/server_docker-mailu/README.md b/roles/server_docker-mailu/README.md index e5d8c005..54d0f8ed 100644 --- a/roles/server_docker-mailu/README.md +++ b/roles/server_docker-mailu/README.md @@ -1,103 +1,145 @@ -# role server_docker-mailu +# Mailu Server Docker Role -## setup -### bugs +This guide provides instructions for setting up, operating, and maintaining the Mailu server docker role. -#### fetchmail -Fetchmail doesn't work with big amounts of data. -For further information see this issue: https://github.com/Mailu/Mailu/issues/1719. +## Table of Contents -##### deactivation -If you have fetchmail installed and want to deinstall it keep in mind to delete all fetched accounts from the administration panel before you delete fetchmail. +- [Setup](#setup) + - [Fetchmail Issues](#fetchmail-issues) + - [Data Deletion](#data-deletion) + - [Port Management](#port-management) + - [Admin Account Creation](#admin-account-creation) + - [CLI User Management](#cli-user-management) + - [Starting the Server](#starting-the-server) +- [Debugging](#debugging) +- [Testing](#testing) +- [Updates](#updates) +- [To-Do](#to-do) +- [References](#references) -##### security concerns -The [german wikipedia tells that there are some security concern with fetchmail](https://de.wikipedia.org/wiki/Fetchmail). If in the future a customer needs to functions of fetchmail, it could be better to write a docker container for [getmail](https://en.wikipedia.org/wiki/Getmail) instead because it should be more secure. +## Setup -##### workaround -If you need to receive emails from another account this should help: +### Fetchmail Issues -- Redirect to your new email account -- Export all data from your original account -- Import all data from your original account to your new account +Fetchmail might not work properly with large amounts of data. For more information, refer to this [issue](https://github.com/Mailu/Mailu/issues/1719). -### delete data -To delete all volumes and data execute: +#### Deactivating Fetchmail + +Before uninstalling Fetchmail, ensure to remove all fetched accounts from the administration panel. + +#### Fetchmail Security Concerns + +There are known security concerns with Fetchmail as stated in the [German Wikipedia](https://de.wikipedia.org/wiki/Fetchmail). If you require Fetchmail functions in the future, consider creating a Docker container for [Getmail](https://en.wikipedia.org/wiki/Getmail) as it is considered more secure. + +#### Fetchmail Workaround + +If you need to receive emails from another account, follow these steps: + +1. Redirect your emails to your new email account. +2. Export all data from your original account. +3. Import all data to your new account. + +### Data Deletion + +To delete all volumes and data, execute the following command with caution: ```bash - rm -vr /etc/mailu/; docker volume rm $(docker volume ls -q | grep mailu_) +rm -vr /etc/mailu/; docker volume rm $(docker volume ls -q | grep mailu_) ``` -Be careful! -### ports -Keep in mind to change the conflicting ports manual. -Execute +### Port Management + +Check for any port conflicts and manually change the conflicting ports if necessary. Use the following command to verify: ```bash - netstat -tulpn +netstat -tulpn ``` -to verify that there aren't port conflicts +### Admin Account Creation -### admin account - -Before you can use Mailu, you must create the primary administrator user account. This should be admin@{{hostname}}. Use the following command, changing PASSWORD to your liking: +To use Mailu, create the primary administrator user account, `admin@{{hostname}}`, using the command below. Replace `PASSWORD` with your preferred password: ```bash - docker-compose -p mailu exec admin flask mailu admin {{admin}} {{hostname}} PASSWORD +docker-compose -p mailu exec admin flask mailu admin {{admin}} {{hostname}} PASSWORD ``` -### cli user management -How to manage users is described here: https://mailu.io/master/cli.html +### CLI User Management -### Up +For managing users, follow the instructions in the official [Mailu CLI documentation](https://mailu.io/master/cli.html). + +### Starting the Server + +To start the server, use the following command: ```bash - docker-compose -p mailu up -d -``` -## debug - -## database -### database access -To access the database execute -```bash - docker exec -it mailu-database-1 mysql -u root -D mailu -p +docker-compose -p mailu up -d ``` -### mailu_front_1 +## Debugging + +### Database Access + +To access the database, use the following command: ```bash -sudo docker container exec -it mailu_front_1 /bin/bash +docker-compose exec -it database mysql -u root -D mailu -p ``` -### restart everything + +### Container Access + +To access the front container, use this command: ```bash -sudo docker restart mailu_smtp_1 mailu_imap_1 mailu_antispam_1 mailu_redis_1 mailu_webdav_1 mailu_front_1 mailu_database_1 mailu_webmail_1 mailu_admin_1 mailu_antivirus_1 +docker-compose exec -it front /bin/bash ``` -## resend queued mails +### Restarting Services + +To restart all services, use the following command: + +```bash +docker-compose restart +``` + +### Resending Queued Mails + +To resend queued mails, use this command: + ```bash docker-compose exec -it smtp postqueue -f ``` -## test -- https://de.ssl-tools.net/mailservers/ -- http://testemail.de/ +## Testing -## update -For update instructions follow: -- https://mailu.io/master/maintain.html +Use the following tools for testing: -## todo -- https://blog.kuepper.nrw/2019/03/30/roundcube-webmail-mit-zwei-faktor-authentifizierung/ -- https://mailu.io/master/faq.html#i-want-to-integrate-nextcloud-15-and-newer-with-mailu -- https://docs.nextcloud.com/server/9.0/admin_manual/configuration_user/user_auth_ftp_smb_imap.html -## See -- https://gist.github.com/marienfressinaud/f284a59b18aad395eb0de2d22836ae6b -- https://mailu.io/1.7/compose/setup.html -- https://github.com/nuxsmin/sysPass/issues/1299 -- https://github.com/Mailu/Mailu/issues/1171 -- https://support.plesk.com/hc/en-us/articles/115001264814-Unable-to-log-into-RoundCube-Connection-to-storage-server-failed -- https://github.com/Mailu/Mailu -- https://github.com/Mailu/Mailu/issues/2135 -- https://github.com/Mailu/Mailu/issues/2827 \ No newline at end of file + +- SSL-Tools Mailserver Test (URL: https://de.ssl-tools.net/mailservers/) +- TestEmail.de (URL: http://testemail.de/) + +## Updates + +For instructions on updating your Mailu setup, follow the official [Mailu maintenance guide](https://mailu.io/master/maintain.html). + +## To-Do + +- Implement two-factor authentication in Roundcube Webmail. More information can be found [here](https://blog.kuepper.nrw/2019/03/30/roundcube-webmail-mit-zwei-faktor-authentifizierung/). +- Integrate Nextcloud 15 and newer with Mailu. Learn more about this [here](https://mailu.io/master/faq.html#i-want-to-integrate-nextcloud-15-and-newer-with-mailu). +- User authentication with Nextcloud. Find more information [here](https://docs.nextcloud.com/server/9.0/admin_manual/configuration_user/user_auth_ftp_smb_imap.html). + +## References + +- [Mailu compose setup guide](https://mailu.io/1.7/compose/setup.html) +- [SysPass issue #1299](https://github.com/nuxsmin/sysPass/issues/1299) +- [Mailu issue #1719](https://github.com/Mailu/Mailu/issues/1719) +- [Mailu issue #1171](https://github.com/Mailu/Mailu/issues/1171) +- [Mailu issue #2135](https://github.com/Mailu/Mailu/issues/2135) +- [Mailu issue #2827](https://github.com/Mailu/Mailu/issues/2827) +- [Mailu GitHub repository](https://github.com/Mailu/Mailu) +- [Plesk support article on RoundCube connection issue](https://support.plesk.com/hc/en-us/articles/115001264814-Unable-to-log-into-RoundCube-Connection-to-storage-server-failed) +- [Gist by marienfressinaud](https://gist.github.com/marienfressinaud/f284a59b18aad395eb0de2d22836ae6b) + +For more information about this role, visit the [GitHub repository](https://github.com/kevinveenbirkenbach/computer-playbook/tree/master/roles/server_docker-mailu). + +This README.md was optimized with [Chat-GPT](https://chat.openai.com/share/d1ad5ce7-3aa1-4a14-a959-63393b39374a) \ No newline at end of file