diff --git a/docs/service_desc.md b/docs/attach_service.md similarity index 98% rename from docs/service_desc.md rename to docs/attach_service.md index 64115ea37..a45a10ce6 100644 --- a/docs/service_desc.md +++ b/docs/attach_service.md @@ -1,18 +1,3 @@ -Here is a brief overview of what container / service does what: - -| Service Name | Service Descriptions | -| --------------- | ------------------------------------------------------------------------- | -| bind9-mailcow | Local (DNSSEC) DNS Resolver | -| mysql-mailcow | Stores SOGo's and most of mailcow's settings | -| postfix-mailcow | Receives and sends mails | -| dovecot-mailcow | User logins and sieve filter | -| redis-mailcow | Storage backend for DKIM keys, Rmilter and Rspamd | -| rspamd-mailcow | Mail filtering system. Used for av handling, dkim signing, spam handling | -| rmilter-mailcow | Integrates Rspamd into postfix | -| clamd-mailcow | Scans attachments for viruses | -| sogo-mailcow | Webmail client that handles Microsoft ActiveSync and Cal- / CardDav | -| nginx-mailcow | Nginx remote proxy that handles all mailcow related HTTP / HTTPS requests | - ## Attaching a Container to your Shell To attach a container to your shell you can simply run @@ -37,3 +22,20 @@ docker-compose exec mysql-mailcow mysql -u${DBUSER} -p${DBPASS} ${DBNAME} ``` docker-compose exec redis-mailcow redis-cli ``` + +## Service Descriptions + +Here is a brief overview of what container / service does what: + +| Service Name | Service Descriptions | +| --------------- | ------------------------------------------------------------------------- | +| bind9-mailcow | Local (DNSSEC) DNS Resolver | +| mysql-mailcow | Stores SOGo's and most of mailcow's settings | +| postfix-mailcow | Receives and sends mails | +| dovecot-mailcow | User logins and sieve filter | +| redis-mailcow | Storage backend for DKIM keys, Rmilter and Rspamd | +| rspamd-mailcow | Mail filtering system. Used for av handling, dkim signing, spam handling | +| rmilter-mailcow | Integrates Rspamd into postfix | +| clamd-mailcow | Scans attachments for viruses | +| sogo-mailcow | Webmail client that handles Microsoft ActiveSync and Cal- / CardDav | +| nginx-mailcow | Nginx remote proxy that handles all mailcow related HTTP / HTTPS requests | diff --git a/mkdocs.yml b/mkdocs.yml index 5bc9d7633..4632fb050 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -31,8 +31,8 @@ pages: - 'Debugging & Troubleshooting': - 'Introduction': debug.md - 'Logs': 'debug_logs.md' + - 'Attach a Container': 'attach_service.md' - 'Reset Passwords': 'reset_pw.md' - - 'Service Descriptions': 'service_desc.md' - 'Remove Persistent Data': 'rm_volumes.md' - 'Usage & Examples': - 'mailcow UI':