diff --git a/docs/attach_service.md b/docs/debug-attach_service.md similarity index 100% rename from docs/attach_service.md rename to docs/debug-attach_service.md diff --git a/docs/troubles.md b/docs/debug-common_problems.md similarity index 93% rename from docs/troubles.md rename to docs/debug-common_problems.md index d39ee7579..8f8d1cafc 100644 --- a/docs/troubles.md +++ b/docs/debug-common_problems.md @@ -22,7 +22,7 @@ Escape character is '^]'. ## My mails are identified as Spam -Please read our guide on [DNS configuration](dns.md). +Please read our guide on [DNS configuration](prerequesite-dns.md). ## docker-compose throws weird erros @@ -51,4 +51,4 @@ If you get an error message like: ERROR: for postfix-mailcow Cannot start service postfix-mailcow: driver failed programming external connectivity on endpoint mailcowdockerized_postfix-mailcow_1: Error starting userland proxy: listen tcp 0.0.0.0:25: bind: address already in use ``` -while trying to start / install mailcow: dockerized, make sure you've followed our section on the [prerequisites](requirements/#firewall-ports). +while trying to start / install mailcow: dockerized, make sure you've followed our section on the [prerequisites](prerequesite-system/#firewall-ports). diff --git a/docs/debug_logs.md b/docs/debug-logs.md similarity index 100% rename from docs/debug_logs.md rename to docs/debug-logs.md diff --git a/docs/reset_pw.md b/docs/debug-reset_pw.md similarity index 80% rename from docs/reset_pw.md rename to docs/debug-reset_pw.md index 0e1cfe705..e4b2b6513 100644 --- a/docs/reset_pw.md +++ b/docs/debug-reset_pw.md @@ -7,12 +7,6 @@ cd mailcow_path bash mailcow-reset-admin.sh ``` -## Remove Two-Factor Authentication - -``` - -``` - ## Reset MySQL Passwords Stop the stack by running `docker-compose stop`. @@ -26,6 +20,8 @@ docker-compose run --rm --entrypoint '/bin/sh -c "gosu mysql mysqld --skip-grant ### 1\. Find database name ``` +# source mailcow.conf +# docker-compose exec mysql-mailcow mysql -u${DBUSER} -p${DBPASS} ${DBNAME} MariaDB [(none)]> show databases; +--------------------+ | Database | @@ -57,3 +53,12 @@ MariaDB [(none)]> UPDATE mysql.user SET authentication_string = PASSWORD('gotr00 MariaDB [(none)]> UPDATE mysql.user SET authentication_string = PASSWORD('mookuh'), password = PASSWORD('mookuh') WHERE User = 'mailcow' AND Host = '%'; MariaDB [(none)]> FLUSH PRIVILEGES; ``` + +## Remove Two-Factor Authentication + +This works similar to resetting a MySQL password, now we do it from the host without connecting to the MySQL cli: + +``` +source mailcow.conf +docker-compose exec mysql-mailcow mysql -u${DBUSER} -p${DBPASS} ${DBNAME} -e DELETE FROM tfa WHERE username='YOUR_USERNAME' +``` diff --git a/docs/rm_volumes.md b/docs/debug-rm_volumes.md similarity index 100% rename from docs/rm_volumes.md rename to docs/debug-rm_volumes.md diff --git a/docs/local_mta.md b/docs/firststeps-local_mta.md similarity index 100% rename from docs/local_mta.md rename to docs/firststeps-local_mta.md diff --git a/docs/relayhost.md b/docs/firststeps-relayhost.md similarity index 100% rename from docs/relayhost.md rename to docs/firststeps-relayhost.md diff --git a/docs/rp.md b/docs/firststeps-rp.md similarity index 100% rename from docs/rp.md rename to docs/firststeps-rp.md diff --git a/docs/rspamd_ui.md b/docs/firststeps-rspamd_ui.md similarity index 100% rename from docs/rspamd_ui.md rename to docs/firststeps-rspamd_ui.md diff --git a/docs/sender_rcv.md b/docs/firststeps-sender_rcv.md similarity index 97% rename from docs/sender_rcv.md rename to docs/firststeps-sender_rcv.md index dd3e2e5db..abbc2acfe 100644 --- a/docs/sender_rcv.md +++ b/docs/firststeps-sender_rcv.md @@ -1,6 +1,6 @@ When a mailbox is created, a user is allowed to send mail from and receive mail for his own mailbox address. - Mailbox me@example.org is created. example.org is a primary domain. + Mailbox me@example.org is created. example.org is a primary domain. Note: a mailbox cannot be created in an alias domain. me@example.org is only known as me@example.org. diff --git a/docs/ssl.md b/docs/firststeps-ssl.md similarity index 100% rename from docs/ssl.md rename to docs/firststeps-ssl.md diff --git a/docs/syslog.md b/docs/firststeps-syslog.md similarity index 100% rename from docs/syslog.md rename to docs/firststeps-syslog.md diff --git a/docs/update.md b/docs/install-update.md similarity index 100% rename from docs/update.md rename to docs/install-update.md diff --git a/docs/mc14_migrate.md b/docs/migrate-mc014.md similarity index 98% rename from docs/mc14_migrate.md rename to docs/migrate-mc014.md index 73b95059d..818837844 100644 --- a/docs/mc14_migrate.md +++ b/docs/migrate-mc014.md @@ -4,7 +4,7 @@ !!! info Also note that this guide doesn't touch on the users settings like *Spamlevels*, *TLS Settings*, etc. nor the export / import of your roundcube or SOGo settings. - Lastly please check the section on how to [import / restore](backup_maildir/#restore) your maildir backup to get an idea how to migrate your mails. + Lastly please check the section on how to [import / restore](u_e-backup_restore-maildir/#restore) your maildir backup to get an idea how to migrate your mails. ## Create mailcow db backups diff --git a/docs/dns.md b/docs/prerequesite-dns.md similarity index 100% rename from docs/dns.md rename to docs/prerequesite-dns.md diff --git a/docs/requirements.md b/docs/prerequesite-system.md similarity index 97% rename from docs/requirements.md rename to docs/prerequesite-system.md index 1d0a71334..18b5e9f0a 100644 --- a/docs/requirements.md +++ b/docs/prerequesite-system.md @@ -5,7 +5,7 @@ Before you run **mailcow: dockerized**, there are a few requirements that you sh !!! info - Mailcow: dockerized requires [some ports](#default-ports) to be open for incomming connections, so make sure that your firewall is not bloking these. Also make sure that no other application is interferring with mailcow's configuration. - - A correct DNS setup is crucial to every good mailserver setup, so please make sure you got at least the [basics](dns/#the-minimal-dns-configuration) covered bevore you begin! + - A correct DNS setup is crucial to every good mailserver setup, so please make sure you got at least the [basics](prerequesite-dns/#the-minimal-dns-configuration) covered bevore you begin! - Make sure that your system has a correct date and [time setup](#date-and-time). This is crucial for stuff like two factor TOTP authentication. ## Minimum System Resources diff --git a/docs/gogs.md b/docs/third_party-gogs.md similarity index 100% rename from docs/gogs.md rename to docs/third_party-gogs.md diff --git a/docs/portainer.md b/docs/third_party-portainer.md similarity index 100% rename from docs/portainer.md rename to docs/third_party-portainer.md diff --git a/docs/roundcube.md b/docs/third_party-roundcube.md similarity index 100% rename from docs/roundcube.md rename to docs/third_party-roundcube.md diff --git a/docs/80_to_443.md b/docs/u_e-80_to_443.md similarity index 100% rename from docs/80_to_443.md rename to docs/u_e-80_to_443.md diff --git a/docs/autodiscover_config.md b/docs/u_e-autodiscover_config.md similarity index 100% rename from docs/autodiscover_config.md rename to docs/u_e-autodiscover_config.md diff --git a/docs/backup_maildir.md b/docs/u_e-backup_restore-maildir.md similarity index 100% rename from docs/backup_maildir.md rename to docs/u_e-backup_restore-maildir.md diff --git a/docs/mysql.md b/docs/u_e-backup_restore-mysql.md similarity index 100% rename from docs/mysql.md rename to docs/u_e-backup_restore-mysql.md diff --git a/docs/change_config.md b/docs/u_e-change_config.md similarity index 100% rename from docs/change_config.md rename to docs/u_e-change_config.md diff --git a/docs/deinstall.md b/docs/u_e-deinstall.md similarity index 100% rename from docs/deinstall.md rename to docs/u_e-deinstall.md diff --git a/docs/cust_dockerfiles.md b/docs/u_e-docker-cust_dockerfiles.md similarity index 100% rename from docs/cust_dockerfiles.md rename to docs/u_e-docker-cust_dockerfiles.md diff --git a/docs/dc_bash_compl.md b/docs/u_e-docker-dc_bash_compl.md similarity index 100% rename from docs/dc_bash_compl.md rename to docs/u_e-docker-dc_bash_compl.md diff --git a/docs/bl_wl.md b/docs/u_e-mailcow_ui-bl_wl.md similarity index 59% rename from docs/bl_wl.md rename to docs/u_e-mailcow_ui-bl_wl.md index c7ac71790..e78e7f53d 100644 --- a/docs/bl_wl.md +++ b/docs/u_e-mailcow_ui-bl_wl.md @@ -4,4 +4,4 @@ To add or edit an entry to your **domain wide** filter table, login to your *mai !!! info - Be aware that a user [may override](spamfilter.md) this setting by setting his own black- and whitelist! + Be aware that a user [may override](u_e-mailcow_ui-spamalias.md) this setting by setting his own black- and whitelist! diff --git a/docs/mailcow_ui.md b/docs/u_e-mailcow_ui-config.md similarity index 100% rename from docs/mailcow_ui.md rename to docs/u_e-mailcow_ui-config.md diff --git a/docs/spamalias.md b/docs/u_e-mailcow_ui-spamalias.md similarity index 100% rename from docs/spamalias.md rename to docs/u_e-mailcow_ui-spamalias.md diff --git a/docs/spamfilter.md b/docs/u_e-mailcow_ui-spamfilter.md similarity index 82% rename from docs/spamfilter.md rename to docs/u_e-mailcow_ui-spamfilter.md index 37c39b490..e41d4b19f 100644 --- a/docs/spamfilter.md +++ b/docs/u_e-mailcow_ui-spamfilter.md @@ -3,6 +3,6 @@ A mailbox user may adjust the spam filter and black- / whitelist settings for hi ![Where to adjust the users spam, black- and whitelist settings](images/mailcow-spamfilter.png) !!! info - For global adjustments on your spam filter please check our section on [Rspamd](rspamd.md). + For global adjustments on your spam filter please check our section on [Rspamd](u_e-rspamd.md). - For a domain wide black- and whitelist please check our guide on [Black / Whitelist](bl_wl.md) + For a domain wide black- and whitelist please check our guide on [Black / Whitelist](u_e-mailcow_ui-bl_wl.md) diff --git a/docs/tagging.md b/docs/u_e-mailcow_ui-tagging.md similarity index 100% rename from docs/tagging.md rename to docs/u_e-mailcow_ui-tagging.md diff --git a/docs/tfa.md b/docs/u_e-mailcow_ui-tfa.md similarity index 100% rename from docs/tfa.md rename to docs/u_e-mailcow_ui-tfa.md diff --git a/docs/anonym_headers.md b/docs/u_e-postfix-anonym_headers.md similarity index 100% rename from docs/anonym_headers.md rename to docs/u_e-postfix-anonym_headers.md diff --git a/docs/disable_sender_verification.md b/docs/u_e-postfix-disable_sender_verification.md similarity index 100% rename from docs/disable_sender_verification.md rename to docs/u_e-postfix-disable_sender_verification.md diff --git a/docs/redis.md b/docs/u_e-redis.md similarity index 95% rename from docs/redis.md rename to docs/u_e-redis.md index 4f9d3be42..d3f23b303 100644 --- a/docs/redis.md +++ b/docs/u_e-redis.md @@ -30,7 +30,7 @@ OK Get all keys matching your pattern: ``` - +KEYS * ``` ##### PING diff --git a/docs/rspamd.md b/docs/u_e-rspamd.md similarity index 100% rename from docs/rspamd.md rename to docs/u_e-rspamd.md diff --git a/docs/why_bind9.md b/docs/u_e-why_bind9.md similarity index 100% rename from docs/why_bind9.md rename to docs/u_e-why_bind9.md diff --git a/mkdocs.yml b/mkdocs.yml index 186fbe284..be973b7c8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,54 +14,55 @@ markdown_extensions: pages: - 'Information & Support': 'index.md' - 'Prerequisites': - - 'Prepare Your System': 'requirements.md' - - 'DNS Setup': 'dns.md' -- 'Migrating from mailcow 0.14': 'mc14_migrate.md' + - 'Prepare Your System': 'prerequesite-system.md' + - 'DNS Setup': 'prerequesite-dns.md' +- 'Migrating from mailcow 0.14': 'migrate-mc014.md' - 'Installation & Update': - 'Installation': 'install.md' - - 'Update': 'update.md' + - 'Update': 'install-update.md' - 'First Steps (optional)': - - 'SSL': 'ssl.md' - - 'Rspamd Web UI': 'rspamd_ui.md' - - 'Reverse Proxy': 'rp.md' - - 'Setup a relayhost': 'relayhost.md' - - 'Log to Syslog': 'syslog.md' - - 'Local MTA on Docker host': 'local_mta.md' - - 'Sender and receiver model': 'sender_rcv.md' + - 'SSL': 'firststeps-ssl.md' + - 'Rspamd Web UI': 'firststeps-rspamd_ui.md' + - 'Reverse Proxy': 'firststeps-rp.md' + - 'Setup a relayhost': 'firststeps-relayhost.md' + - 'Log to Syslog': 'firststeps-syslog.md' + - 'Local MTA on Docker host': 'firststeps-local_mta.md' + - 'Sender and receiver model': 'firststeps-sender_rcv.md' - 'Debugging & Troubleshooting': - 'Introduction': debug.md - - 'Logs': 'debug_logs.md' - - 'Attach a Container': 'attach_service.md' - - 'Reset Passwords': 'reset_pw.md' - - 'Remove Persistent Data': 'rm_volumes.md' - - 'Common Problems': 'troubles.md' + - 'Logs': 'debug-logs.md' + - 'Attach a Container': 'debug-attach_service.md' + - 'Reset Passwords': 'debug-reset_pw.md' + - 'Remove Persistent Data': 'debug-rm_volumes.md' + - 'Common Problems': 'debug-common_problems.md' - 'Usage & Examples': - 'mailcow UI': - - 'Configuration': 'mailcow_ui.md' - - 'Blacklist / Whitelist': 'bl_wl.md' - - 'Spamfilter': 'spamfilter.md' - - 'Temporary email aliase': 'spamalias.md' - - 'Tagging': 'tagging.md' - - 'Two-Factor Authentication': 'tfa.md' - - 'Redis': 'redis.md' - - 'Rspamd': 'rspamd.md' + - 'Configuration': 'u_e-mailcow_ui-config.md' + - 'Blacklist / Whitelist': 'u_e-mailcow_ui-bl_wl.md' + - 'Spamfilter': 'u_e-mailcow_ui-spamfilter.md' + - 'Temporary email aliase': 'u_e-mailcow_ui-spamalias.md' + - 'Tagging': 'u_e-mailcow_ui-tagging.md' + - 'Two-Factor Authentication': 'u_e-mailcow_ui-tfa.md' + - 'Redis': 'u_e-redis.md' + - 'Rspamd': 'u_e-rspamd.md' - 'Postfix': - - 'Anonymize Headers': 'anonym_headers.md' - - 'Disable Sender Addresses Verification': 'disable_sender_verification.md' - - 'Why bind9?': 'why_bind9.md' + - 'Anonymize Headers': 'u_e-postfix-anonym_headers.md' + - 'Disable Sender Addresses Verification': 'u_e-postfix-disable_sender_verification.md' + - 'Docker': + - 'Customize Dockerfiles': 'u_e-docker-cust_dockerfiles.md' + - 'Docker Compose Bash Completion': 'u_e-docker-dc_bash_compl.md' + - 'Why bind9?': 'u_e-why_bind9.md' - 'Backup & Restore': - - 'Backup Maildir': 'backup_maildir.md' - - 'MySQL': 'mysql.md' - - 'Autodiscover / Autoconfig': 'autodiscover_config.md' - - 'Redirect HTTP to HTTPS': '80_to_443.md' - - 'Adjust Service Configurations': 'change_config.md' - - 'Customize Dockerfiles': 'cust_dockerfiles.md' - - 'Docker Compose Bash Completion': 'dc_bash_compl.md' - - 'Deinstall': 'deinstall.md' + - 'Backup Maildir': 'u_e-backup_restore-maildir.md' + - 'MySQL': 'u_e-backup_restore-mysql.md' + - 'Autodiscover / Autoconfig': 'u_e-autodiscover_config.md' + - 'Redirect HTTP to HTTPS': 'u_e-80_to_443.md' + - 'Adjust Service Configurations': 'u_e-change_config.md' + - 'Deinstall': 'u_e-deinstall.md' - 'Third party apps': - - 'Roundcube': 'roundcube.md' - - 'Portainer': 'portainer.md' - - 'Gogs': 'gogs.md' + - 'Roundcube': 'third_party-roundcube.md' + - 'Portainer': 'third_party-portainer.md' + - 'Gogs': 'third_party-gogs.md' extra: logo: 'images/logo.svg' palette: