bokysan/docker-postfix
1
1
Fork 0
mirror of https://github.com/bokysan/docker-postfix.git synced 2024-11-10 08:55:39 +08:00
Code Issues Projects Releases Packages Wiki Activity
docker-postfix/Dockerfile

73 lines
3.3 KiB
Text
Raw Normal View History

Fix for #172: Change order of parameters for netcat
2024-01-07 23:51:33 +08:00
# syntax=docker/dockerfile:1.6
Upd: Refactor Dockerfile and cache local builds This refactor simplifies the `Dockerfile` by considerable amount: new features of mobykit buildkit allow us to cache `apt`/`apk` folder (so no need to delete `/var/lib/cache`) as well as extract the build / install logic into separate files, which removes the need for `&& \` and makes the code *much more* readable. `build.sh` script has been updated as well to allow caching local builds when testing, making it much more easier to test.
2022-04-13 15:57:46 +08:00
Upd: Update documentation - fix typos, make it more explicit we use Debian as default
2024-02-25 16:24:13 +08:00
# Note:
# The BASE_IMAGE can be changed for this docker image. In fact, it will be. Check .github/workflows/master.yml.
# This image is automatically built with Debian, Ubuntu and Alpine as underlying systems. Each of these has its
# own advantages and shortcomings. In essence:
#
# - use Alpine if you're strapped for space. But beware it uses MUSL LIBC, so unicode support might be an issue.
# - use Debian if you're interested in the greatest cross-platform compatibility. It is larger than Alpine, though.
# - use Ubuntu if, well, Ubuntu is your thing and you're used to Ubuntu ecosystem.
Use Debian Slim as base image
2023-10-28 00:53:48 +08:00
ARG BASE_IMAGE=debian:bookworm-slim
Add XOAuth2 support for GMail (#42) * Add XOAuth2 support for GMail * Attempt to support integration tests
2020-11-06 17:52:17 +08:00
Upd: Refactor Dockerfile and cache local builds This refactor simplifies the `Dockerfile` by considerable amount: new features of mobykit buildkit allow us to cache `apt`/`apk` folder (so no need to delete `/var/lib/cache`) as well as extract the build / install logic into separate files, which removes the need for `&& \` and makes the code *much more* readable. `build.sh` script has been updated as well to allow caching local builds when testing, making it much more easier to test.
2022-04-13 15:57:46 +08:00
FROM ${BASE_IMAGE} AS build-scripts
COPY ./build-scripts ./build-scripts
Postfix, initial release
2016-03-18 07:06:12 +08:00
Move build of sasl-xoauth2 to the main file Some users have reported issues with GCE and how sasl-xoauth2 was built. Moving the building process back into the main part of the `Dockerfile` should hopefully prevent similar issues.
2021-09-06 17:25:10 +08:00
# ============================ INSTALL BASIC SERVICES ============================
Upd: Fix integration tests with the latest refactor
2022-04-13 16:16:42 +08:00
FROM ${BASE_IMAGE} AS base
Fix: Fix multiplatform build caching issues So, alpine will download platform-specific cache files, meaning that when another platform tries to use the cache, it will fail with packages not being found.
2022-06-09 21:32:07 +08:00
ARG TARGETPLATFORM
Move build of sasl-xoauth2 to the main file Some users have reported issues with GCE and how sasl-xoauth2 was built. Moving the building process back into the main part of the `Dockerfile` should hopefully prevent similar issues.
2021-09-06 17:25:10 +08:00
Major update, better support for handling TLS connections. This update includes a few features that make it easier to work with relay hosts. The configuration now uses built-in (Alpine) TLS certificates and allows the user to specify how the Postfix should establish a TLS connection. Configure it using `RELAYHOST_TLS_LEVEL`, if needed. Another configuration option was added, `MESSAGE_SIZE_LIMIT`, which enables you to reject messages exceeding certain limits. Especially useful with relay servers, to prevent messages getting stuck in Postfix queue. Use the `INBOUND_DEBUGGING` parameter to enable additional postfix logs for incoming messages when things go south. Use `TZ` parameter to set the timezone of the container (especially useful for logs and dates in the messages). *Notice that `ALLOWED_SENDER_DOMAINS` is now a neccessary parameter.* Turns out that due to Postfix anti-spam configuration there's no way to start it properly without specifying the domains it will relay email for. This commit also includes a few samples of running the container: - standalone - in [docker-compose](https://docs.docker.com/compose/) Further work: add a working Kubernetes / Helm chart example.
2019-01-02 17:10:17 +08:00
# Install supervisor, postfix
More resillient builds It turns out that builds cannot be predictable - different accounts were assigned by different build systems. Consequentially we install each tool separately.
2019-02-19 19:08:13 +08:00
# Install postfix first to get the first account (101)
# Install opendkim second to get the second account (102)
Fix: Fix multiplatform build caching issues So, alpine will download platform-specific cache files, meaning that when another platform tries to use the cache, it will fail with packages not being found.
2022-06-09 21:32:07 +08:00
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked,id=var-cache-apt-$TARGETPLATFORM \
--mount=type=cache,target=/var/lib/apt,sharing=locked,id=var-lib-apt-$TARGETPLATFORM \
Fix: Fix build issue with Alpine and Caching
2022-06-16 18:36:30 +08:00
--mount=type=tmpfs,target=/var/cache/apk \
Upd: Refactor Dockerfile and cache local builds This refactor simplifies the `Dockerfile` by considerable amount: new features of mobykit buildkit allow us to cache `apt`/`apk` folder (so no need to delete `/var/lib/cache`) as well as extract the build / install logic into separate files, which removes the need for `&& \` and makes the code *much more* readable. `build.sh` script has been updated as well to allow caching local builds when testing, making it much more easier to test.
2022-04-13 15:57:46 +08:00
--mount=type=tmpfs,target=/tmp \
--mount=type=bind,from=build-scripts,source=/build-scripts,target=/build-scripts \
sh /build-scripts/postfix-install.sh
Move build of sasl-xoauth2 to the main file Some users have reported issues with GCE and how sasl-xoauth2 was built. Moving the building process back into the main part of the `Dockerfile` should hopefully prevent similar issues.
2021-09-06 17:25:10 +08:00
# ============================ BUILD SASL XOAUTH2 ============================
Upd: Fix integration tests with the latest refactor
2022-04-13 16:16:42 +08:00
FROM base AS sasl
Move build of sasl-xoauth2 to the main file Some users have reported issues with GCE and how sasl-xoauth2 was built. Moving the building process back into the main part of the `Dockerfile` should hopefully prevent similar issues.
2021-09-06 17:25:10 +08:00
Fix: Fix multiplatform build caching issues So, alpine will download platform-specific cache files, meaning that when another platform tries to use the cache, it will fail with packages not being found.
2022-06-09 21:32:07 +08:00
ARG TARGETPLATFORM
Move build of sasl-xoauth2 to the main file Some users have reported issues with GCE and how sasl-xoauth2 was built. Moving the building process back into the main part of the `Dockerfile` should hopefully prevent similar issues.
2021-09-06 17:25:10 +08:00
ARG SASL_XOAUTH2_REPO_URL=https://github.com/tarickb/sasl-xoauth2.git
Upd: Update SASL XOAuth2 to v0.24
2023-10-27 15:50:39 +08:00
ARG SASL_XOAUTH2_GIT_REF=release-0.24
Upd: Refactor Dockerfile and cache local builds This refactor simplifies the `Dockerfile` by considerable amount: new features of mobykit buildkit allow us to cache `apt`/`apk` folder (so no need to delete `/var/lib/cache`) as well as extract the build / install logic into separate files, which removes the need for `&& \` and makes the code *much more* readable. `build.sh` script has been updated as well to allow caching local builds when testing, making it much more easier to test.
2022-04-13 15:57:46 +08:00
Fix: Fix build issue with Alpine and Caching
2022-06-16 18:36:30 +08:00
# --mount=type=cache,target=/var/cache/apk,sharing=locked,id=var-cache-apk-$TARGETPLATFORM \
# --mount=type=cache,target=/etc/apk/cache,sharing=locked,id=etc-apk-cache-$TARGETPLATFORM \
Fix: Fix multiplatform build caching issues So, alpine will download platform-specific cache files, meaning that when another platform tries to use the cache, it will fail with packages not being found.
2022-06-09 21:32:07 +08:00
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked,id=var-cache-apt-$TARGETPLATFORM \
--mount=type=cache,target=/var/lib/apt,sharing=locked,id=var-lib-apt-$TARGETPLATFORM \
Fix Ubuntu build and upgrade to latest Ubuntu LTS release
2023-02-09 16:22:59 +08:00
--mount=type=tmpfs,target=/etc/apk/cache \
Fix: Fix build issue with Alpine and Caching
2022-06-16 18:36:30 +08:00
--mount=type=tmpfs,target=/var/cache/apk \
Upd: Refactor Dockerfile and cache local builds This refactor simplifies the `Dockerfile` by considerable amount: new features of mobykit buildkit allow us to cache `apt`/`apk` folder (so no need to delete `/var/lib/cache`) as well as extract the build / install logic into separate files, which removes the need for `&& \` and makes the code *much more* readable. `build.sh` script has been updated as well to allow caching local builds when testing, making it much more easier to test.
2022-04-13 15:57:46 +08:00
--mount=type=tmpfs,target=/tmp \
--mount=type=tmpfs,target=/sasl-xoauth2 \
--mount=type=bind,from=build-scripts,source=/build-scripts,target=/build-scripts \
sh /build-scripts/sasl-build.sh
Upd: Fix integration tests with the latest refactor
2022-04-13 16:16:42 +08:00
# ============================ Prepare main image ============================
Upd: Refactor Dockerfile and cache local builds This refactor simplifies the `Dockerfile` by considerable amount: new features of mobykit buildkit allow us to cache `apt`/`apk` folder (so no need to delete `/var/lib/cache`) as well as extract the build / install logic into separate files, which removes the need for `&& \` and makes the code *much more* readable. `build.sh` script has been updated as well to allow caching local builds when testing, making it much more easier to test.
2022-04-13 15:57:46 +08:00
FROM sasl
LABEL maintainer="Bojan Cekrlic - https://github.com/bokysan/docker-postfix/"
Add XOAuth2 support for GMail (#42) * Add XOAuth2 support for GMail * Attempt to support integration tests
2020-11-06 17:52:17 +08:00
Minor edits for easier understanding. The Dockerfile has been reformatted a bit to make it more clear and easy to understand. README.md has been updated with the postfix's user account details.
2018-07-27 22:42:35 +08:00
# Set up configuration
Larger refactoring of the codebase + DKIM_SELECTOR Summary ^^^^^^^ This commit refactors the code base to be more manageble and prepares the groundwork for tests. Refactoring ^^^^^^^^^^^ Files are now moved to subdirectories, all for the sole purpose of easier management. Tests live in their own folders, as well as configs and other files. Test framework ^^^^^^^^^^^^^^ Two new important scripts/directories are available: - `unit-tests.sh` / `/unit-test` which executes unit tests across shell scripts, and - `integration-test.sh` / `integration-tests`, which spins up the container and tries to send the email. Both tests use the [BATS](https://github.com/sstephenson/bats) framework for testing. To create a new test, simply drop a `.bats` file into a corresponding directory. Functions have been extracted into `common-run.sh`, to be able to test them independently. DKIM_SELECTOR ^^^^^^^^^^^^^ It is now possible to specify a DKIM selector to use (instead of the default "mail"). See `README.md` for more details. JSON logging ^^^^^^^^^^^^ WIP: rsyslog will now output JSON logs. This is especially important if you plan on deploying the image into Kubernetes, as [Prometheus](https://prometheus.io/) can handle logs in JSON much easier. TODO: Make this an optional feature, to not confuse existing users.
2020-06-30 00:49:52 +08:00
COPY /configs/supervisord.conf /etc/supervisord.conf
Add the option to log to rsyslog as plain or JSON and restructure tests - It's now possible to choose the logging type - either 'plain' or 'json' - The code is ready to support multiple integration tests (with different configurations) - `OPENDKIM_` and `POSTFIX_` variables are handled properly and recorded in the corresponding files. (This had a downfall that `bash` now needs to be installed, so we can probably simplify some of the shell scripts.)
2020-07-01 19:50:08 +08:00
COPY /configs/rsyslog*.conf /etc/
Larger refactoring of the codebase + DKIM_SELECTOR Summary ^^^^^^^ This commit refactors the code base to be more manageble and prepares the groundwork for tests. Refactoring ^^^^^^^^^^^ Files are now moved to subdirectories, all for the sole purpose of easier management. Tests live in their own folders, as well as configs and other files. Test framework ^^^^^^^^^^^^^^ Two new important scripts/directories are available: - `unit-tests.sh` / `/unit-test` which executes unit tests across shell scripts, and - `integration-test.sh` / `integration-tests`, which spins up the container and tries to send the email. Both tests use the [BATS](https://github.com/sstephenson/bats) framework for testing. To create a new test, simply drop a `.bats` file into a corresponding directory. Functions have been extracted into `common-run.sh`, to be able to test them independently. DKIM_SELECTOR ^^^^^^^^^^^^^ It is now possible to specify a DKIM selector to use (instead of the default "mail"). See `README.md` for more details. JSON logging ^^^^^^^^^^^^ WIP: rsyslog will now output JSON logs. This is especially important if you plan on deploying the image into Kubernetes, as [Prometheus](https://prometheus.io/) can handle logs in JSON much easier. TODO: Make this an optional feature, to not confuse existing users.
2020-06-30 00:49:52 +08:00
COPY /configs/opendkim.conf /etc/opendkim/opendkim.conf
COPY /configs/smtp_header_checks /etc/postfix/smtp_header_checks
Fix network error: disable postfix chroot
2022-08-29 21:44:43 +08:00
COPY /configs/master.cf /etc/postfix/master.cf
Add email anonymizer option in case is needed for GDPR This new feature will anonymize emails in the Postfix logs. This allows you to keep them indefinetely while being compliant with GDPR. Based on excellent work on [this pull request](https://github.com/bokysan/docker-postfix/pull/91). Check `README.md` for more details.
2021-11-10 21:12:14 +08:00
COPY /scripts/* /scripts/
Larger refactoring of the codebase + DKIM_SELECTOR Summary ^^^^^^^ This commit refactors the code base to be more manageble and prepares the groundwork for tests. Refactoring ^^^^^^^^^^^ Files are now moved to subdirectories, all for the sole purpose of easier management. Tests live in their own folders, as well as configs and other files. Test framework ^^^^^^^^^^^^^^ Two new important scripts/directories are available: - `unit-tests.sh` / `/unit-test` which executes unit tests across shell scripts, and - `integration-test.sh` / `integration-tests`, which spins up the container and tries to send the email. Both tests use the [BATS](https://github.com/sstephenson/bats) framework for testing. To create a new test, simply drop a `.bats` file into a corresponding directory. Functions have been extracted into `common-run.sh`, to be able to test them independently. DKIM_SELECTOR ^^^^^^^^^^^^^ It is now possible to specify a DKIM selector to use (instead of the default "mail"). See `README.md` for more details. JSON logging ^^^^^^^^^^^^ WIP: rsyslog will now output JSON logs. This is especially important if you plan on deploying the image into Kubernetes, as [Prometheus](https://prometheus.io/) can handle logs in JSON much easier. TODO: Make this an optional feature, to not confuse existing users.
2020-06-30 00:49:52 +08:00
Add email anonymizer option in case is needed for GDPR This new feature will anonymize emails in the Postfix logs. This allows you to keep them indefinetely while being compliant with GDPR. Based on excellent work on [this pull request](https://github.com/bokysan/docker-postfix/pull/91). Check `README.md` for more details.
2021-11-10 21:12:14 +08:00
RUN chmod +x /scripts/*
Postfix, initial release
2016-03-18 07:06:12 +08:00
Initial support for DKIM and testing This commit brings two important features: - **DKIM support** It's now possible to configure this postfix image to sign messages using DKIM by simply generating the keys and providing them in the approprate folder. This should bring us one step closer to directly sending out emails without relying on a 3rd-party proxy. - **test support** A nice and handy script, conviniently called `test.sh` has been provided, builds the image, spins it up and tries to send out an email. You'll need `docker-compose` to run it, though.
2019-02-19 17:49:55 +08:00
# Set up volumes
VOLUME [ "/var/spool/postfix", "/etc/postfix", "/etc/opendkim/keys" ]
Postfix, initial release
2016-03-18 07:06:12 +08:00
Minor edits for easier understanding. The Dockerfile has been reformatted a bit to make it more clear and easy to understand. README.md has been updated with the postfix's user account details.
2018-07-27 22:42:35 +08:00
# Run supervisord
USER root
WORKDIR /tmp
Fix for #174: Try to refactor healthcheck
2024-01-09 17:59:04 +08:00
HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --start-interval=2s --retries=3 CMD /scripts/healthcheck.sh
Fix for #40: Add healthcheck to Dockerfile `HEALTHCHECK` instruction has been added to `Dockerfile`. This should allow `docker-compose` installations to monitor and restart the container if neccessary. Kubernetes deployment healthcheck has been tweaked a bit to better validate that the server is actually running.
2020-11-03 18:51:51 +08:00
Minor edits for easier understanding. The Dockerfile has been reformatted a bit to make it more clear and easy to understand. README.md has been updated with the postfix's user account details.
2018-07-27 22:42:35 +08:00
EXPOSE 587
Add email anonymizer option in case is needed for GDPR This new feature will anonymize emails in the Postfix logs. This allows you to keep them indefinetely while being compliant with GDPR. Based on excellent work on [this pull request](https://github.com/bokysan/docker-postfix/pull/91). Check `README.md` for more details.
2021-11-10 21:12:14 +08:00
CMD [ "/bin/sh", "-c", "/scripts/run.sh" ]
Reference in a new issue Copy permalink