docs: Add documentation for iOS mail push support #3513
Conversation
Signed-off-by: René Plötz <reneploetz@users.noreply.github.com>
There was a problem hiding this comment.
Solid work! 💪
Docs contribution is the way to go for now. The FTS Xapian plugin is usually provided via a package from the distro, but as it's already part of DMS an exception was made to temporarily allow building it for compatibility with the Dovecot community repo (which caused the incompatibility issue). Dovecot community repo being a newer version than what the newer Debian 12 release provides is also holding us back there, so likely to revert back to distro package only when possible due to issues that has caused.
We are considering changing to a different base image (Fedora and Alpine have been somewhat assessed), but while they both have a package for FTS Xapian, I did not see one for the plugin you're documenting here, which makes that much less likely to land into DMS.
There's potential for shifting existing contributed features to separate image to offload the maintenance burden from the core image. If that ever happens bringing in the change is probably viable for maintainers to accept.
| cmake .. -DCMAKE_BUILD_TYPE=Release && \ | ||
| make install | ||
|
|
||
| FROM golang:1.19-alpine AS dovecot-xaps-daemon |
There was a problem hiding this comment.
| FROM golang:1.19-alpine AS dovecot-xaps-daemon | |
| FROM golang:1.21-alpine AS dovecot-xaps-daemon |
There was a problem hiding this comment.
The version is deliberately older - there is a known bug: freswa/dovecot-xaps-daemon#24
I did not check if the issue still exists tough.
There was a problem hiding this comment.
That's an important detail to include if that's the case. You should reference this comment from the issue to explain the pinned version.
There was a problem hiding this comment.
I tested it - the issue persists. The Apple servers still send invalid http headers that Go > 1.20 does not like. Added comment for this.
polarathene
added
kind/new feature
Signed-off-by: René Plötz <reneploetz@users.noreply.github.com>
Signed-off-by: René Plötz <reneploetz@users.noreply.github.com>
Signed-off-by: René Plötz <reneploetz@users.noreply.github.com>
Signed-off-by: René Plötz <reneploetz@users.noreply.github.com>
Signed-off-by: René Plötz <reneploetz@users.noreply.github.com>
| Both device registration and notifications send a username to the daemon to lookup the device. While the registration and other IMAP operations in Dovecot will send the Dovecot username, LMTP will send the provided authentication username. | ||
|
|
||
| The format of that username is specified by the `auth_username_format` Dovecot setting. If you are not using mail addresses as Dovecot usernames - e.g. when using LDAP - you can either change the `auth_username_format` or add the mail address as property to the user account and use the lookup feature (see below). | ||
|
|
||
| ```sh title="user-patches.sh" | ||
| sed -i -r "s|^#?(auth_username_format =).*|\1 %Ln|" /etc/dovecot/conf.d/10-auth.conf | ||
| ``` |
There was a problem hiding this comment.
This was something I encountered recently while going through LDAP support in DMS, nice to have some proper docs in DMS for that! ❤️
|
Documentation preview for this PR is ready! 🎉 Built with commit: 2785a7a |
polarathene
changed the title
Description
Adds documentation on how to enable iOS Mail push support as discussed here: https://github.com/orgs/docker-mailserver/discussions/3432
While this might be of limited use for most people (you need to be enrolled in Apples Developer program to set it up), it still might be interesting to some.
As stated before you need to build a custom image to include the plugin and daemon executable. We could add this to the base image if there is more demand, tough this will increase the size by about 9 MB.
I would also be willing to create a pull request that would support this feature out-of-the-box if needed.
Although I tried to be as descriptive as possible to explain the steps one needs to take, it still might need some tweaking. Feedback is very welcome!
Type of change
Checklist:
docs/)