2023-02-19 12:25:43 +00:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< meta name = "description" content = "A fullstack but simple mail-server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.) using Docker." >
< meta name = "author" content = "docker-mailserver (Github Organization)" >
< link rel = "canonical" href = "https://docker-mailserver.github.io/docker-mailserver/edge/usage/" >
2023-04-08 09:54:44 +00:00
< link rel = "prev" href = "../introduction/" >
< link rel = "next" href = "../config/environment/" >
2023-02-19 12:25:43 +00:00
< link rel = "icon" href = "../assets/logo/favicon-32x32.png" >
2023-04-08 09:54:44 +00:00
< meta name = "generator" content = "mkdocs-1.4.2, mkdocs-material-9.1.5" >
2023-02-19 12:25:43 +00:00
< title > Usage - Docker Mailserver< / title >
2023-04-08 09:54:44 +00:00
< link rel = "stylesheet" href = "../assets/stylesheets/main.7a7fce14.min.css" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< link rel = "stylesheet" href = "../assets/stylesheets/palette.a0c5b2b5.min.css" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
2023-02-19 12:25:43 +00:00
< link rel = "preconnect" href = "https://fonts.gstatic.com" crossorigin >
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" >
< style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style >
< link rel = "stylesheet" href = "../assets/css/customizations.css" >
2023-04-08 09:54:44 +00:00
< script > _ _md _scope = new URL ( ".." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) , 0 ) , _ _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 >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
2023-02-19 12:25:43 +00:00
< / head >
< body dir = "ltr" data-md-color-scheme = "default" data-md-color-primary = "indigo" data-md-color-accent = "indigo" >
< script > var palette = _ _md _get ( "__palette" ) ; if ( palette && "object" == typeof palette . color ) for ( var key of Object . keys ( palette . color ) ) document . body . setAttribute ( "data-md-color-" + key , palette . color [ key ] ) < / script >
< 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" >
2023-04-08 09:54:44 +00:00
< a href = "#preliminary-steps" class = "md-skip" >
2023-02-19 12:25:43 +00:00
Skip to content
< / a >
< / div >
< div data-md-component = "announce" >
< / div >
2023-04-08 09:54:44 +00:00
< div data-md-color-scheme = "default" data-md-component = "outdated" hidden >
2023-02-19 12:25:43 +00:00
< / div >
< header class = "md-header" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
< a href = ".." title = "Docker Mailserver" class = "md-header__button md-logo" aria-label = "Docker Mailserver" data-md-component = "logo" >
< img src = "../assets/logo/dmo-logo-white.min.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" >
Docker Mailserver
< / span >
< / div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
Usage
< / span >
< / div >
< / div >
< / div >
< form class = "md-header__option" data-md-component = "palette" >
< input class = "md-option" data-md-color-media = "(prefers-color-scheme: light)" data-md-color-scheme = "default" data-md-color-primary = "indigo" data-md-color-accent = "indigo" aria-label = "Switch to dark mode" type = "radio" name = "__palette" id = "__palette_1" >
< label class = "md-header__button md-icon" title = "Switch to dark mode" for = "__palette_2" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z" / > < / svg >
< / label >
< input class = "md-option" data-md-color-media = "(prefers-color-scheme: dark)" data-md-color-scheme = "slate" data-md-color-primary = "indigo" data-md-color-accent = "blue" aria-label = "Switch to light mode" type = "radio" name = "__palette" id = "__palette_2" >
< label class = "md-header__button md-icon" title = "Switch to light mode" for = "__palette_1" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z" / > < / svg >
< / label >
< / form >
< 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" >
2023-04-08 09:54:44 +00:00
< button type = "reset" class = "md-search__icon md-icon" title = "Clear" aria-label = "Clear" tabindex = "-1" >
2023-02-19 12:25:43 +00:00
< 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 >
2023-04-08 09:54:44 +00:00
< ol class = "md-search-result__list" role = "presentation" > < / ol >
2023-02-19 12:25:43 +00:00
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "md-header__source" >
< a href = "https://github.com/docker-mailserver/docker-mailserver" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
2023-04-08 09:54:44 +00:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 496 512" > <!-- ! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z" / > < / svg >
2023-02-19 12:25:43 +00:00
< / div >
< div class = "md-source__repository" >
docker-mailserver
< / div >
< / a >
< / div >
< / nav >
< / header >
< div class = "md-container" data-md-component = "container" >
< nav class = "md-tabs" aria-label = "Tabs" data-md-component = "tabs" >
2023-04-08 09:54:44 +00:00
< div class = "md-grid" >
2023-02-19 12:25:43 +00:00
< ul class = "md-tabs__list" >
< li class = "md-tabs__item" >
< a href = ".." class = "md-tabs__link" >
Home
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../introduction/" class = "md-tabs__link" >
Introduction
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "./" class = "md-tabs__link md-tabs__link--active" >
Usage
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../config/environment/" class = "md-tabs__link" >
Configuration
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../examples/tutorials/basic-installation/" class = "md-tabs__link" >
Examples
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../faq/" class = "md-tabs__link" >
FAQ
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../contributing/general/" class = "md-tabs__link" >
Contributing
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "https://hub.docker.com/r/mailserver/docker-mailserver/" class = "md-tabs__link" >
DockerHub
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "https://github.com/docker-mailserver/docker-mailserver/pkgs/container/docker-mailserver" class = "md-tabs__link" >
GHCR
< / a >
< / li >
< / ul >
< / div >
< / nav >
< 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 md-nav--lifted" aria-label = "Navigation" data-md-level = "0" >
< label class = "md-nav__title" for = "__drawer" >
< a href = ".." title = "Docker Mailserver" class = "md-nav__button md-logo" aria-label = "Docker Mailserver" data-md-component = "logo" >
< img src = "../assets/logo/dmo-logo-white.min.svg" alt = "logo" >
< / a >
Docker Mailserver
< / label >
< div class = "md-nav__source" >
< a href = "https://github.com/docker-mailserver/docker-mailserver" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
2023-04-08 09:54:44 +00:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 496 512" > <!-- ! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z" / > < / svg >
2023-02-19 12:25:43 +00:00
< / div >
< div class = "md-source__repository" >
docker-mailserver
< / div >
< / a >
< / div >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = ".." class = "md-nav__link" >
Home
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../introduction/" class = "md-nav__link" >
Introduction
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active" >
2023-04-08 09:54:44 +00:00
< input class = "md-nav__toggle md-toggle" type = "checkbox" id = "__toc" >
2023-02-19 12:25:43 +00:00
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
Usage
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "./" class = "md-nav__link md-nav__link--active" >
Usage
< / 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" >
2023-04-08 09:54:44 +00:00
< a href = "#preliminary-steps" class = "md-nav__link" >
Preliminary Steps
2023-02-19 12:25:43 +00:00
< / a >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" aria-label = "Preliminary Steps" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#host-setup" class = "md-nav__link" >
Host Setup
2023-02-19 12:25:43 +00:00
< / a >
< / li >
2023-04-08 09:54:44 +00:00
< li class = "md-nav__item" >
< a href = "#minimal-dns-setup" class = "md-nav__link" >
Minimal DNS Setup
2023-02-19 12:25:43 +00:00
< / a >
2023-04-08 09:54:44 +00:00
< / li >
< / ul >
< / nav >
2023-02-19 12:25:43 +00:00
< / li >
< li class = "md-nav__item" >
2023-04-08 09:54:44 +00:00
< a href = "#deploying-the-actual-image" class = "md-nav__link" >
Deploying the Actual Image
2023-02-19 12:25:43 +00:00
< / a >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" aria-label = "Deploying the Actual Image" >
2023-02-19 12:25:43 +00:00
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
2023-04-08 09:54:44 +00:00
< a href = "#tagging-convention" class = "md-nav__link" >
Tagging Convention
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#get-all-files" class = "md-nav__link" >
Get All Files
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configuration-steps" class = "md-nav__link" >
Configuration Steps
2023-02-19 12:25:43 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2023-04-08 09:54:44 +00:00
< a href = "#get-up-and-running" class = "md-nav__link" >
Get Up and Running
2023-02-19 12:25:43 +00:00
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#further-miscellaneous-steps" class = "md-nav__link" >
Further Miscellaneous Steps
< / a >
< nav class = "md-nav" aria-label = "Further Miscellaneous Steps" >
< ul class = "md-nav__list" >
2023-04-08 21:55:05 +00:00
< li class = "md-nav__item" >
< a href = "#setting-up-tls" class = "md-nav__link" >
Setting up TLS
< / a >
< / li >
2023-02-19 12:25:43 +00:00
< li class = "md-nav__item" >
2023-04-08 09:54:44 +00:00
< a href = "#aliases" class = "md-nav__link" >
Aliases
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#dkim-keys" class = "md-nav__link" >
DKIM Keys
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#advanced-dns-setup" class = "md-nav__link" >
Advanced DNS Setup
2023-02-19 12:25:43 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#custom-user-changes-patches" class = "md-nav__link" >
Custom User Changes & Patches
< / a >
< / li >
< / ul >
< / nav >
2023-04-08 09:54:44 +00:00
< / li >
< li class = "md-nav__item" >
< a href = "#testing" class = "md-nav__link" >
Testing
< / a >
2023-02-19 12:25:43 +00:00
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2023-04-08 09:54:44 +00:00
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" type = "checkbox" id = "__nav_4" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< label class = "md-nav__link" for = "__nav_4" id = "__nav_4_label" tabindex = "0" >
2023-02-19 12:25:43 +00:00
Configuration
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_4_label" aria-expanded = "false" >
2023-02-19 12:25:43 +00:00
< label class = "md-nav__title" for = "__nav_4" >
< span class = "md-nav__icon md-icon" > < / span >
Configuration
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../config/environment/" class = "md-nav__link" >
Environment Variables
< / a >
< / li >
< li class = "md-nav__item" >
2023-04-09 09:27:22 +00:00
< a href = "../config/user-management/" class = "md-nav__link" >
User Management
2023-02-19 12:25:43 +00:00
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2023-04-08 09:54:44 +00:00
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" type = "checkbox" id = "__nav_4_3" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< label class = "md-nav__link" for = "__nav_4_3" id = "__nav_4_3_label" tabindex = "0" >
2023-02-19 12:25:43 +00:00
Best Practices
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_4_3_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_4_3" >
2023-02-19 12:25:43 +00:00
< span class = "md-nav__icon md-icon" > < / span >
Best Practices
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../config/best-practices/dkim/" class = "md-nav__link" >
DKIM
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/best-practices/dmarc/" class = "md-nav__link" >
DMARC
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/best-practices/spf/" class = "md-nav__link" >
SPF
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/best-practices/autodiscover/" class = "md-nav__link" >
Auto-discovery
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2023-04-08 09:54:44 +00:00
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" type = "checkbox" id = "__nav_4_4" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< label class = "md-nav__link" for = "__nav_4_4" id = "__nav_4_4_label" tabindex = "0" >
2023-02-19 12:25:43 +00:00
Security
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_4_4_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_4_4" >
2023-02-19 12:25:43 +00:00
< span class = "md-nav__icon md-icon" > < / span >
Security
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../config/security/understanding-the-ports/" class = "md-nav__link" >
Understanding the Ports
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/security/ssl/" class = "md-nav__link" >
SSL/TLS
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/security/fail2ban/" class = "md-nav__link" >
Fail2Ban
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/security/mail_crypt/" class = "md-nav__link" >
Mail Encryption
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/security/rspamd/" class = "md-nav__link" >
Rspamd
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
2023-04-08 09:54:44 +00:00
< a href = "../config/debugging/" class = "md-nav__link" >
2023-02-19 12:25:43 +00:00
Debugging
< / a >
< / li >
2023-04-08 09:54:44 +00:00
< li class = "md-nav__item" >
< a href = "../config/pop3/" class = "md-nav__link" >
Mail Delivery with POP3
< / a >
2023-02-19 12:25:43 +00:00
< / li >
< li class = "md-nav__item" >
2023-04-08 09:54:44 +00:00
< a href = "../config/setup.sh/" class = "md-nav__link" >
2023-04-10 09:37:49 +00:00
About setup.sh
2023-02-19 12:25:43 +00:00
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2023-04-08 09:54:44 +00:00
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" type = "checkbox" id = "__nav_4_8" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< label class = "md-nav__link" for = "__nav_4_8" id = "__nav_4_8_label" tabindex = "0" >
2023-02-19 12:25:43 +00:00
Advanced Configuration
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_4_8_label" aria-expanded = "false" >
2023-02-19 12:25:43 +00:00
< label class = "md-nav__title" for = "__nav_4_8" >
< span class = "md-nav__icon md-icon" > < / span >
Advanced Configuration
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../config/advanced/optional-config/" class = "md-nav__link" >
Optional Configuration
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2023-04-08 09:54:44 +00:00
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" type = "checkbox" id = "__nav_4_8_2" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< label class = "md-nav__link" for = "__nav_4_8_2" id = "__nav_4_8_2_label" tabindex = "0" >
2023-02-19 12:25:43 +00:00
Maintenance
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" data-md-level = "3" aria-labelledby = "__nav_4_8_2_label" aria-expanded = "false" >
2023-02-19 12:25:43 +00:00
< label class = "md-nav__title" for = "__nav_4_8_2" >
< span class = "md-nav__icon md-icon" > < / span >
Maintenance
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../config/advanced/maintenance/update-and-cleanup/" class = "md-nav__link" >
Update and Cleanup
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2023-04-08 09:54:44 +00:00
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" type = "checkbox" id = "__nav_4_8_3" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< label class = "md-nav__link" for = "__nav_4_8_3" id = "__nav_4_8_3_label" tabindex = "0" >
2023-02-19 12:25:43 +00:00
Override the Default Configs
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" data-md-level = "3" aria-labelledby = "__nav_4_8_3_label" aria-expanded = "false" >
2023-02-19 12:25:43 +00:00
< label class = "md-nav__title" for = "__nav_4_8_3" >
< span class = "md-nav__icon md-icon" > < / span >
Override the Default Configs
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../config/advanced/override-defaults/dovecot/" class = "md-nav__link" >
Dovecot
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/advanced/override-defaults/postfix/" class = "md-nav__link" >
Postfix
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/advanced/override-defaults/user-patches/" class = "md-nav__link" >
Modifications via Script
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../config/advanced/auth-ldap/" class = "md-nav__link" >
LDAP Authentication
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/advanced/mail-sieve/" class = "md-nav__link" >
Email Filtering with Sieve
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/advanced/mail-fetchmail/" class = "md-nav__link" >
Email Gathering with Fetchmail
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2023-04-08 09:54:44 +00:00
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" type = "checkbox" id = "__nav_4_8_7" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< label class = "md-nav__link" for = "__nav_4_8_7" id = "__nav_4_8_7_label" tabindex = "0" >
2023-02-19 12:25:43 +00:00
Email Forwarding
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" data-md-level = "3" aria-labelledby = "__nav_4_8_7_label" aria-expanded = "false" >
2023-02-19 12:25:43 +00:00
< label class = "md-nav__title" for = "__nav_4_8_7" >
< span class = "md-nav__icon md-icon" > < / span >
Email Forwarding
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../config/advanced/mail-forwarding/relay-hosts/" class = "md-nav__link" >
Relay Hosts
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/advanced/mail-forwarding/aws-ses/" class = "md-nav__link" >
AWS SES
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../config/advanced/full-text-search/" class = "md-nav__link" >
Full-Text Search
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/advanced/kubernetes/" class = "md-nav__link" >
Kubernetes
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/advanced/ipv6/" class = "md-nav__link" >
IPv6
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/advanced/podman/" class = "md-nav__link" >
Podman
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/advanced/dovecot-master-accounts/" class = "md-nav__link" >
Dovecot Master Accounts
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2023-04-08 09:54:44 +00:00
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" type = "checkbox" id = "__nav_5" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< label class = "md-nav__link" for = "__nav_5" id = "__nav_5_label" tabindex = "0" >
2023-02-19 12:25:43 +00:00
Examples
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_5_label" aria-expanded = "false" >
2023-02-19 12:25:43 +00:00
< label class = "md-nav__title" for = "__nav_5" >
< span class = "md-nav__icon md-icon" > < / span >
Examples
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--nested" >
2023-04-08 09:54:44 +00:00
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" type = "checkbox" id = "__nav_5_1" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< label class = "md-nav__link" for = "__nav_5_1" id = "__nav_5_1_label" tabindex = "0" >
2023-02-19 12:25:43 +00:00
Tutorials
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_5_1_label" aria-expanded = "false" >
2023-02-19 12:25:43 +00:00
< label class = "md-nav__title" for = "__nav_5_1" >
< span class = "md-nav__icon md-icon" > < / span >
Tutorials
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../examples/tutorials/basic-installation/" class = "md-nav__link" >
Basic Installation
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../examples/tutorials/mailserver-behind-proxy/" class = "md-nav__link" >
Mailserver behind Proxy
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../examples/tutorials/docker-build/" class = "md-nav__link" >
Building your own Docker image
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../examples/tutorials/blog-posts/" class = "md-nav__link" >
Blog Posts
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2023-04-08 09:54:44 +00:00
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" type = "checkbox" id = "__nav_5_2" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< label class = "md-nav__link" for = "__nav_5_2" id = "__nav_5_2_label" tabindex = "0" >
2023-02-19 12:25:43 +00:00
Use Cases
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_5_2_label" aria-expanded = "false" >
2023-02-19 12:25:43 +00:00
< label class = "md-nav__title" for = "__nav_5_2" >
< span class = "md-nav__icon md-icon" > < / span >
Use Cases
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../examples/use-cases/forward-only-mailserver-with-ldap-authentication/" class = "md-nav__link" >
Forward-Only Mail-Server with LDAP
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../examples/use-cases/imap-folders/" class = "md-nav__link" >
Customize IMAP Folders
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../faq/" class = "md-nav__link" >
FAQ
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2023-04-08 09:54:44 +00:00
< input class = "md-nav__toggle md-toggle md-toggle--indeterminate" type = "checkbox" id = "__nav_7" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< label class = "md-nav__link" for = "__nav_7" id = "__nav_7_label" tabindex = "0" >
2023-02-19 12:25:43 +00:00
Contributing
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_7_label" aria-expanded = "false" >
2023-02-19 12:25:43 +00:00
< label class = "md-nav__title" for = "__nav_7" >
< span class = "md-nav__icon md-icon" > < / span >
Contributing
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../contributing/general/" class = "md-nav__link" >
General Information
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../contributing/tests/" class = "md-nav__link" >
Tests
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../contributing/issues-and-pull-requests/" class = "md-nav__link" >
Issues and Pull Requests
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "https://hub.docker.com/r/mailserver/docker-mailserver/" class = "md-nav__link" >
DockerHub
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "https://github.com/docker-mailserver/docker-mailserver/pkgs/container/docker-mailserver" class = "md-nav__link" >
GHCR
< / a >
< / 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" >
2023-04-08 09:54:44 +00:00
< a href = "#preliminary-steps" class = "md-nav__link" >
Preliminary Steps
2023-02-19 12:25:43 +00:00
< / a >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" aria-label = "Preliminary Steps" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#host-setup" class = "md-nav__link" >
Host Setup
2023-02-19 12:25:43 +00:00
< / a >
< / li >
2023-04-08 09:54:44 +00:00
< li class = "md-nav__item" >
< a href = "#minimal-dns-setup" class = "md-nav__link" >
Minimal DNS Setup
2023-02-19 12:25:43 +00:00
< / a >
2023-04-08 09:54:44 +00:00
< / li >
< / ul >
< / nav >
2023-02-19 12:25:43 +00:00
< / li >
< li class = "md-nav__item" >
2023-04-08 09:54:44 +00:00
< a href = "#deploying-the-actual-image" class = "md-nav__link" >
Deploying the Actual Image
2023-02-19 12:25:43 +00:00
< / a >
2023-04-08 09:54:44 +00:00
< nav class = "md-nav" aria-label = "Deploying the Actual Image" >
2023-02-19 12:25:43 +00:00
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
2023-04-08 09:54:44 +00:00
< a href = "#tagging-convention" class = "md-nav__link" >
Tagging Convention
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#get-all-files" class = "md-nav__link" >
Get All Files
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#configuration-steps" class = "md-nav__link" >
Configuration Steps
2023-02-19 12:25:43 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
2023-04-08 09:54:44 +00:00
< a href = "#get-up-and-running" class = "md-nav__link" >
Get Up and Running
2023-02-19 12:25:43 +00:00
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#further-miscellaneous-steps" class = "md-nav__link" >
Further Miscellaneous Steps
< / a >
< nav class = "md-nav" aria-label = "Further Miscellaneous Steps" >
< ul class = "md-nav__list" >
2023-04-08 21:55:05 +00:00
< li class = "md-nav__item" >
< a href = "#setting-up-tls" class = "md-nav__link" >
Setting up TLS
< / a >
< / li >
2023-02-19 12:25:43 +00:00
< li class = "md-nav__item" >
2023-04-08 09:54:44 +00:00
< a href = "#aliases" class = "md-nav__link" >
Aliases
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#dkim-keys" class = "md-nav__link" >
DKIM Keys
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#advanced-dns-setup" class = "md-nav__link" >
Advanced DNS Setup
2023-02-19 12:25:43 +00:00
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#custom-user-changes-patches" class = "md-nav__link" >
Custom User Changes & Patches
< / a >
< / li >
< / ul >
< / nav >
2023-04-08 09:54:44 +00:00
< / li >
< li class = "md-nav__item" >
< a href = "#testing" class = "md-nav__link" >
Testing
< / a >
2023-02-19 12:25:43 +00:00
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
2023-04-08 09:54:44 +00:00
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
2023-02-19 12:25:43 +00:00
< h1 > Usage< / h1 >
2023-04-08 09:54:44 +00:00
< p > This pages explains how to get started with DMS. The guide uses Docker Compose as a reference. In our examples, a volume mounts the host location < a href = "../config/advanced/optional-config/" > < code > docker-data/dms/config/< / code > < / a > to < code > /tmp/docker-mailserver/< / code > inside the container.< / p >
< h2 id = "preliminary-steps" > < a class = "toclink" href = "#preliminary-steps" > Preliminary Steps< / a > < / h2 >
< p > Before you can get started with deploying your own mail server, there are some requirements to be met:< / p >
< ol >
< li > You need to have a host that you can manage.< / li >
< li > You need to own a domain, and you need to able to manage DNS for this domain.< / li >
< / ol >
< h3 id = "host-setup" > < a class = "toclink" href = "#host-setup" > Host Setup< / a > < / h3 >
< p > There are a few requirements for a suitable host system:< / p >
< ol >
< li > The host should have a static IP address; otherwise you will need to dynamically update DNS (undesirable due to DNS caching)< / li >
< li > The host should be able to send/receive on the < a href = "../config/security/understanding-the-ports/#overview-of-email-ports" > necessary ports for mail< / a > < / li >
< li > You should be able to set a < code > PTR< / code > record for your host; security-hardened mail servers might otherwise reject your mail server as the IP address of your host does not resolve correctly/at all to the DNS name of your server.< / li >
< / ol >
< p > On the host, you should have a suitable container runtime (like < em > Docker< / em > or < em > Podman< / em > ) installed. We assume < a href = "https://docs.docker.com/compose/" > < em > Docker Compose< / em > < / a > is < a href = "https://docs.docker.com/compose/install/" > installed< / a > .< / p >
< div class = "admonition info" >
< p class = "admonition-title" > Podman Support< / p >
< p > If you're using podman, make sure to read the related < a href = "../config/advanced/podman/" > documentation< / a > .< / p >
< / div >
< h3 id = "minimal-dns-setup" > < a class = "toclink" href = "#minimal-dns-setup" > Minimal DNS Setup< / a > < / h3 >
< p > The DNS setup is a big and essential part of the whole setup. There is a lot of confusion for newcomers and people starting out when setting up DNS. This section provides an example configuration and supplementary explanation. We expect you to be at least a bit familiar with DNS, what it does and what the individual record types are.< / p >
< p > Now let's say you just bought < code > example.com< / code > and you want to be able to send and receive e-mails for the address < code > test@example.com< / code > . On the most basic level, you will need to< / p >
< ol >
< li > set an < code > MX< / code > record for your domain < code > example.com< / code > - in our example, the MX record contains < code > mail.example.com< / code > < / li >
< li > set an < code > A< / code > record that resolves the name of your mail server - in our example, the A record contains < code > 11.22.33.44< / code > < / li >
< li > (in a best-case scenario) set a < code > PTR< / code > record that resolves the IP of your mail server - in our example, the PTR contains < code > mail.example.com< / code > < / li >
< / ol >
< p > We will later dig into DKIM, DMARC & SPF, but for now, these are the records that suffice in getting you up and running. Here is a short explanation of what the records do:< / p >
< ul >
< li > The < strong > MX record< / strong > tells everyone which (DNS) name is responsible for e-mails on your domain.
2023-04-08 21:55:05 +00:00
Because you want to keep the option of running another service on the domain name itself, you run your mail server on < code > mail.example.com< / code > .
This does not imply your e-mails will look like < code > test@mail.example.com< / code > , the DNS name of your mail server is decoupled of the domain it serves e-mails for.
In theory, you mail server could even serve e-mails for < code > test@some-other-domain.com< / code > , if the MX record for < code > some-other-domain.com< / code > points to < code > mail.example.com< / code > .< / li >
2023-04-08 09:54:44 +00:00
< li > The < strong > A record< / strong > tells everyone which IP address the DNS name < code > mail.example.com< / code > resolves to.< / li >
< li > The < strong > PTR record< / strong > is the counterpart of the A record, telling everyone what name the IP address < code > 11.22.33.44< / code > resolves to.< / li >
< / ul >
< p > If you setup everything, it should roughly look like this:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "gp" > $ < / span > dig< span class = "w" > < / span > @1.1.1.1< span class = "w" > < / span > +short< span class = "w" > < / span > MX< span class = "w" > < / span > example.com
< span class = "go" > mail.example.com< / span >
< span class = "gp" > $ < / span > dig< span class = "w" > < / span > @1.1.1.1< span class = "w" > < / span > +short< span class = "w" > < / span > A< span class = "w" > < / span > mail.example.com
< span class = "go" > 11.22.33.44< / span >
< span class = "gp" > $ < / span > dig< span class = "w" > < / span > @1.1.1.1< span class = "w" > < / span > +short< span class = "w" > < / span > -x< span class = "w" > < / span > < span class = "m" > 11< / span > .22.33.44
< span class = "go" > mail.example.com< / span >
< / code > < / pre > < / div >
< h2 id = "deploying-the-actual-image" > < a class = "toclink" href = "#deploying-the-actual-image" > Deploying the Actual Image< / a > < / h2 >
< h3 id = "tagging-convention" > < a class = "toclink" href = "#tagging-convention" > Tagging Convention< / a > < / h3 >
< p > To understand which tags you should use, read this section carefully. < a href = "https://github.com/docker-mailserver/docker-mailserver/actions" > Our CI< / a > will automatically build, test and push new images to the following container registries:< / p >
2023-02-19 12:25:43 +00:00
< ol >
< li > DockerHub (< a href = "https://hub.docker.com/r/mailserver/docker-mailserver" > < code > docker.io/mailserver/docker-mailserver< / code > < / a > )< / li >
< li > GitHub Container Registry (< a href = "https://github.com/docker-mailserver/docker-mailserver/pkgs/container/docker-mailserver" > < code > ghcr.io/docker-mailserver/docker-mailserver< / code > < / a > )< / li >
< / ol >
< p > All workflows are using the tagging convention listed below. It is subsequently applied to all images.< / p >
< table >
< thead >
< tr >
< th > Event< / th >
< th > Image Tags< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < code > push< / code > on < code > master< / code > < / td >
< td > < code > edge< / code > < / td >
< / tr >
< tr >
< td > < code > push< / code > a tag (< code > v1.2.3< / code > )< / td >
< td > < code > 1.2.3< / code > , < code > 1.2< / code > , < code > 1< / code > , < code > latest< / code > < / td >
< / tr >
< / tbody >
< / table >
2023-04-08 09:54:44 +00:00
< h3 id = "get-all-files" > < a class = "toclink" href = "#get-all-files" > Get All Files< / a > < / h3 >
2023-02-19 12:25:43 +00:00
< p > Issue the following commands to acquire the necessary files:< / p >
2023-04-08 09:54:44 +00:00
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "nv" > DMS_GITHUB_URL< / span > < span class = "o" > =< / span > < span class = "s2" > " https://github.com/docker-mailserver/docker-mailserver/blob/latest" < / span >
wget< span class = "w" > < / span > < span class = "s2" > " < / span > < span class = "si" > ${< / span > < span class = "nv" > DMS_GITHUB_URL< / span > < span class = "si" > }< / span > < span class = "s2" > /docker-compose.yml" < / span >
wget< span class = "w" > < / span > < span class = "s2" > " < / span > < span class = "si" > ${< / span > < span class = "nv" > DMS_GITHUB_URL< / span > < span class = "si" > }< / span > < span class = "s2" > /mailserver.env" < / span >
2023-02-19 12:25:43 +00:00
< / code > < / pre > < / div >
2023-04-08 09:54:44 +00:00
< h3 id = "configuration-steps" > < a class = "toclink" href = "#configuration-steps" > Configuration Steps< / a > < / h3 >
2023-02-19 12:25:43 +00:00
< ol >
2023-04-08 09:54:44 +00:00
< li > First edit < code > docker-compose.yml< / code > to your liking< ul >
< li > Substitute < code > mail.example.com< / code > according to your FQDN.< / li >
< li > If you want to use SELinux for the < code > ./docker-data/dms/config/:/tmp/docker-mailserver/< / code > mount, append < code > -z< / code > or < code > -Z< / code > .< / li >
2023-02-19 12:25:43 +00:00
< / ul >
< / li >
2023-04-08 09:54:44 +00:00
< li > Then configure the environment specific to the mail server by editing < a href = "../config/environment/" > < code > mailserver.env< / code > < / a > , but keep in mind that:< ul >
< li > only < a href = "https://docs.docker.com/compose/env-file/" > basic < code > VAR=VAL< / code > < / a > is supported< / li >
< li > do not quote your values< / li >
< li > variable substitution is not supported, e.g. < code > OVERRIDE_HOSTNAME=$HOSTNAME.$DOMAINNAME< / code > does not work< / li >
2023-02-19 12:25:43 +00:00
< / ul >
< / li >
< / ol >
2023-04-08 09:54:44 +00:00
< h3 id = "get-up-and-running" > < a class = "toclink" href = "#get-up-and-running" > Get Up and Running< / a > < / h3 >
2023-02-19 12:25:43 +00:00
< div class = "admonition danger" >
< p class = "admonition-title" > Using the Correct Commands For Stopping and Starting DMS< / p >
< p > < strong > Use < code > docker compose up / down< / code > , not < code > docker compose start / stop< / code > < / strong > . Otherwise, the container is not properly destroyed and you may experience problems during startup because of inconsistent state.< / p >
2023-03-01 15:34:25 +00:00
< p > Using < code > Ctrl+C< / code > < strong > is not supported either< / strong > !< / p >
2023-02-19 12:25:43 +00:00
< / div >
2023-04-08 09:54:44 +00:00
< p > For an overview of commands to manage DMS config, run: < code > docker exec -it < CONTAINER NAME> setup help< / code > .< / p >
2023-02-19 12:25:43 +00:00
< details class = "info" >
< summary > Usage of < code > setup.sh< / code > when no DMS Container Is Running< / summary >
2023-04-08 09:54:44 +00:00
< p > We encourage you to directly use < code > setup< / code > inside the container (like shown above). If you still want to use < code > setup.sh< / code > , here's some information about it.< / p >
2023-02-19 12:25:43 +00:00
< p > If no DMS container is running, any < code > ./setup.sh< / code > command will check online for the < code > :latest< / code > image tag (the current < em > stable< / em > release), performing a < code > docker pull ...< / code > if necessary followed by running the command in a temporary container:< / p >
2023-04-08 09:54:44 +00:00
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "gp" > $ < / span > ./setup.sh< span class = "w" > < / span > < span class = "nb" > help< / span >
2023-04-10 09:37:49 +00:00
< span class = "go" > Image ' ghcr.io/docker-mailserver/docker-mailserver:latest' not found. Pulling ...< / span >
2023-02-19 12:25:43 +00:00
< span class = "go" > SETUP(1)< / span >
< span class = "go" > NAME< / span >
< span class = "go" > setup - ' docker-mailserver' Administration & Configuration script< / span >
< span class = "go" > ...< / span >
2023-04-08 09:54:44 +00:00
< span class = "gp" > $ < / span > docker< span class = "w" > < / span > run< span class = "w" > < / span > --rm< span class = "w" > < / span > ghcr.io/docker-mailserver/docker-mailserver:latest< span class = "w" > < / span > setup< span class = "w" > < / span > < span class = "nb" > help< / span >
2023-02-19 12:25:43 +00:00
< span class = "go" > SETUP(1)< / span >
< span class = "go" > NAME< / span >
< span class = "go" > setup - ' docker-mailserver' Administration & Configuration script< / span >
< span class = "go" > ...< / span >
< / code > < / pre > < / div >
< / details >
2023-04-08 09:54:44 +00:00
< p > On first start, you will need to add at least one email account (unless you're using LDAP). You have two minutes to do so, otherwise DMS will shutdown and restart. You can add accounts by running < code > docker exec -ti < CONTAINER NAME> setup email add user@example.com< / code > . < strong > That's it! It really is that easy< / strong > .< / p >
2023-02-19 12:25:43 +00:00
< h2 id = "further-miscellaneous-steps" > < a class = "toclink" href = "#further-miscellaneous-steps" > Further Miscellaneous Steps< / a > < / h2 >
2023-04-08 21:55:05 +00:00
< h3 id = "setting-up-tls" > < a class = "toclink" href = "#setting-up-tls" > Setting up TLS< / a > < / h3 >
< p > You definitely want to setup TLS. Please refer to < a href = "../config/security/ssl/" > our documentation about TLS< / a > .< / p >
2023-04-08 09:54:44 +00:00
< h3 id = "aliases" > < a class = "toclink" href = "#aliases" > Aliases< / a > < / h3 >
2023-04-09 09:27:22 +00:00
< p > You should add at least one < a href = "../config/user-management/#aliases" > alias< / a > , the < a href = "../config/environment/#postmaster_address" > < em > postmaster alias< / em > < / a > . This is a common convention, but not strictly required.< / p >
2023-04-08 09:54:44 +00:00
< div class = "highlight" > < pre > < span > < / span > < code > docker< span class = "w" > < / span > < span class = "nb" > exec< / span > < span class = "w" > < / span > -ti< span class = "w" > < / span > < CONTAINER< span class = "w" > < / span > NAME> < span class = "w" > < / span > setup< span class = "w" > < / span > < span class = "nb" > alias< / span > < span class = "w" > < / span > add< span class = "w" > < / span > postmaster@example.com< span class = "w" > < / span > user@example.com
2023-02-19 12:25:43 +00:00
< / code > < / pre > < / div >
2023-04-08 09:54:44 +00:00
< h3 id = "dkim-keys" > < a class = "toclink" href = "#dkim-keys" > DKIM Keys< / a > < / h3 >
< p > You can (< em > and you should< / em > ) generate DKIM keys. For more information:< / p >
< ul >
< li > DKIM < a href = "../config/best-practices/dkim/#enabling-dkim-signature" > with OpenDKIM< / a > (< em > enabled by default< / em > )< / li >
< li > DKIM < a href = "../config/security/rspamd/#dkim-signing" > with Rspamd< / a > (< em > when using < code > ENABLE_RSPAMD=1< / code > < / em > )< / li >
< / ul >
< p > When keys are generated, you can configure your DNS server by just pasting the content of < code > config/opendkim/keys/domain.tld/mail.txt< / code > to < a href = "https://mxtoolbox.com/dmarc/dkim/setup/how-to-setup-dkim" > set up DKIM< / a > . See the < a href = "../config/best-practices/dkim/#configuration-using-a-web-interface" > documentation< / a > for more details.< / p >
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
2023-02-19 12:25:43 +00:00
< p > In case you're using LDAP, the setup looks a bit different as you do not add user accounts directly. Postfix doesn't know your domain(s) and you need to provide it when configuring DKIM:< / p >
2023-04-08 09:54:44 +00:00
< div class = "highlight" > < pre > < span > < / span > < code > docker< span class = "w" > < / span > < span class = "nb" > exec< / span > < span class = "w" > < / span > -ti< span class = "w" > < / span > < CONTAINER< span class = "w" > < / span > NAME> < span class = "w" > < / span > setup< span class = "w" > < / span > config< span class = "w" > < / span > dkim< span class = "w" > < / span > domain< span class = "w" > < / span > < span class = "s1" > ' < domain.tld> [,< domain2.tld> ]' < / span >
< / code > < / pre > < / div >
< / div >
< h3 id = "advanced-dns-setup" > < a class = "toclink" href = "#advanced-dns-setup" > Advanced DNS Setup< / a > < / h3 >
< p > You will very likely want to configure your DNS with these TXT records: < a href = "https://www.cloudflare.com/learning/email-security/dmarc-dkim-spf/" > SPF, DKIM, and DMARC< / a > .< / p >
< p > The following illustrates what a (rather strict) set of records could look like:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "gp" > $ < / span > dig< span class = "w" > < / span > @1.1.1.1< span class = "w" > < / span > +short< span class = "w" > < / span > TXT< span class = "w" > < / span > example.com
< span class = "go" > " v=spf1 mx -all" < / span >
< span class = "gp" > $ < / span > dig< span class = "w" > < / span > @1.1.1.1< span class = "w" > < / span > +short< span class = "w" > < / span > TXT< span class = "w" > < / span > dkim-rsa._domainkey.example.com
< span class = "go" > " v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQ..." < / span >
< span class = "gp" > $ < / span > dig< span class = "w" > < / span > @1.1.1.1< span class = "w" > < / span > +short< span class = "w" > < / span > TXT< span class = "w" > < / span > _dmarc.example.com
< span class = "go" > " v=DMARC1; p=reject; sp=reject; pct=100; adkim=s; aspf=s; fo=1" < / span >
2023-02-19 12:25:43 +00:00
< / code > < / pre > < / div >
< h3 id = "custom-user-changes-patches" > < a class = "toclink" href = "#custom-user-changes-patches" > Custom User Changes & Patches< / a > < / h3 >
2023-04-08 09:54:44 +00:00
< p > If you'd like to change, patch or alter files or behavior of < code > docker-mailserver< / code > , you can use a script. See < a href = "../faq/#how-to-adjust-settings-with-the-user-patchessh-script" > this part of our documentation< / a > for a detailed explanation.< / p >
< h2 id = "testing" > < a class = "toclink" href = "#testing" > Testing< / a > < / h2 >
< p > Here are some tools you can use to verify your configuration:< / p >
< ol >
< li > < a href = "https://mxtoolbox.com/SuperTool.aspx" > MX Toolbox< / a > < / li >
< li > < a href = "https://www.mimecast.com/products/dmarc-analyzer/spf-record-check/" > DMARC Analyzer< / a > < / li >
< li > < a href = "https://www.mail-tester.com/" > mail-tester.com< / a > < / li >
< li > < a href = "https://multirbl.valli.org/" > multiRBL.valli.org< / a > < / li >
< / ol >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< / article >
< / div >
2023-02-19 12:25:43 +00:00
< / div >
2023-04-08 09:54:44 +00:00
< button type = "button" class = "md-top md-icon" data-md-component = "top" hidden >
2023-02-19 12:25:43 +00:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z" / > < / svg >
Back to top
2023-04-08 09:54:44 +00:00
< / button >
2023-02-19 12:25:43 +00:00
< / 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" >
< p > & copy < a href = "https://github.com/docker-mailserver" > < em > Docker Mailserver Organization< / em > < / a > < br / > < span > This project is licensed under the MIT license.< / span > < / p >
< / 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 >
2023-04-08 09:54:44 +00:00
< script id = "__config" type = "application/json" > { "base" : ".." , "features" : [ "navigation.tabs" , "navigation.top" , "navigation.expand" , "navigation.instant" , "content.code.annotate" ] , "search" : "../assets/javascripts/workers/search.208ed371.min.js" , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version" : "Select version" } , "version" : { "provider" : "mike" } } < / script >
2023-02-19 12:25:43 +00:00
2023-04-08 09:54:44 +00:00
< script src = "../assets/javascripts/bundle.407015b8.min.js" > < / script >
2023-02-19 12:25:43 +00:00
< / body >
< / html >
