Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme: Added maintenance message ... #10

Merged
merged 1 commit into from
Jun 8, 2020
Merged

Update readme: Added maintenance message ... #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 73 additions & 71 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
:warning:
## mailserver2/mailserver

# This docker image is no longer maintained
### Fork

:warning:

## Fork

This is a fork of [hardware/mailserver](https://github.com/hardware/mailserver).
This is a fork that provides the bare minimum of maintenance for the excellent [hardware/mailserver](https://github.com/hardware/mailserver).
Thank you very much.

## hardware/mailserver

### Chat & questions

[![](https://badges.gitter.im/hardware-mailserver/Lobby.svg)](https://gitter.im/hardware-mailserver/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![](https://img.shields.io/badge/chat-discord-9cf)](https://discord.gg/nb8tRGs)
[![](https://img.shields.io/badge/chat-%23mailserver%3Amatrix.org-blue)](https://matrix.to/#/!DbFxWyybGbPHdBNVkM:matrix.org?via=matrix.org)

### Build

Expand All @@ -23,7 +19,7 @@ Thank you very much.

[![](https://images.microbadger.com/badges/image/mailserver2/mailserver:latest.svg)](https://microbadger.com/images/mailserver2/mailserver:latest) [![](https://img.shields.io/docker/automated/mailserver2/mailserver.svg)](https://hub.docker.com/r/mailserver2/mailserver/builds/) [![](https://img.shields.io/docker/pulls/mailserver2/mailserver.svg)](https://hub.docker.com/r/mailserver2/mailserver/) [![](https://img.shields.io/docker/stars/mailserver2/mailserver.svg)](https://hub.docker.com/r/mailserver2/mailserver/) [![](https://img.shields.io/badge/bitcoin-donate-green.svg)](https://keybase.io/hardware)

**hardware/mailserver** is a simple and full-featured mail server build as a set of multiple docker images, including:
**mailserver2/mailserver** is a simple and full-featured mail server build as a set of multiple docker images, including:

- **Postfix**: a full-set SMTP email server
- **Dovecot**: secure IMAP and POP3 email server
Expand All @@ -45,59 +41,59 @@ Thank you very much.

### Summary

- [This docker image is no longer maintained](#this-docker-image-is-no-longer-maintained)
- [mailserver2/mailserver](#mailserver2mailserver)
- [Fork](#fork)
- [hardware/mailserver](#hardwaremailserver)
- [Chat & questions](#chat--questions)
- [Build](#build)
- [Docker image](#docker-image)
- [Summary](#summary)
- [System Requirements](#system-requirements)
- [With MariaDB/PostgreSQL and Redis on the same host](#with-mariadbpostgresql-and-redis-on-the-same-host)
- [With MariaDB/PostgreSQL and Redis hosted on another server](#with-mariadbpostgresql-and-redis-hosted-on-another-server)
- [Prerequisites](#prerequisites)
- [Cleaning](#cleaning)
- [Ports](#ports)
- [DNS setup](#dns-setup)
- [DNS records and reverse PTR](#dns-records-and-reverse-ptr)
- [Testing](#testing)
- [Installation](#installation)
- [1 - Prepare your environment](#1---prepare-your-environment)
- [2 - Postfixadmin installation](#2---postfixadmin-installation)
- [3 - Rainloop installation (optional)](#3---rainloop-installation-optional)
- [4 - Done, congratulation ! :tada:](#4---done-congratulation--tada)
- [Rancher Catalog](#rancher-catalog)
- [Ansible Playbooks](#ansible-playbooks)
- [Environment variables](#environment-variables)
- [Automatic GPG encryption of all your emails](#automatic-gpg-encryption-of-all-your-emails)
- [How does it work ?](#how-does-it-work)
- [Enable automatic GPG encryption](#enable-automatic-gpg-encryption)
- [Import your public key](#import-your-public-key)
- [Import all recipients public keys](#import-all-recipients-public-keys)
- [Specify another GPG keyserver](#specify-another-gpg-keyserver)
- [Run other GPG options](#run-other-gpg-options)
- [Relaying from other networks](#relaying-from-other-networks)
- [SSL certificates](#ssl-certificates)
- [Let's Encrypt certificates generated by Traefik](#lets-encrypt-certificates-generated-by-traefik)
- [Custom certificates](#custom-certificates)
- [Testing](#testing-1)
- [MTA-STS](#mta-sts)
- [Third-party Clamav signature databases](#third-party-clamav-signature-databases)
- [Required Ports](#required-ports)
- [Enable clamav-unofficial-sigs](#enable-clamav-unofficial-sigs)
- [Unbound DNS resolver](#unbound-dns-resolver)
- [PostgreSQL support](#postgresql-support)
- [LDAP support](#ldap-support)
- [IPv6 support](#ipv6-support)
- [Persistent files and folders in /mnt/docker/mail Docker volume](#persistent-files-and-folders-in-mntdockermail-docker-volume)
- [Override postfix configuration](#override-postfix-configuration)
- [Custom configuration for Dovecot](#custom-configuration-for-dovecot)
- [Postfix blacklist](#postfix-blacklist)
- [Email client settings](#email-client-settings)
- [Components](#components)
- [Migration from 1.0 to 1.1](#migration-from-10-to-11)
- [Community projects](#community-projects)
- [Some useful Thunderbird extensions](#some-useful-thunderbird-extensions)
- [Chat & questions](#chat--questions)
- [Build](#build)
- [Docker image](#docker-image)
- [Summary](#summary)
- [System Requirements](#system-requirements)
- [With MariaDB/PostgreSQL and Redis on the same host](#with-mariadbpostgresql-and-redis-on-the-same-host)
- [With MariaDB/PostgreSQL and Redis hosted on another server](#with-mariadbpostgresql-and-redis-hosted-on-another-server)
- [Prerequisites](#prerequisites)
- [Cleaning](#cleaning)
- [Ports](#ports)
- [DNS setup](#dns-setup)
- [DNS records and reverse PTR](#dns-records-and-reverse-ptr)
- [Testing](#testing)
- [Installation](#installation)
- [1 - Prepare your environment](#1---prepare-your-environment)
- [2 - Postfixadmin installation](#2---postfixadmin-installation)
- [3 - Rainloop installation (optional)](#3---rainloop-installation-optional)
- [4 - Done, congratulation ! :tada:](#4---done-congratulation--tada)
- [Rancher Catalog](#rancher-catalog)
- [Ansible Playbooks](#ansible-playbooks)
- [Environment variables](#environment-variables)
- [Automatic GPG encryption of all your emails](#automatic-gpg-encryption-of-all-your-emails)
- [How does it work ?](#how-does-it-work-)
- [Enable automatic GPG encryption](#enable-automatic-gpg-encryption)
- [Import your public key](#import-your-public-key)
- [Import all recipients public keys](#import-all-recipients-public-keys)
- [Specify another GPG keyserver](#specify-another-gpg-keyserver)
- [Run other GPG options](#run-other-gpg-options)
- [Relaying from other networks](#relaying-from-other-networks)
- [SSL certificates](#ssl-certificates)
- [Let's Encrypt certificates generated by Traefik](#lets-encrypt-certificates-generated-by-traefik)
- [Custom certificates](#custom-certificates)
- [Testing](#testing-1)
- [MTA-STS](#mta-sts)
- [Third-party Clamav signature databases](#third-party-clamav-signature-databases)
- [Required Ports](#required-ports)
- [Enable clamav-unofficial-sigs](#enable-clamav-unofficial-sigs)
- [Unbound DNS resolver](#unbound-dns-resolver)
- [PostgreSQL support](#postgresql-support)
- [LDAP support](#ldap-support)
- [IPv6 support](#ipv6-support)
- [Persistent files and folders in /mnt/docker/mail Docker volume](#persistent-files-and-folders-in-mntdockermail-docker-volume)
- [Override postfix configuration](#override-postfix-configuration)
- [Custom configuration for Dovecot](#custom-configuration-for-dovecot)
- [Postfix blacklist](#postfix-blacklist)
- [Email client settings](#email-client-settings)
- [Components](#components)
- [Migration from 1.0 to 1.1](#migration-from-10-to-11)
- [Migration from hardware/mailserver to mailserver2/mailserver](#migration-from-hardwaremailserver-to-mailserver2mailserver)
- [Community projects](#community-projects)
- [Some useful Thunderbird extensions](#some-useful-thunderbird-extensions)

### System Requirements

Expand Down Expand Up @@ -219,9 +215,9 @@ docker network create http_network

# Create the required folders and files
mkdir -p /mnt/docker/traefik/acme && cd /mnt/docker \
&& curl https://raw.githubusercontent.com/hardware/mailserver/master/docker-compose.sample.yml -o docker-compose.yml \
&& curl https://raw.githubusercontent.com/hardware/mailserver/master/sample.env -o .env \
&& curl https://raw.githubusercontent.com/hardware/mailserver/master/traefik.sample.toml -o traefik/traefik.toml \
&& curl https://raw.githubusercontent.com/mailserver2/mailserver/master/docker-compose.sample.yml -o docker-compose.yml \
&& curl https://raw.githubusercontent.com/mailserver2/mailserver/master/sample.env -o .env \
&& curl https://raw.githubusercontent.com/mailserver2/mailserver/master/traefik.sample.toml -o traefik/traefik.toml \
&& touch traefik/acme/acme.json \
&& chmod 600 docker-compose.yml .env traefik/traefik.toml traefik/acme/acme.json
```
Expand All @@ -237,18 +233,18 @@ docker-compose up -d
PostfixAdmin is a web based interface used to manage mailboxes, virtual domains and aliases.

* Docker image: https://github.com/hardware/postfixadmin
* How to setup: [Postfixadmin initial configuration](https://github.com/hardware/mailserver/wiki/Postfixadmin-initial-configuration)
* How to setup: [Postfixadmin initial configuration](https://github.com/mailserver2/mailserver/wiki/Postfixadmin-initial-configuration)

#### 3 - Rainloop installation (optional)

Rainloop is a simple, modern and fast web mail front end with Sieve scripts support (filters and vacation message), GPG and a modern user interface.

* Docker image: https://github.com/hardware/rainloop
* How to setup: [Rainloop initial configuration](https://github.com/hardware/mailserver/wiki/Rainloop-initial-configuration)
* How to setup: [Rainloop initial configuration](https://github.com/mailserver2/mailserver/wiki/Rainloop-initial-configuration)

#### 4 - Done, congratulation ! :tada:

At first launch, the container takes few minutes to generate SSL certificates (if needed), DKIM keypair generation and update Clamav database, all of this takes some time (1/2 minutes). This image comes with a snake-oil self-signed certificate, please use your own trusted certificates. [See below](https://github.com/hardware/mailserver#ssl-certificates) for configuration.
At first launch, the container takes few minutes to generate SSL certificates (if needed), DKIM keypair generation and update Clamav database, all of this takes some time (1/2 minutes). This image comes with a snake-oil self-signed certificate, please use your own trusted certificates. [See below](https://github.com/mailserver2/mailserver#ssl-certificates) for configuration.

**List of webservices available:**

Expand Down Expand Up @@ -485,7 +481,7 @@ To use Let's Encrypt certificates generated by Traefik, mount a new docker volum

```yml
mailserver:
image: hardware/mailserver
image: mailserver2/mailserver
volumes:
- /mnt/docker/traefik/acme:/etc/letsencrypt/acme
...
Expand Down Expand Up @@ -572,7 +568,7 @@ You can use Let's Encrypt or any other certification authority. Setup your `dock

```yml
mailserver:
image: hardware/mailserver
image: mailserver2/mailserver
volumes:
- /mnt/docker/ssl:/etc/letsencrypt
...
Expand Down Expand Up @@ -674,7 +670,7 @@ Readme: https://github.com/extremeshok/clamav-unofficial-sigs

#### Enable clamav-unofficial-sigs

Create your `user.conf` file under `/mnt/docker/mail/clamav-unofficial-sigs` directory to configure clamav-unofficial-sigs updater. This file override the default configuration specified in [os.conf](https://github.com/hardware/mailserver/blob/master/rootfs/etc/clamav/unofficial-sigs/os.conf) and [master.conf](https://github.com/hardware/mailserver/blob/master/rootfs/etc/clamav/unofficial-sigs/master.conf). Don't forget, once you have completed the configuration of this file, set the value of `user_configuration_complete` to `yes` otherwise the script will not be able to execute.
Create your `user.conf` file under `/mnt/docker/mail/clamav-unofficial-sigs` directory to configure clamav-unofficial-sigs updater. This file override the default configuration specified in [os.conf](https://github.com/mailserver2/mailserver/blob/master/rootfs/etc/clamav/unofficial-sigs/os.conf) and [master.conf](https://github.com/mailserver2/mailserver/blob/master/rootfs/etc/clamav/unofficial-sigs/master.conf). Don't forget, once you have completed the configuration of this file, set the value of `user_configuration_complete` to `yes` otherwise the script will not be able to execute.
As [Yara rules are broken with Clamav = 0.100](https://github.com/extremeshok/clamav-unofficial-sigs/issues/203), we disable Yara rules for now.

```ini
Expand Down Expand Up @@ -1108,6 +1104,12 @@ Or stay with `1.0-legacy` tag (not recommended).

<p align="right"><a href="#summary">Back to table of contents :arrow_up_small:</a></p>

### Migration from hardware/mailserver to mailserver2/mailserver

Follow the migration steps here:

<https://github.com/mailserver2/mailserver/wiki/Migration-from-hardware-mailserver>

### Community projects

- [ksylvan/docker-mail-server](https://github.com/ksylvan/docker-mail-server): Ansible Playbooks to easily deploy hardware/mailserver.
Expand Down