mailcow-dockerized-docs/site/index.html
2022-01-29 17:48:02 +01:00

539 Zeilen
20 KiB
HTML

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://mailcow.github.io/mailcow-dockerized-docs/">
<link rel="icon" href="assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.8">
<title>mailcow: dockerized documentation</title>
<link rel="stylesheet" href="assets/stylesheets/main.6e60f8b8.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.e6a45f82.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL(".",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#_1" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="." title="mailcow: dockerized documentation" class="md-header__button md-logo" aria-label="mailcow: dockerized documentation" data-md-component="logo">
<img src="assets/images/logo.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
mailcow: dockerized documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
🐮 + 🐋 = 💕
</span>
</div>
</div>
</div>
<div class="md-header__option">
<div class="md-select">
<button class="md-header__button md-icon" aria-label="Select language">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12.87 15.07-2.54-2.51.03-.03A17.52 17.52 0 0 0 14.07 6H17V4h-7V2H8v2H1v2h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04M18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12m-2.62 7 1.62-4.33L19.12 17h-3.24z"/></svg>
</button>
<div class="md-select__inner">
<ul class="md-select__list">
<li class="md-select__item">
<a href="./" hreflang="en" class="md-select__link">
English
</a>
</li>
<li class="md-select__item">
<a href="de/" hreflang="de" class="md-select__link">
Deutsch
</a>
</li>
</ul>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/mailcow/mailcow-dockerized/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
mailcow/mailcow-dockerized
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="." title="mailcow: dockerized documentation" class="md-nav__button md-logo" aria-label="mailcow: dockerized documentation" data-md-component="logo">
<img src="assets/images/logo.svg" alt="logo">
</a>
mailcow: dockerized documentation
</label>
<div class="md-nav__source">
<a href="https://github.com/mailcow/mailcow-dockerized/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
mailcow/mailcow-dockerized
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
🐮 + 🐋 = 💕
<span class="md-nav__icon md-icon"></span>
</label>
<a href="." class="md-nav__link md-nav__link--active">
🐮 + 🐋 = 💕
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#help-mailcow" class="md-nav__link">
Help mailcow
</a>
</li>
<li class="md-nav__item">
<a href="#get-support" class="md-nav__link">
Get support
</a>
<nav class="md-nav" aria-label="Get support">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#commercial-support" class="md-nav__link">
Commercial support
</a>
</li>
<li class="md-nav__item">
<a href="#community-support-and-chat" class="md-nav__link">
Community support and chat
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#demo" class="md-nav__link">
Demo
</a>
</li>
<li class="md-nav__item">
<a href="#overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#help-mailcow" class="md-nav__link">
Help mailcow
</a>
</li>
<li class="md-nav__item">
<a href="#get-support" class="md-nav__link">
Get support
</a>
<nav class="md-nav" aria-label="Get support">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#commercial-support" class="md-nav__link">
Commercial support
</a>
</li>
<li class="md-nav__item">
<a href="#community-support-and-chat" class="md-nav__link">
Community support and chat
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#demo" class="md-nav__link">
Demo
</a>
</li>
<li class="md-nav__item">
<a href="#overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/mailcow/mailcow-dockerized-docs/edit/master/docs/index.en.md" title="Edit this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
</a>
<h1 id="_1">🐮 + 🐋 = 💕</h1>
<h2 id="help-mailcow">Help mailcow</h2>
<p>Please consider a support contract for a small monthly fee at <a href="https://www.servercow.de/mailcow?lang=en#support">Servercow EN</a>/<a href="https://www.servercow.de/mailcow?#support">Servercow DE</a> to support further development. <em>We</em> support <em>you</em> while <em>you</em> support <em>us</em>. :)</p>
<p>If you are super awesome and would like to support without a contract, you can get a SAL license that confirms your awesomeness (a flexible one-time payment) at <a href="https://www.servercow.de/mailcow?lang=en#sal">Servercow EN</a>/<a href="https://www.servercow.de/mailcow#sal">Servercow DE</a>.</p>
<h2 id="get-support">Get support</h2>
<p>There are two ways to achieve support for your mailcow installation.</p>
<h3 id="commercial-support">Commercial support</h3>
<p>For professional and prioritized commercial support you can sign a basic support subscription at <a href="https://www.servercow.de/mailcow?lang=en#support">Servercow EN</a>/<a href="https://www.servercow.de/mailcow#support">Servercow DE</a>. For custom inquiries or questions please contact us at <a href="mailto:info@servercow.de">info@servercow.de</a> instead.</p>
<p>Furthermore we do also provide a fully featured and managed mailcow <a href="https://www.servercow.de/mailcow#managed">here</a>. This way we take care about the technical magic underneath and you can enjoy your whole mail experience in a hassle-free way.</p>
<h3 id="community-support-and-chat">Community support and chat</h3>
<p>The other alternative is our free community-support on our various channels below. Please notice, that this support is driven by our awesome community around mailcow. This kind of support is best-effort, voluntary and there is no guarantee for anything.</p>
<ul>
<li>
<p>Our mailcow community @ <a href="https://community.mailcow.email">community.mailcow.email</a></p>
</li>
<li>
<p>Telegram @ <a href="https://t.me/mailcow">t.me/mailcow</a>.</p>
</li>
<li>
<p>Telegram @ <a href="https://t.me/mailcowOfftopic">t.me/mailcowOfftopic</a>.</p>
</li>
</ul>
<p>Telegram desktop clients are available for <a href="https://desktop.telegram.org">multiple platforms</a>. You can search the groups history for keywords.</p>
<p>For <strong>bug tracking, feature requests and code contributions</strong> only:</p>
<ul>
<li>GitHub @ <a href="https://github.com/mailcow/mailcow-dockerized">mailcow/mailcow-dockerized</a></li>
</ul>
<h2 id="demo">Demo</h2>
<p>You can find a demo at <a href="https://demo.mailcow.email">demo.mailcow.email</a>, use the following credentials to login:</p>
<ul>
<li><strong>Administrator</strong>: admin / moohoo</li>
<li><strong>Domain administrator</strong>: department / moohoo</li>
<li><strong>Mailbox</strong>: demo@440044.xyz / moohoo</li>
</ul>
<h2 id="overview">Overview</h2>
<p>The integrated <strong>mailcow UI</strong> allows administrative work on your mail server instance as well as separated domain administrator and mailbox user access:</p>
<ul>
<li><a href="http://dkim.org">DKIM</a> and <a href="http://arc-spec.org/">ARC</a> support</li>
<li>Black- and whitelists per domain and per user</li>
<li>Spam score management per-user (reject spam, mark spam, greylist)</li>
<li>Allow mailbox users to create temporary spam aliases</li>
<li>Prepend mail tags to subject or move mail to sub folder (per-user)</li>
<li>Allow mailbox users to toggle incoming and outgoing TLS enforcement</li>
<li>Allow users to reset SOGo ActiveSync device caches</li>
<li>imapsync to migrate or pull remote mailboxes regularly</li>
<li>TFA: Yubikey OTP and U2F USB (Google Chrome and derivatives only), TOTP</li>
<li>Add domains, mailboxes, aliases, domain aliases and SOGo resources</li>
<li>Add whitelisted hosts to forward mail to mailcow</li>
<li>Fail2ban-like integration</li>
<li>Quarantine system</li>
<li>Antivirus scanning incl. macro scanning in office documents</li>
<li>Integrated basic monitoring</li>
<li>A lot more...</li>
</ul>
<p>mailcow: dockerized comes with multiple containers linked in one bridged network.
Each container represents a single application.</p>
<ul>
<li><a href="https://letsencrypt.org/">ACME</a></li>
<li><a href="https://www.clamav.net/">ClamAV</a> (optional)</li>
<li><a href="https://www.dovecot.org/">Dovecot</a></li>
<li><a href="https://mariadb.org/">MariaDB</a></li>
<li><a href="https://www.memcached.org/">Memcached</a></li>
<li><a href="https://www.netfilter.org/">Netfilter</a> (Fail2ban-like integration by <a href="https://github.com/mkuron">@mkuron</a>)</li>
<li><a href="https://nginx.org/">Nginx</a></li>
<li><a href="https://github.com/decalage2/oletools">Oletools</a> via <a href="https://github.com/HeinleinSupport/olefy">Olefy</a></li>
<li><a href="https://php.net/">PHP</a></li>
<li><a href="http://www.postfix.org/">Postfix</a></li>
<li><a href="https://redis.io/">Redis</a></li>
<li><a href="https://www.rspamd.com/">Rspamd</a></li>
<li><a href="https://sogo.nu/">SOGo</a></li>
<li><a href="https://solr.apache.org/">Solr</a> (optional)</li>
<li><a href="https://unbound.net/">Unbound</a></li>
<li>A Watchdog to provide basic monitoring</li>
</ul>
<p><strong>Docker volumes</strong> to keep dynamic data - take care of them!</p>
<ul>
<li>crypt-vol-1</li>
<li>mysql-socket-vol-1</li>
<li>mysql-vol-1</li>
<li>postfix-vol-1</li>
<li>redis-vol-1</li>
<li>rspamd-vol-1</li>
<li>sogo-userdata-backup-vol-1</li>
<li>sogo-web-vol-1</li>
<li>solr-vol-1</li>
<li>vmail-index-vol-1</li>
<li>vmail-vol-1</li>
</ul>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Copyright &copy; 2022 Servercow Team & Community<br>Based on the work from André Peters
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": ".", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "assets/javascripts/workers/search.22074ed6.min.js"}</script>
<script src="assets/javascripts/bundle.960e086b.min.js"></script>
</body>
</html>