Merge pull request #568 from drdaeman/proxy-protocol

Proxy protocol support for SMTP and IMAP

Author: foxcpp

.github/workflows/cicd.yml

@@ -24,7 +24,7 @@ jobs:
         restore-keys: ${{ runner.os }}-go-
     - uses: actions/setup-go@v2
       with:
-        go-version: 1.17.11
+        go-version: 1.18.9
     - name: "Verify build.sh"
       run: |
         ./build.sh

.gitignore

@@ -22,10 +22,8 @@ _testmain.go
 
 # Compiled binaries
 cmd/maddy/maddy
-cmd/maddyctl/maddyctl
 cmd/maddy-*-helper/maddy-*-helper
 /maddy
-/maddyctl
 
 # Man pages
 docs/man/*.1

.mkdocs.yml

@@ -60,6 +60,7 @@ nav:
           - reference/table/sql_query.md
           - reference/table/chain.md
           - reference/table/email_localpart.md
+          - reference/table/email_with_domains.md
           - reference/table/auth.md
       - Authentication providers:
           - reference/auth/pass_table.md
@@ -69,6 +70,7 @@ nav:
           - reference/auth/ldap.md
           - reference/auth/dovecot_sasl.md
           - reference/auth/plain_separate.md
+          - reference/auth/netauth.md
       - reference/config-syntax.md
   - Integration with software:
       - third-party/dovecot.md

.version

@@ -1 +1 @@
-0.6.2
+0.7.0

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.17-alpine AS build-env
+FROM golang:1.18-alpine AS build-env
 
 RUN set -ex && \
     apk upgrade --no-cache --available && \
@@ -14,15 +14,15 @@ RUN mkdir -p /pkg/data && \
     cp maddy.conf.docker /pkg/data/maddy.conf && \
     ./build.sh --builddir /tmp --destdir /pkg/ --tags docker build install
 
-FROM alpine:3.16.0
+FROM alpine:3.17.0
 LABEL maintainer="fox.cpp@disroot.org"
 LABEL org.opencontainers.image.source=https://github.com/foxcpp/maddy
 
 RUN set -ex && \
     apk upgrade --no-cache --available && \
     apk --no-cache add ca-certificates
 COPY --from=build-env /pkg/data/maddy.conf /data/maddy.conf
-COPY --from=build-env /pkg/usr/local/bin/maddy /pkg/usr/local/bin/maddyctl /bin/
+COPY --from=build-env /pkg/usr/local/bin/maddy /bin/
 
 EXPOSE 25 143 993 587 465
 VOLUME ["/data"]

contrib/kubernetes/chart/files/maddy.conf

@@ -1,6 +1,6 @@
 ## maddy 0.3 - default configuration file (2020-05-31)
 # Suitable for small-scale deployments. Uses its own format for local users DB,
-# should be managed via maddyctl utility.
+# should be managed via maddy subcommands.
 #
 # See tutorials at https://foxcpp.dev/maddy for guidance on typical
 # configuration changes.
@@ -28,7 +28,7 @@ tls file /etc/maddy/certs/fullchain.pem /etc/maddy/certs/privkey.pem
 # PAM, /etc/shadow file).
 #
 # If table module supports it (sql_table does) - credentials can be managed
-# using 'maddyctl creds' command.
+# using 'maddy creds' command.
 
 auth.pass_table local_authdb {
     table sql_table {
@@ -43,7 +43,7 @@ auth.pass_table local_authdb {
 # also by SMTP & Submission endpoints for delivery of local messages.
 #
 # IMAP accounts, mailboxes and all message metadata can be inspected using
-# imap-* subcommands of maddyctl utility.
+# imap-* subcommands of maddy.
 
 storage.imapsql local_mailboxes {
     driver sqlite3

dist/apparmor/dev.foxcpp.maddyctl

@@ -5,7 +5,7 @@ Official Docker image is available from Docker Hub.
 It expects configuration file to be available at /data/maddy.conf.
 
 If /data is a Docker volume, then default configuration will be placed there
-automatically. If it is used, then MADDY_HOSTNAME, MADDY_DOMAIN environment 
+automatically. If it is used, then MADDY_HOSTNAME, MADDY_DOMAIN environment
 variables control the host name and primary domain for the server. TLS
 certificate should be placed in /data/tls/fullchain.pem, private key in
 /data/tls/privkey.pem
@@ -15,8 +15,8 @@ DKIM keys are generated in /data/dkim_keys directory.
 ## Image tags
 
 - `latest` - A latest stable release. May contain breaking changes.
-- `X.Y` - A specific feature branch, it is recommended to use these tags to 
-  receive bugfixes without the risk of feature-related regressions or breaking 
+- `X.Y` - A specific feature branch, it is recommended to use these tags to
+  receive bugfixes without the risk of feature-related regressions or breaking
   changes.
 - `X.Y.Z` - A specific stable release
 
@@ -30,8 +30,8 @@ All standard ports, as described in maddy docs.
 
 ## Volumes
 
-`/data` - maddy state directory. Databases, queues, etc are stored here. You 
-might want to mount a named volume there. The main configuration file is stored 
+`/data` - maddy state directory. Databases, queues, etc are stored here. You
+might want to mount a named volume there. The main configuration file is stored
 here too (`/data/maddy.conf`).
 
 ## Management utility
@@ -47,7 +47,7 @@ docker run --rm -it -v maddydata:/data foxcpp/maddy:0.6.0 imap-acct create foxcp
 Use the same image version as the running server. Things may break badly
 otherwise.
 
-Note that, if you modify messages using maddyctl while the server is running -
+Note that, if you modify messages using maddy subcommands while the server is running -
 you must ensure that  /tmp from the server is accessible for the management
 command. One way to it is to run it using `docker exec` instead of `docker run`:
 ```
@@ -70,6 +70,6 @@ docker run \
   foxcpp/maddy:0.6
 ```
 
-It will fail on first startup. Copy TLS certificate to /data/tls/fullchain.pem 
-and key to /data/tls/privkey.pem. Run the server again. Finish DNS configuration 
-(DKIM keys, etc) as described in [tutorials/setting-up/](tutorials/setting-up/).
+It will fail on first startup. Copy TLS certificate to /data/tls/fullchain.pem
+and key to /data/tls/privkey.pem. Run the server again. Finish DNS configuration
+(DKIM keys, etc) as described in [tutorials/setting-up/](tutorials/setting-up/).

docs/docker.md

@@ -5,7 +5,7 @@
 Unfortunately, GMail policies are opaque so we cannot tell why this happens.
 
 Verify that you have a rDNS record set for the IP used
-by sender server. Also some IPs may just happen to 
+by sender server. Also some IPs may just happen to
 have bad reputation - check it with various DNSBLs. In this
 case you do not have much of a choice but to replace it.
 
@@ -21,19 +21,19 @@ all outbound messages via a "smart-host".
 
 ## What is resource usage of maddy?
 
-For a small personal server, you do not need much more than a 
+For a small personal server, you do not need much more than a
 single 1 GiB of RAM and disk space.
 
 ## How to setup a catchall address?
 
 https://github.com/foxcpp/maddy/issues/243#issuecomment-655694512
 
-## maddyctl prints a "permission denied" error
+## maddy command prints a "permission denied" error
 
-Run maddyctl under the same user as maddy itself.
+Run maddy command under the same user as maddy itself.
 E.g.
-``` 
-sudo -u maddy maddyctl creds ...
+```
+sudo -u maddy maddy creds ...
 ```
 
 ## How maddy compares to MailCow or Mail-In-The-Box?
@@ -116,4 +116,4 @@ of bugs in one component.
 
 Besides, you are not required to use a single process, it is easy to launch
 maddy with a non-default configuration path and connect multiple instances
-together using off-the-shelf protocols.
+together using off-the-shelf protocols.