├── .env.sample
├── .gitignore
├── README.md
├── autodiscover
    ├── Dockerfile
    ├── LICENSE
    ├── app.json
    ├── icon.svg
    ├── index.js
    ├── package.json
    ├── settings.js
    ├── views
    │   ├── autoconfig.xml
    │   ├── autodiscover.xml
    │   ├── favicon.ico
    │   ├── index.html
    │   └── mobileconfig.xml
    └── yarn.lock
├── docker-compose.yml
└── mail
    ├── Dockerfile
    ├── config
        ├── dovecot-quotas.cf
        ├── dovecot.cf
        ├── fail2ban-fail2ban.cf
        ├── fail2ban-jail.cf
        ├── fetchmail.cf
        ├── postfix-accounts.cf
        ├── postfix-aliases.cf
        ├── postfix-main.cf
        ├── postfix-master.cf
        ├── postfix-virtual.cf
        ├── spamassassin-rules.cf
        └── user-patches.sh.dist
    ├── setup.sh
    └── target
        ├── bin
            ├── addalias
            ├── addmailuser
            ├── addrelayhost
            ├── addsaslpassword
            ├── debug-fetchmail
            ├── delalias
            ├── delmailuser
            ├── delquota
            ├── excluderelaydomain
            ├── fail2ban
            ├── fetchmailrc_split
            ├── generate-dkim-config
            ├── generate-dkim-domain
            ├── generate-ssl-certificate
            ├── listalias
            ├── listmailuser
            ├── open-dkim
            ├── postfix-summary
            ├── report-pflogsumm-yesterday
            ├── restrict-access
            ├── setquota
            ├── setup-fetchmail
            ├── updatemailuser
            └── virus-wiper
        ├── docker-configomat
            └── configomat.sh
        ├── dovecot
            ├── 10-master.conf
            ├── dovecot-dict-sql.conf.ext
            └── dovecot-sql.conf.ext
        ├── fetchmail
            └── fetchmailrc
        ├── postfix
            └── sql
            │   ├── alias_domain_catchall_maps.cf
            │   ├── alias_domain_mailbox_maps.cf
            │   ├── alias_domain_maps.cf
            │   ├── alias_maps.cf
            │   ├── domains_maps.cf
            │   └── mailbox_maps.cf
        └── scripts
            ├── check-for-changes.sh
            ├── fail2ban-wrapper.sh
            ├── helper-functions.sh
            ├── helpers
                ├── accounts.sh
                ├── aliases.sh
                ├── index.sh
                ├── postfix.sh
                ├── relay.sh
                └── sasl.sh
            ├── postfix-wrapper.sh
            ├── postsrsd-wrapper.sh
            ├── quota-warning.sh
            ├── start-mailserver.sh
            ├── startup
                ├── check-stack.sh
                ├── daemons-stack.sh
                ├── fixes-stack.sh
                ├── misc-stack.sh
                └── setup-stack.sh
            └── update-check.sh


/.env.sample:
--------------------------------------------------------------------------------
  1 | 
  2 | # –––––––––––––––––––––––––––––––––––––––––––––––
  3 | # ––– Mailserver Environment Variables ––––––––––
  4 | # –––––––––––––––––––––––––––––––––––––––––––––––
  5 | 
  6 | # DOCUMENTATION FOR THESE VARIABLES IS FOUND UNDER
  7 | # https://docker-mailserver.github.io/docker-mailserver/edge/config/environment/
  8 | 
  9 | # empty => uses the `hostname` command to get the mail server's canonical hostname
 10 | # => Specify a fully-qualified domainname to serve mail for.  This is used for many of the config features so if you can't set your hostname (e.g. you're in a container platform that doesn't let you) specify it in this environment variable.
 11 | 
 12 | OVERRIDE_HOSTNAME=<INSERT 'ROOT HOSTNAME NAME' HERE>
 13 | DOMAINNAME=<INSERT 'ROOT DOMAIN NAME' HERE>
 14 | CONTAINER_NAME=<INSERT 'CONTAINER NAME' HERE>
 15 | COMPANY_NAME=<INSERT 'COMPANY NAME' HERE>
 16 | 
 17 | # -----------------------------------------------
 18 | # --- General Section ---------------------------
 19 | # -----------------------------------------------
 20 | 
 21 | # 0 => Debug disabled
 22 | # 1 => Enables debug on startup
 23 | DMS_DEBUG=0
 24 | 
 25 | # critical => Only show critical messages
 26 | # error => Only show erroneous output
 27 | # **warn** => Show warnings
 28 | # info => Normal informational output
 29 | # debug => Also show debug messages
 30 | SUPERVISOR_LOGLEVEL=
 31 | 
 32 | # 0 => mail state in default directories
 33 | # 1 => consolidate all states into a single directory (`/var/mail-state`) to allow persistence using docker volumes
 34 | ONE_DIR=1
 35 | 
 36 | # empty => postmaster@domain.com
 37 | # => Specify the postmaster address
 38 | POSTMASTER_ADDRESS=
 39 | 
 40 | # Check for updates on container start and then once a day
 41 | # If an update is available, a mail is sent to POSTMASTER_ADDRESS
 42 | # 0 => Update check disabled
 43 | # 1 => Update check enabled
 44 | ENABLE_UPDATE_CHECK=1
 45 | 
 46 | # Customize the update check interval.
 47 | # Number + Suffix. Suffix must be 's' for seconds, 'm' for minutes, 'h' for hours or 'd' for days.
 48 | UPDATE_CHECK_INTERVAL=1d
 49 | 
 50 | # Set different options for mynetworks option (can be overwrite in postfix-main.cf)
 51 | # **WARNING**: Adding the docker network's gateway to the list of trusted hosts, e.g. using the `network` or
 52 | # `connected-networks` option, can create an open relay
 53 | # https://github.com/docker-mailserver/docker-mailserver/issues/1405#issuecomment-590106498
 54 | # empty => localhost only
 55 | # host => Add docker host (ipv4 only)
 56 | # network => Add all docker containers (ipv4 only)
 57 | # connected-networks => Add all connected docker networks (ipv4 only)
 58 | PERMIT_DOCKER=
 59 | 
 60 | # In case you network interface differs from 'eth0', e.g. when you are using HostNetworking in Kubernetes,
 61 | # you can set NETWORK_INTERFACE to whatever interface you want. This interface will then be used.
 62 | #  - **empty** => eth0
 63 | NETWORK_INTERFACE=
 64 | 
 65 | # empty => modern
 66 | # modern => Enables TLSv1.2 and modern ciphers only. (default)
 67 | # intermediate => Enables TLSv1, TLSv1.1 and TLSv1.2 and broad compatibility ciphers.
 68 | TLS_LEVEL=
 69 | 
 70 | # Configures the handling of creating mails with forged sender addresses.
 71 | #
 72 | # empty => (not recommended, but default for backwards compatibility reasons)
 73 | #           Mail address spoofing allowed. Any logged in user may create email messages with a forged sender address.
 74 | #           See also https://en.wikipedia.org/wiki/Email_spoofing
 75 | # 1 => (recommended) Mail spoofing denied. Each user may only send with his own or his alias addresses.
 76 | #       Addresses with extension delimiters(http://www.postfix.org/postconf.5.html#recipient_delimiter) are not able to send messages.
 77 | SPOOF_PROTECTION=
 78 | 
 79 | # Enables the Sender Rewriting Scheme. SRS is needed if your mail server acts as forwarder. See [postsrsd](https://github.com/roehling/postsrsd/blob/master/README.md#sender-rewriting-scheme-crash-course) for further explanation.
 80 | #  - **0** => Disabled
 81 | #  - 1 => Enabled
 82 | ENABLE_SRS=0
 83 | 
 84 | # 1 => Enables POP3 service
 85 | # empty => disables POP3
 86 | ENABLE_POP3=
 87 | ENABLE_CLAMAV=0
 88 | 
 89 | # Amavis content filter (used for ClamAV & SpamAssassin)
 90 | # 0 => Disabled
 91 | # 1 => Enabled
 92 | ENABLE_AMAVIS=1
 93 | 
 94 | # -1/-2/-3 => Only show errors
 95 | # **0**    => Show warnings
 96 | # 1/2      => Show default informational output
 97 | # 3/4/5    => log debug information (very verbose)
 98 | AMAVIS_LOGLEVEL=0
 99 | 
100 | # If you enable Fail2Ban, don't forget to add the following lines to your `docker-compose.yml`:
101 | #    cap_add:
102 | #      - NET_ADMIN
103 | # Otherwise, `iptables` won't be able to ban IPs.
104 | ENABLE_FAIL2BAN=0
105 | 
106 | # Fail2Ban blocktype
107 | # drop   => drop packet (send NO reply)
108 | # reject => reject packet (send ICMP unreachable)
109 | FAIL2BAN_BLOCKTYPE=drop
110 | 
111 | # 1 => Enables Managesieve on port 4190
112 | # empty => disables Managesieve
113 | ENABLE_MANAGESIEVE=
114 | 
115 | # **enforce** => Allow other tests to complete. Reject attempts to deliver mail with a 550 SMTP reply, and log the helo/sender/recipient information. Repeat this test the next time the client connects.
116 | # drop => Drop the connection immediately with a 521 SMTP reply. Repeat this test the next time the client connects.
117 | # ignore => Ignore the failure of this test. Allow other tests to complete. Repeat this test the next time the client connects. This option is useful for testing and collecting statistics without blocking mail.
118 | POSTSCREEN_ACTION=enforce
119 | 
120 | # empty => all daemons start
121 | # 1 => only launch postfix smtp
122 | SMTP_ONLY=
123 | 
124 | # Please read [the SSL page in the documentation](https://docker-mailserver.github.io/docker-mailserver/edge/config/security/ssl) for more information.
125 | #
126 | # empty => SSL disabled
127 | # letsencrypt => Enables Let's Encrypt certificates
128 | # custom => Enables custom certificates
129 | # manual => Let's you manually specify locations of your SSL certificates for non-standard cases
130 | # self-signed => Enables self-signed certificates
131 | SSL_TYPE=
132 | 
133 | # These are only supported with `SSL_TYPE=manual`.
134 | # Provide the path to your cert and key files that you've mounted access to within the container.
135 | SSL_CERT_PATH=
136 | SSL_KEY_PATH=
137 | # Optional: A 2nd certificate can be supported as fallback (dual cert support), eg ECDSA with an RSA fallback.
138 | # Useful for additional compatibility with older MTA and MUA (eg pre-2015).
139 | SSL_ALT_CERT_PATH=
140 | SSL_ALT_KEY_PATH=
141 | 
142 | # Set how many days a virusmail will stay on the server before being deleted
143 | # empty => 7 days
144 | VIRUSMAILS_DELETE_DELAY=
145 | 
146 | # This Option is activating the Usage of POSTFIX_DAGENT to specify a lmtp client different from default dovecot socket.
147 | # empty => disabled
148 | # 1 => enabled
149 | ENABLE_POSTFIX_VIRTUAL_TRANSPORT=
150 | 
151 | # Enabled by ENABLE_POSTFIX_VIRTUAL_TRANSPORT. Specify the final delivery of postfix
152 | #
153 | # empty => fail
154 | # `lmtp:unix:private/dovecot-lmtp` (use socket)
155 | # `lmtps:inet:<host>:<port>` (secure lmtp with starttls, take a look at https://sys4.de/en/blog/2014/11/17/sicheres-lmtp-mit-starttls-in-dovecot/)
156 | # `lmtp:<kopano-host>:2003` (use kopano as mailstore)
157 | # etc.
158 | POSTFIX_DAGENT=
159 | 
160 | # Set the mailbox size limit for all users. If set to zero, the size will be unlimited (default).
161 | #
162 | # empty => 0
163 | POSTFIX_MAILBOX_SIZE_LIMIT=
164 | 
165 | # See https://docker-mailserver.github.io/docker-mailserver/edge/config/user-management/accounts/#notes
166 | # 0 => Dovecot quota is disabled
167 | # 1 => Dovecot quota is enabled
168 | ENABLE_QUOTAS=1
169 | 
170 | # Set the message size limit for all users. If set to zero, the size will be unlimited (not recommended!)
171 | #
172 | # empty => 10240000 (~10 MB)
173 | POSTFIX_MESSAGE_SIZE_LIMIT=
174 | 
175 | # Enables regular pflogsumm mail reports.
176 | # This is a new option. The old REPORT options are still supported for backwards compatibility. If this is not set and reports are enabled with the old options, logrotate will be used.
177 | #
178 | # not set => No report
179 | # daily_cron => Daily report for the previous day
180 | # logrotate => Full report based on the mail log when it is rotated
181 | PFLOGSUMM_TRIGGER=
182 | 
183 | # Recipient address for pflogsumm reports.
184 | #
185 | # not set => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
186 | # => Specify the recipient address(es)
187 | PFLOGSUMM_RECIPIENT=
188 | 
189 | # From address for pflogsumm reports.
190 | #
191 | # not set => Use REPORT_SENDER or POSTMASTER_ADDRESS
192 | # => Specify the sender address
193 | PFLOGSUMM_SENDER=
194 | 
195 | # Interval for logwatch report.
196 | #
197 | # none => No report is generated
198 | # daily => Send a daily report
199 | # weekly => Send a report every week
200 | LOGWATCH_INTERVAL=
201 | 
202 | # Recipient address for logwatch reports if they are enabled.
203 | #
204 | # not set => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
205 | # => Specify the recipient address(es)
206 | LOGWATCH_RECIPIENT=
207 | 
208 | # Enables a report being sent (created by pflogsumm) on a regular basis. (deprecated)
209 | # **0** => Report emails are disabled
210 | # 1 => Using POSTMASTER_ADDRESS as the recipient
211 | # => Specify the recipient address
212 | REPORT_RECIPIENT=0
213 | 
214 | # Change the sending address for mail report (deprecated)
215 | # **empty** => mailserver-report@hostname
216 | # => Specify the report sender (From) address
217 | REPORT_SENDER=
218 | 
219 | # Changes the interval in which a report is being sent. (deprecated)
220 | # **daily** => Send a daily report
221 | # weekly => Send a report every week
222 | # monthly => Send a report every month
223 | #
224 | # Note: This Variable actually controls logrotate inside the container and rotates the log depending on this setting. The main log output is still available in its entirety via `docker logs mail` (Or your respective container name). If you want to control logrotation for the docker generated logfile see: [Docker Logging Drivers](https://docs.docker.com/config/containers/logging/configure/)
225 | REPORT_INTERVAL=daily
226 | 
227 | # Choose TCP/IP protocols to use
228 | # **all** => All possible protocols.
229 | # ipv4 => Use only IPv4 traffic. Most likely you want this behind Docker.
230 | # ipv6 => Use only IPv6 traffic.
231 | #
232 | # Note: More details in http://www.postfix.org/postconf.5.html#inet_protocols
233 | POSTFIX_INET_PROTOCOLS=all
234 | 
235 | # -----------------------------------------------
236 | # --- SpamAssassin Section ----------------------
237 | # -----------------------------------------------
238 | 
239 | ENABLE_SPAMASSASSIN=0
240 | 
241 | # deliver spam messages in the inbox (eventually tagged using SA_SPAM_SUBJECT)
242 | SPAMASSASSIN_SPAM_TO_INBOX=1
243 | 
244 | # spam messages will be moved in the Junk folder (SPAMASSASSIN_SPAM_TO_INBOX=1 required)
245 | MOVE_SPAM_TO_JUNK=1
246 | 
247 | # add spam info headers if at, or above that level:
248 | SA_TAG=2.0
249 | 
250 | # add 'spam detected' headers at that level
251 | SA_TAG2=6.31
252 | 
253 | # triggers spam evasive actions
254 | SA_KILL=6.31
255 | 
256 | # add tag to subject if spam detected
257 | SA_SPAM_SUBJECT=***SPAM*****
258 | 
259 | # -----------------------------------------------
260 | # --- Fetchmail Section -------------------------
261 | # -----------------------------------------------
262 | 
263 | ENABLE_FETCHMAIL=0
264 | 
265 | # The interval to fetch mail in seconds
266 | FETCHMAIL_POLL=300
267 | 
268 | # -----------------------------------------------
269 | # --- LDAP Section ------------------------------
270 | # -----------------------------------------------
271 | 
272 | # A second container for the ldap service is necessary (i.e. https://github.com/osixia/docker-openldap)
273 | # For preparing the ldap server to use in combination with this container this article may be helpful: http://acidx.net/wordpress/2014/06/installing-a-mailserver-with-postfix-dovecot-sasl-ldap-roundcube/
274 | 
275 | # empty => LDAP authentification is disabled
276 | # 1 => LDAP authentification is enabled
277 | ENABLE_LDAP=
278 | 
279 | # empty => no
280 | # yes => LDAP over TLS enabled for Postfix
281 | LDAP_START_TLS=
282 | 
283 | # If you going to use the mailserver in combination with docker-compose you can set the service name here
284 | # empty => mail.domain.com
285 | # Specify the dns-name/ip-address where the ldap-server
286 | LDAP_SERVER_HOST=
287 | 
288 | # empty => ou=people,dc=domain,dc=com
289 | # => e.g. LDAP_SEARCH_BASE=dc=mydomain,dc=local
290 | LDAP_SEARCH_BASE=
291 | 
292 | # empty => cn=admin,dc=domain,dc=com
293 | # => take a look at examples of SASL_LDAP_BIND_DN
294 | LDAP_BIND_DN=
295 | 
296 | # empty** => admin
297 | # => Specify the password to bind against ldap
298 | LDAP_BIND_PW=
299 | 
300 | # e.g. `"(&(mail=%s)(mailEnabled=TRUE))"`
301 | # => Specify how ldap should be asked for users
302 | LDAP_QUERY_FILTER_USER=
303 | 
304 | # e.g. `"(&(mailGroupMember=%s)(mailEnabled=TRUE))"`
305 | # => Specify how ldap should be asked for groups
306 | LDAP_QUERY_FILTER_GROUP=
307 | 
308 | # e.g. `"(&(mailAlias=%s)(mailEnabled=TRUE))"`
309 | # => Specify how ldap should be asked for aliases
310 | LDAP_QUERY_FILTER_ALIAS=
311 | 
312 | # e.g. `"(&(|(mail=*@%s)(mailalias=*@%s)(mailGroupMember=*@%s))(mailEnabled=TRUE))"`
313 | # => Specify how ldap should be asked for domains
314 | LDAP_QUERY_FILTER_DOMAIN=
315 | 
316 | # -----------------------------------------------
317 | # --- Dovecot Section ---------------------------
318 | # -----------------------------------------------
319 | 
320 | # empty => no
321 | # yes => LDAP over TLS enabled for Dovecot
322 | DOVECOT_TLS=
323 | 
324 | # e.g. `"(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))"`
325 | DOVECOT_USER_FILTER=
326 | 
327 | # e.g. `"(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))"`
328 | DOVECOT_PASS_FILTER=
329 | 
330 | # Define the mailbox format to be used
331 | # default is maildir, supported values are: sdbox, mdbox, maildir
332 | DOVECOT_MAILBOX_FORMAT=maildir
333 | 
334 | # empty => no
335 | # yes => Allow bind authentication for LDAP
336 | # https://wiki.dovecot.org/AuthDatabase/LDAP/AuthBinds
337 | DOVECOT_AUTH_BIND=
338 | 
339 | # -----------------------------------------------
340 | # --- Postgrey Section --------------------------
341 | # -----------------------------------------------
342 | 
343 | ENABLE_POSTGREY=0
344 | # greylist for N seconds
345 | POSTGREY_DELAY=300
346 | # delete entries older than N days since the last time that they have been seen
347 | POSTGREY_MAX_AGE=35
348 | # response when a mail is greylisted
349 | POSTGREY_TEXT="Delayed by Postgrey"
350 | # whitelist host after N successful deliveries (N=0 to disable whitelisting)
351 | POSTGREY_AUTO_WHITELIST_CLIENTS=5
352 | 
353 | # -----------------------------------------------
354 | # --- SASL Section ------------------------------
355 | # -----------------------------------------------
356 | 
357 | ENABLE_SASLAUTHD=0
358 | 
359 | # empty => pam
360 | # `ldap` => authenticate against ldap server
361 | # `shadow` => authenticate against local user db
362 | # `mysql` => authenticate against mysql db
363 | # `rimap` => authenticate against imap server
364 | # Note: can be a list of mechanisms like pam ldap shadow
365 | SASLAUTHD_MECHANISMS=
366 | 
367 | # empty => None
368 | # e.g. with SASLAUTHD_MECHANISMS rimap you need to specify the ip-address/servername of the imap server  ==> xxx.xxx.xxx.xxx
369 | SASLAUTHD_MECH_OPTIONS=
370 | 
371 | # empty => Use value of LDAP_SERVER_HOST
372 | # Note: since version 10.0.0, you can specify a protocol here (like ldaps://); this deprecates SASLAUTHD_LDAP_SSL.
373 | SASLAUTHD_LDAP_SERVER=
374 | 
375 | # empty => Use value of LDAP_BIND_DN
376 | # specify an object with priviliges to search the directory tree
377 | # e.g. active directory: SASLAUTHD_LDAP_BIND_DN=cn=Administrator,cn=Users,dc=mydomain,dc=net
378 | # e.g. openldap: SASLAUTHD_LDAP_BIND_DN=cn=admin,dc=mydomain,dc=net
379 | SASLAUTHD_LDAP_BIND_DN=
380 | 
381 | # empty => Use value of LDAP_BIND_PW
382 | SASLAUTHD_LDAP_PASSWORD=
383 | 
384 | # empty => Use value of LDAP_SEARCH_BASE
385 | # specify the search base
386 | SASLAUTHD_LDAP_SEARCH_BASE=
387 | 
388 | # empty => default filter `(&(uniqueIdentifier=%u)(mailEnabled=TRUE))`
389 | # e.g. for active directory: `(&(sAMAccountName=%U)(objectClass=person))`
390 | # e.g. for openldap: `(&(uid=%U)(objectClass=person))`
391 | SASLAUTHD_LDAP_FILTER=
392 | 
393 | # empty => no
394 | # yes => LDAP over TLS enabled for SASL
395 | # If set to yes, the protocol in SASLAUTHD_LDAP_SERVER must be ldap:// or missing.
396 | SASLAUTHD_LDAP_START_TLS=
397 | 
398 | # empty => no
399 | # yes => Require and verify server certificate
400 | # If yes you must/could specify SASLAUTHD_LDAP_TLS_CACERT_FILE or SASLAUTHD_LDAP_TLS_CACERT_DIR.
401 | SASLAUTHD_LDAP_TLS_CHECK_PEER=
402 | 
403 | # File containing CA (Certificate Authority) certificate(s).
404 | # empty => Nothing is added to the configuration
405 | # Any value => Fills the `ldap_tls_cacert_file` option
406 | SASLAUTHD_LDAP_TLS_CACERT_FILE=
407 | 
408 | # Path to directory with CA (Certificate Authority) certificates.
409 | # empty => Nothing is added to the configuration
410 | # Any value => Fills the `ldap_tls_cacert_dir` option
411 | SASLAUTHD_LDAP_TLS_CACERT_DIR=
412 | 
413 | # Specify what password attribute to use for password verification.
414 | # empty => Nothing is added to the configuration but the documentation says it is `userPassword` by default.
415 | # Any value => Fills the `ldap_password_attr` option
416 | SASLAUTHD_LDAP_PASSWORD_ATTR=
417 | 
418 | # empty => No sasl_passwd will be created
419 | # string => `/etc/postfix/sasl_passwd` will be created with the string as password
420 | SASL_PASSWD=
421 | 
422 | # empty => `bind` will be used as a default value
423 | # `fastbind` => The fastbind method is used
424 | # `custom` => The custom method uses userPassword attribute to verify the password
425 | SASLAUTHD_LDAP_AUTH_METHOD=
426 | 
427 | # Specify the authentication mechanism for SASL bind
428 | # empty => Nothing is added to the configuration
429 | # Any value => Fills the `ldap_mech` option
430 | SASLAUTHD_LDAP_MECH=
431 | 
432 | # -----------------------------------------------
433 | # --- SRS Section -------------------------------
434 | # -----------------------------------------------
435 | 
436 | # envelope_sender => Rewrite only envelope sender address (default)
437 | # header_sender => Rewrite only header sender (not recommended)
438 | # envelope_sender,header_sender => Rewrite both senders
439 | # An email has an "envelope" sender (indicating the sending server) and a
440 | # "header" sender (indicating who sent it). More strict SPF policies may require
441 | # you to replace both instead of just the envelope sender.
442 | SRS_SENDER_CLASSES=envelope_sender
443 | 
444 | # empty => Envelope sender will be rewritten for all domains
445 | # provide comma separated list of domains to exclude from rewriting
446 | SRS_EXCLUDE_DOMAINS=
447 | 
448 | # empty => generated when the image is built
449 | # provide a secret to use in base64
450 | # you may specify multiple keys, comma separated. the first one is used for
451 | # signing and the remaining will be used for verification. this is how you
452 | # rotate and expire keys
453 | SRS_SECRET=
454 | 
455 | # -----------------------------------------------
456 | # --- Default Relay Host Section ----------------
457 | # -----------------------------------------------
458 | 
459 | # Setup relaying all mail through a default relay host
460 | #
461 | # empty => don't configure default relay host
462 | # default host and optional port to relay all mail through
463 | DEFAULT_RELAY_HOST=
464 | 
465 | # -----------------------------------------------
466 | # --- Multi-Domain Relay Section ----------------
467 | # -----------------------------------------------
468 | 
469 | # Setup relaying for multiple domains based on the domain name of the sender
470 | # optionally uses usernames and passwords in postfix-sasl-password.cf and relay host mappings in postfix-relaymap.cf
471 | #
472 | # empty => don't configure relay host
473 | # default host to relay mail through
474 | RELAY_HOST=
475 | 
476 | # empty => 25
477 | # default port to relay mail
478 | RELAY_PORT=25
479 | 
480 | # empty => no default
481 | # default relay username (if no specific entry exists in postfix-sasl-password.cf)
482 | RELAY_USER=
483 | 
484 | # empty => no default
485 | # password for default relay user
486 | RELAY_PASSWORD=
487 | 
488 | # –––––––––––––––––––––––––––––––––––––––––––––––
489 | # –––- MySQL & Postfix Admin Variables –––––––––-
490 | # –––––––––––––––––––––––––––––––––––––––––––––––
491 | 
492 | # https://github.com/postfixadmin/postfixadmin/blob/52ed517f35fc2bfde193fad94ddd07d2e5cd4c8d/INSTALL.TXT#L186
493 | POSTFIXADMIN_SETUP_PASSWORD=
494 | 
495 | MYSQL_DATABASE=example
496 | MYSQL_USER=example
497 | MYSQL_PASSWORD=example
498 | MYSQL_ROOT_PASSWORD=example
499 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | #################################################
 2 | ###  General  ###################################
 3 | #################################################
 4 | 
 5 | .DS_Store
 6 | .env
 7 | config/opendkim/
 8 | 
 9 | #################################################
10 | ###  IDEs  ######################################
11 | #################################################
12 | 
13 | .idea
14 | .vscode
15 | 
16 | 
17 | #################################################
18 | ###  Linting Tools  #############################
19 | #################################################
20 | 
21 | tools/
22 | 
23 | #################################################
24 | ###  Tests  #####################################
25 | #################################################
26 | 
27 | test/config/empty/
28 | test/config/postfix-accounts.cf
29 | test/config/letsencrypt/mail.my-domain.com/combined.pem
30 | test/config/dovecot-lmtp/userdb
31 | test/config/key*
32 | test/config/opendkim/keys/domain.tld/
33 | test/config/opendkim/keys/example.com/
34 | test/config/opendkim/keys/localdomain2.com/
35 | test/config/postfix-aliases.cf
36 | test/config/postfix-receive-access.cf
37 | test/config/postfix-receive-access.cfe
38 | test/config/postfix-send-access.cf
39 | test/config/postfix-send-access.cfe
40 | test/config/relay-hosts/chksum
41 | test/config/relay-hosts/postfix-aliases.cf
42 | test/config/without-virtual/
43 | test/config/with-domain/
44 | test/onedir
45 | test/duplicate_configs
46 | 
47 | config.bak
48 | testconfig.bak
49 | 
50 | mail/data/


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Dockerised-GUI-Mailserver
 2 | Dockerised GUI Mail Server (Forked from [Dockerised Mail Server](https://github.com/docker-mailserver/docker-mailserver) that is extended to support **_MySQl_** &amp; **_PostgreSQL_** which works well with [PostfixAdmin](https://github.com/postfixadmin/postfixadmin)  to simplify the management of the Mail Server)
 3 | 
 4 | # Features
 5 | - GUI to manage the dockerised mailserver
 6 | - Ready for Production
 7 | 
 8 | # To-do
 9 | - [ ] Refactor SQL Mapping with conditional rules
10 | - [ ] Document the entire process from a to z
11 | - [ ] Integrate imapsync/Fetchmail using gui
12 | - [ ] Manage transport using  sql from the gui
13 | 
14 | # Useful links
15 | - [Mailserver Environment Variables Docs](https://docker-mailserver.github.io/docker-mailserver/edge/config/environment)
16 | - [PostfixAdmin Docs](https://github.com/postfixadmin/postfixadmin/blob/master/INSTALL.TXT)
17 | 


--------------------------------------------------------------------------------
/autodiscover/Dockerfile:
--------------------------------------------------------------------------------
 1 | FROM node:lts-alpine
 2 | 
 3 | LABEL maintainer="Monogramm Maintainers <opensource at monogramm dot io>"
 4 | 
 5 | EXPOSE 8000
 6 | WORKDIR /app
 7 | COPY package.json yarn.lock index.js settings.js /app/
 8 | RUN yarn --prod && yarn cache clean
 9 | COPY views /app/views
10 | 
11 | CMD ["node", "/app/index"]
12 | 


--------------------------------------------------------------------------------
/autodiscover/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2020 Monogramm
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 
23 | 


--------------------------------------------------------------------------------
/autodiscover/app.json:
--------------------------------------------------------------------------------
 1 | {
 2 | 	"name": "autodiscover-email-settings",
 3 | 	"description": "Provides IMAP/SMTP/LDAP Autoconfiguration capabilities for Microsoft Outlook, Apple Mail, and Thunderbird",
 4 | 	"website": "https://monogramm.io",
 5 | 	"repository": "https://github.com/monogramm/autodiscover-email-settings",
 6 | 	"keywords": ["monogramm", "autoconfigure", "autoconf", "autodiscover", "outlook", "thunderbird", "apple mail", "imap", "smtp", "ldap"],
 7 | 	"addons": [
 8 | 		"papertrail"
 9 | 	],
10 | 	"env": {
11 | 		"COMPANY_NAME": {
12 | 			"description": "Your company name",
13 | 			"value": "AutoDiscover"
14 | 		},
15 | 		"SUPPORT_URL": {
16 | 			"description": "Your company support URL",
17 | 			"value": "autodiscover.example.com"
18 | 		},
19 | 		"DOMAIN": {
20 | 			"description": "Your default domain",
21 | 			"value": "example.com"
22 | 		},
23 | 		"IMAP_HOST": {
24 | 			"description": "Your IMAP Host",
25 | 			"value": "imap.example.com"
26 | 		},
27 | 		"IMAP_PORT": {
28 | 			"description": "Your IMAP Port",
29 | 			"value": "993"
30 | 		},
31 | 		"IMAP_SOCKET": {
32 | 			"description": "Your IMAP Socket",
33 | 			"value": "SSL"
34 | 		},
35 | 		"SMTP_HOST": {
36 | 			"description": "Your SMTP Host",
37 | 			"value": "smtp.example.com"
38 | 		},
39 | 		"SMTP_PORT": {
40 | 			"description": "Your SMTP Port",
41 | 			"value": "587"
42 | 		},
43 | 		"SMTP_SOCKET": {
44 | 			"description": "Your SMTP Socket",
45 | 			"value": "STARTTLS"
46 | 		},
47 | 		"LDAP_HOST": {
48 | 			"description": "Your LDAP Host",
49 | 			"value": "ldap.example.com"
50 | 		},
51 | 		"LDAP_PORT": {
52 | 			"description": "Your LDAP Port",
53 | 			"value": "389"
54 | 		},
55 | 		"LDAP_SOCKET": {
56 | 			"description": "Your LDAP Socket",
57 | 			"value": "STARTTLS"
58 | 		},
59 | 		"LDAP_BASE": {
60 | 			"description": "Your LDAP Base DN",
61 | 			"value": "dc=ldap,dc=example,dc=com"
62 | 		},
63 | 		"LDAP_USER_FIELD": {
64 | 			"description": "Your LDAP Username name",
65 | 			"value": "uid"
66 | 		},
67 | 		"LDAP_USER_BASE": {
68 | 			"description": "Your LDAP User Base DN",
69 | 			"value": "ou=People,dc=ldap,dc=example,dc=com"
70 | 		},
71 | 		"PROFILE_IDENTIFIER": {
72 | 			"description": "Your mobile profile identifier",
73 | 			"value": "com.example.autodiscover"
74 | 		},
75 | 		"PROFILE_UUID": {
76 | 			"description": "Your mobile profile globally unique ID",
77 | 			"value": "92943D26-CAB3-4086-897D-DC6C0D8B1E86"
78 | 		},
79 | 		"MAIL_UUID": {
80 | 			"description": "Your mail profile globally unique ID",
81 | 			"value": "7A981A9E-D5D0-4EF8-87FE-39FD6A506FAC"
82 | 		},
83 | 		"LDAP_UUID": {
84 | 			"description": "Your ldap profile globally unique ID",
85 | 			"value": "6ECB6BA9-2208-4ABF-9E60-4E9F4CD7309E"
86 | 		}
87 | 	}
88 | }
89 | 


--------------------------------------------------------------------------------
/autodiscover/icon.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 2 | <!-- Generated with https://mybrandnewlogo.com/ -->
 3 | <svg
 4 |    xmlns:dc="http://purl.org/dc/elements/1.1/"
 5 |    xmlns:cc="http://creativecommons.org/ns#"
 6 |    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
 7 |    xmlns:svg="http://www.w3.org/2000/svg"
 8 |    xmlns="http://www.w3.org/2000/svg"
 9 |    xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
10 |    xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
11 |    width="64"
12 |    height="64"
13 |    viewBox="0 0 64 64"
14 |    version="1.1"
15 |    id="svg12"
16 |    sodipodi:docname="icon.svg"
17 |    style="fill:currentColor">
18 |   <metadata
19 |      id="metadata18">
20 |     <rdf:RDF>
21 |       <cc:Work
22 |          rdf:about="">
23 |         <dc:format>image/svg+xml</dc:format>
24 |         <dc:type
25 |            rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
26 |         <dc:title></dc:title>
27 |       </cc:Work>
28 |     </rdf:RDF>
29 |   </metadata>
30 |   <defs
31 |      id="defs16" />
32 |   <sodipodi:namedview
33 |      pagecolor="#ffffff"
34 |      bordercolor="#666666"
35 |      borderopacity="1"
36 |      objecttolerance="10"
37 |      gridtolerance="10"
38 |      guidetolerance="10"
39 |      inkscape:pageopacity="0"
40 |      inkscape:pageshadow="2"
41 |      inkscape:window-width="1920"
42 |      inkscape:window-height="1017"
43 |      id="namedview14"
44 |      showgrid="false"
45 |      inkscape:zoom="11.8"
46 |      inkscape:cx="28.657106"
47 |      inkscape:cy="30.338983"
48 |      inkscape:window-x="-8"
49 |      inkscape:window-y="-8"
50 |      inkscape:window-maximized="1"
51 |      inkscape:current-layer="g833" />
52 |   <g
53 |      id="g833"
54 |      transform="matrix(0.2,0,0,0.2,0,47.125)">
55 |     <g
56 |        id="g822"
57 |        transform="matrix(3.2,0,0,3.2,0,-185.625)">
58 |       <path
59 |          style="fill:#007bff;fill-opacity:1"
60 |          inkscape:connector-curvature="0"
61 |          d="M 87.5,46.94 V 6.25 C 87.5,2.804 84.696,0 81.25,0 H 18.75 C 15.304,0 12.5,2.804 12.5,6.25 V 46.94 L 0,57.356 v 0.977 C 0,63.086 2.169,68.75 12.5,68.75 h 75 c 10.331,0 12.5,-5.664 12.5,-10.417 V 57.356 Z M 15.34,50 h 69.32 l 7.501,6.25 -32.603,0.006 -0.608,0.599 c -0.606,0.596 -1.885,1.479 -2.7,1.479 h -12.5 c -0.816,0 -2.094,-0.883 -2.694,-1.473 l -0.61,-0.61 H 7.839 Z M 18.75,4.167 h 62.5 c 1.149,0 2.083,0.934 2.083,2.083 V 45.833 H 16.667 V 6.25 c 0,-1.149 0.934,-2.083 2.083,-2.083 z M 87.5,64.583 h -75 c -5.707,0 -7.579,-1.827 -8.126,-4.166 h 34.42 c 0.98,0.804 2.873,2.083 4.956,2.083 h 12.5 c 2.083,0 3.976,-1.279 4.956,-2.083 h 34.42 c -0.548,2.339 -2.419,4.166 -8.126,4.166 z"
62 |          id="path2" />
63 |       <path
64 |          style="fill:#007bff;fill-opacity:1"
65 |          inkscape:connector-curvature="0"
66 |          d="M 66.104,12.797 C 65.631,12.61 65.12,12.5 64.583,12.5 H 35.417 c -0.537,0 -1.047,0.11 -1.52,0.297 L 50,24.508 Z"
67 |          id="path4" />
68 |       <path
69 |          style="fill:#007bff;fill-opacity:1"
70 |          inkscape:connector-curvature="0"
71 |          d="m 68.687,33.966 c 0.031,-0.207 0.063,-0.417 0.063,-0.632 V 16.667 c 0,-0.206 -0.032,-0.403 -0.061,-0.6 l -9.573,6.962 z"
72 |          id="path6" />
73 |       <path
74 |          style="fill:#007bff;fill-opacity:1"
75 |          inkscape:connector-curvature="0"
76 |          d="m 40.883,23.028 -9.572,-6.962 c -0.028,0.197 -0.061,0.395 -0.061,0.6 v 16.667 c 0,0.215 0.033,0.425 0.063,0.632 z"
77 |          id="path8" />
78 |       <path
79 |          style="fill:#007bff;fill-opacity:1"
80 |          inkscape:connector-curvature="0"
81 |          d="m 51.225,28.768 c -0.364,0.266 -0.795,0.398 -1.225,0.398 -0.43,0 -0.86,-0.132 -1.225,-0.398 L 44.266,25.49 33.993,37.233 c 0.445,0.163 0.921,0.267 1.424,0.267 h 29.167 c 0.503,0 0.979,-0.104 1.425,-0.267 L 55.733,25.49 Z"
82 |          id="path10" />
83 |     </g>
84 |   </g>
85 | </svg>
86 | 


--------------------------------------------------------------------------------
/autodiscover/index.js:
--------------------------------------------------------------------------------
  1 | "use strict";
  2 | 
  3 | const path		= require("path");
  4 | const app		= require("koa")();
  5 | const swig		= require("koa-swig");
  6 | const body		= require("koa-buddy");
  7 | const router	= require("koa-router")();
  8 | const settings	= require("./settings.js");
  9 | 
 10 | function findChild(name, children, def = null) {
 11 | 	for (let child of children) {
 12 | 		if (child.name === name) {
 13 | 			return child;
 14 | 		}
 15 | 	}
 16 | 	return def;
 17 | }
 18 | 
 19 | // Microsoft Outlook / Apple Mail
 20 | function *autodiscover() {
 21 | 	this.set("Content-Type", "application/xml");
 22 | 
 23 | 	const request	= this.request.body && this.request.body.root ? 
 24 | 		findChild("Request", this.request.body.root.children) : 
 25 | 		null;
 26 | 	const schema	= request !== null ? 
 27 | 		findChild("AcceptableResponseSchema", request.children) : 
 28 | 		null;
 29 | 	const xmlns		= schema !== null ? 
 30 | 		schema.content : 
 31 | 		"http://schemas.microsoft.com/exchange/autodiscover/responseschema/2006";
 32 | 
 33 | 	let email		= request !== null ? 
 34 | 		findChild("EMailAddress", request.children) : 
 35 | 		null;
 36 | 
 37 | 	let username;
 38 | 	let domain;
 39 | 	if ( email === null || email.content === null ) {
 40 | 		email		= "";
 41 | 		username	= "";
 42 | 		domain		= settings.domain;
 43 | 	} else if ( ~email.content.indexOf("@") ) {
 44 | 		email		= email.content;
 45 | 		username	= email.split("@")[0];
 46 | 		domain		= email.split("@")[1];
 47 | 	} else {
 48 | 		username	= email.content;
 49 | 		domain		= settings.domain;
 50 | 		email		= username + "@" + domain;
 51 | 	}
 52 | 
 53 | 	const imapenc	= settings.imap.socket === "STARTTLS" ? "TLS" : settings.imap.socket;
 54 | 	const popenc	= settings.pop.socket === "STARTTLS" ? "TLS" : settings.pop.socket;
 55 | 	const smtpenc	= settings.smtp.socket === "STARTTLS" ? "TLS" : settings.smtp.socket;
 56 | 
 57 | 	yield this.render("autodiscover", {
 58 | 		schema: xmlns,
 59 | 		email,
 60 | 		username,
 61 | 		domain,
 62 | 		imapenc,
 63 | 		popenc,
 64 | 		smtpenc
 65 | 	});
 66 | }
 67 | 
 68 | router.get("/autodiscover/autodiscover.xml", autodiscover);
 69 | router.post("/autodiscover/autodiscover.xml", autodiscover);
 70 | router.get("/Autodiscover/Autodiscover.xml", autodiscover);
 71 | router.post("/Autodiscover/Autodiscover.xml", autodiscover);
 72 | 
 73 | 
 74 | // Thunderbird
 75 | router.get("/mail/config-v1.1.xml", function *autoconfig() {
 76 | 	this.set("Content-Type", "application/xml");
 77 | 	yield this.render("autoconfig");
 78 | });
 79 | 
 80 | 
 81 | // iOS / Apple Mail (/email.mobileconfig?email=username@domain.com or /email.mobileconfig?email=username)
 82 | router.get("/email.mobileconfig", function *autoconfig() {
 83 | 	let email = this.request.query.email;
 84 | 
 85 | 	if (!email) {
 86 | 		this.status = 400;
 87 | 
 88 | 		return;
 89 | 	}
 90 | 
 91 | 	let username;
 92 | 	let domain;
 93 | 	if ( ~email.indexOf("@") ) {
 94 | 		username	= email.split("@")[0];
 95 | 		domain		= email.split("@")[1];
 96 | 	} else {
 97 | 		username	= email;
 98 | 		domain		= settings.domain;
 99 | 		email		= username + "@" + domain;
100 | 	}
101 | 
102 | 	const filename	= `${domain}.mobileconfig`;
103 | 
104 | 	const imapssl	= settings.imap.socket === "SSL" || settings.imap.socket === "STARTTLS" ? "true" : "false";
105 | 	const popssl	= settings.pop.socket === "SSL" || settings.pop.socket === "STARTTLS" ? "true" : "false";
106 | 	const smtpssl	= settings.smtp.socket === "SSL" || settings.smtp.socket === "STARTTLS" ? "true" : "false";
107 | 	const ldapssl	= settings.ldap.socket === "SSL" || settings.ldap.port === "636" ? "true" : "false";
108 | 
109 | 	this.set("Content-Type", "application/x-apple-aspen-config; charset=utf-8");
110 | 	this.set("Content-Disposition", `attachment; filename="${filename}"`);
111 | 
112 | 	yield this.render("mobileconfig", {
113 | 		email,
114 | 		username,
115 | 		domain,
116 | 		imapssl,
117 | 		popssl,
118 | 		smtpssl,
119 | 		ldapssl
120 | 	});
121 | });
122 | 
123 | 
124 | // Generic support page
125 | router.get("/", function *index() {
126 | 	yield this.render("index.html");
127 | });
128 | 
129 | router.get("/favicon.ico", function *icon() {
130 | 	yield this.render("favicon.ico");
131 | });
132 | 
133 | app.context.render = swig({
134 | 	root: path.join(__dirname, "views"),
135 | 	autoescape: true,
136 | 	cache: "memory",
137 | 	ext: "xml",
138 | 	locals: settings
139 | });
140 | 
141 | app.use(function *fixContentType(next) {
142 | 	let type = this.request.headers["content-type"];
143 | 
144 | 	if (type && type.indexOf("text/xml") === 0) {
145 | 		let newType = type.replace("text/xml", "application/xml");
146 | 
147 | 		this.request.headers["content-type"] = newType;
148 | 	}
149 | 
150 | 	yield next;
151 | });
152 | 
153 | app.use(body());
154 | app.use(router.routes());
155 | app.use(router.allowedMethods());
156 | 
157 | app.listen(process.env.PORT || 8000);
158 | 


--------------------------------------------------------------------------------
/autodiscover/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "autodiscover-email-settings",
 3 |   "version": "1.4.0",
 4 |   "description": "Provides IMAP/SMTP/LDAP Autodiscover capabilities on Microsoft Outlook/Apple Mail, Autoconfig capabilities for Thunderbird, and Configuration Profiles for iOS/Apple Mail.",
 5 |   "main": "index.js",
 6 |   "scripts": {
 7 |     "test": "echo \"Error: no test specified\" && exit 1",
 8 |     "start": "node index.js"
 9 |   },
10 |   "engines": {
11 |     "node": ">=4.0.0"
12 |   },
13 |   "repository": {
14 |     "type": "git",
15 |     "url": "git+https://github.com/monogramm/autodiscover-email-settings.git"
16 |   },
17 |   "author": "Monogramm",
18 |   "license": "MIT",
19 |   "bugs": {
20 |     "url": "https://github.com/monogramm/autodiscover-email-settings/issues"
21 |   },
22 |   "homepage": "https://github.com/monogramm/autodiscover-email-settings#readme",
23 |   "keywords": [
24 |     "monogramm",
25 |     "autoconfigure",
26 |     "autoconf",
27 |     "autodiscover",
28 |     "outlook",
29 |     "thunderbird",
30 |     "apple mail",
31 |     "imap",
32 |     "smtp",
33 |     "ldap"
34 |   ],
35 |   "dependencies": {
36 |     "koa": "^1.0.0",
37 |     "koa-buddy": "^0.1.0",
38 |     "koa-router": "^5.1.2",
39 |     "koa-swig": "^2.0.0",
40 |     "minimist": "^1.2.5",
41 |     "qs": "^6.9.3"
42 |   }
43 | }
44 | 


--------------------------------------------------------------------------------
/autodiscover/settings.js:
--------------------------------------------------------------------------------
 1 | module.exports = {
 2 | 	info: {
 3 | 		name: process.env.COMPANY_NAME,
 4 | 		url: process.env.SUPPORT_URL
 5 | 	},
 6 | 	domain: process.env.DOMAIN,
 7 | 	imap: {
 8 | 		host: process.env.IMAP_HOST,
 9 | 		port: process.env.IMAP_PORT,
10 | 		socket: process.env.IMAP_SOCKET
11 | 	},
12 | 	pop: {
13 | 		host: process.env.POP_HOST,
14 | 		port: process.env.POP_PORT,
15 | 		socket: process.env.POP_SOCKET
16 | 	},
17 | 	smtp: {
18 | 		host: process.env.SMTP_HOST,
19 | 		port: process.env.SMTP_PORT,
20 | 		socket: process.env.SMTP_SOCKET
21 | 	},
22 | 	ldap: {
23 | 		host: process.env.LDAP_HOST,
24 | 		port: process.env.LDAP_PORT,
25 | 		socket: process.env.LDAP_SOCKET,
26 | 		base: process.env.LDAP_BASE,
27 | 		userfield: process.env.LDAP_USER_FIELD,
28 | 		usersbase: process.env.LDAP_USER_BASE,
29 | 		searchfilter: process.env.LDAP_SEARCH
30 | 	},
31 | 	mobile: {
32 | 		identifier: process.env.PROFILE_IDENTIFIER,
33 | 		uuid: process.env.PROFILE_UUID,
34 | 		mail: {
35 | 			uuid: process.env.MAIL_UUID,
36 | 		},
37 | 		ldap: {
38 | 			uuid: process.env.LDAP_UUID,
39 | 		}
40 | 	}
41 | };
42 | 


--------------------------------------------------------------------------------
/autodiscover/views/autoconfig.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <clientConfig version="1.1">
 3 | 	<emailProvider id="{{domain}}">
 4 | 	    <domain>{{domain}}</domain>
 5 | 
 6 | 	    <displayName>{{info.name}} Email</displayName>
 7 | 	    <displayShortName>%EMAILLOCALPART%</displayShortName>
 8 | 
 9 | 		{%- if imap.host %}
10 | 	    <incomingServer type="imap">
11 | 			<hostname>{{imap.host}}</hostname>
12 | 			<port>{{imap.port}}</port>
13 | 			<socketType>{{imap.socket}}</socketType>
14 | 			<authentication>password-cleartext</authentication>
15 | 			<username>%EMAILADDRESS%</username>
16 | 		</incomingServer>
17 | 		{% endif -%}
18 | 
19 | 		{%- if pop.host %}
20 | 	    <incomingServer type="pop3">
21 | 			<hostname>{{pop.host}}</hostname>
22 | 			<port>{{pop.port}}</port>
23 | 			<socketType>{{pop.socket}}</socketType>
24 | 			<authentication>password-cleartext</authentication>
25 | 			<username>%EMAILADDRESS%</username>
26 | 		</incomingServer>
27 | 		{% endif -%}
28 | 
29 | 		{%- if smtp.host %}
30 | 	    <outgoingServer type="smtp">
31 | 			<hostname>{{smtp.host}}</hostname>
32 | 			<port>{{smtp.port}}</port>
33 | 			<socketType>{{smtp.socket}}</socketType>
34 | 			<authentication>password-cleartext</authentication>
35 | 			<username>%EMAILADDRESS%</username>
36 | 	    </outgoingServer>
37 | 		{% endif -%}
38 | 
39 | 		<documentation url="{{info.url}}">
40 | 			<descr lang="en">Generic settings page</descr>
41 | 			<descr lang="fr">Paramètres généraux</descr>
42 | 			<descr lang="es">Configuraciones genéricas</descr>
43 | 			<descr lang="de">Allgemeine Beschreibung der Einstellungen</descr>
44 | 			<descr lang="ru">Страница общих настроек</descr>
45 | 		</documentation>
46 | 	</emailProvider>
47 | </clientConfig>
48 | 


--------------------------------------------------------------------------------
/autodiscover/views/autodiscover.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8" ?>
 2 | <Autodiscover xmlns="http://schemas.microsoft.com/exchange/autodiscover/responseschema/2006">
 3 | 	<Response xmlns="{{schema}}">
 4 | 		<User>
 5 | 			<DisplayName>{{info.name}} Email</DisplayName>
 6 | 		</User>
 7 | 
 8 | 		{%- if imap.host %}
 9 | 		<Account>
10 | 			<AccountType>email</AccountType>
11 | 			<Action>settings</Action>
12 | 			<ServiceHome>{{info.url}}</ServiceHome>
13 | 
14 | 			<Protocol>
15 | 				<Type>IMAP</Type>
16 | 				<TTL>1</TTL>
17 | 
18 | 				<Server>{{imap.host}}</Server>
19 | 				<Port>{{imap.port}}</Port>
20 | 
21 | 				<LoginName>{{email}}</LoginName>
22 | 
23 | 				<DomainRequired>on</DomainRequired>
24 | 				<DomainName>{{domain}}</DomainName>
25 | 
26 | 				<SPA>off</SPA>
27 | 				<Encryption>{{imapenc}}</Encryption>
28 | 				<AuthRequired>on</AuthRequired>
29 | 			</Protocol>
30 | 		</Account>
31 | 		{% endif -%}
32 | 
33 | 		{%- if pop.host %}
34 | 		<Account>
35 | 			<AccountType>email</AccountType>
36 | 			<Action>settings</Action>
37 | 			<ServiceHome>{{info.url}}</ServiceHome>
38 | 
39 | 			<Protocol>
40 | 				<Type>POP</Type>
41 | 				<TTL>1</TTL>
42 | 
43 | 				<Server>{{pop.host}}</Server>
44 | 				<Port>{{pop.port}}</Port>
45 | 
46 | 				<LoginName>{{email}}</LoginName>
47 | 
48 | 				<DomainRequired>on</DomainRequired>
49 | 				<DomainName>{{domain}}</DomainName>
50 | 
51 | 				<SPA>off</SPA>
52 | 				<Encryption>{{popenc}}</Encryption>
53 | 				<AuthRequired>on</AuthRequired>
54 | 			</Protocol>
55 | 		</Account>
56 | 		{% endif -%}
57 | 
58 | 		{%- if smtp.host %}
59 | 		<Account>
60 | 			<AccountType>email</AccountType>
61 | 			<Action>settings</Action>
62 | 			<ServiceHome>{{info.url}}</ServiceHome>
63 | 
64 | 			<Protocol>
65 | 				<Type>SMTP</Type>
66 | 				<TTL>1</TTL>
67 | 
68 | 				<Server>{{smtp.host}}</Server>
69 | 				<Port>{{smtp.port}}</Port>
70 | 
71 | 				<LoginName>{{email}}</LoginName>
72 | 
73 | 				<DomainRequired>on</DomainRequired>
74 | 				<DomainName>{{domain}}</DomainName>
75 | 
76 | 				<SPA>off</SPA>
77 | 				<Encryption>{{smtpenc}}</Encryption>
78 | 				<AuthRequired>on</AuthRequired>
79 | 			</Protocol>
80 | 		</Account>
81 | 		{% endif -%}
82 | 	</Response>
83 | </Autodiscover>
84 | 


--------------------------------------------------------------------------------
/autodiscover/views/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aqeltech/Dockerised-GUI-Mailserver/5d747e05a7fc4f86fb9826dab5a6a0b6e0a04c83/autodiscover/views/favicon.ico


--------------------------------------------------------------------------------
/autodiscover/views/index.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html>
  2 | <html>
  3 | 
  4 | <head>
  5 |     <meta charset="UTF-8" />
  6 |     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  7 | 
  8 |     <meta name="description" content="{{info.name}} Email Settings">
  9 |     <meta name="author" content="{{info.name}}">
 10 | 
 11 |     <title>{{info.name}}</title>
 12 | 
 13 |     <link rel="shortcut icon" href="favicon.ico" />
 14 | 
 15 |     <!-- Bootstrap core CSS -->
 16 |     <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css"
 17 |         integrity="sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh"
 18 |         crossorigin="anonymous">
 19 | 
 20 |     <style>
 21 |         :root {
 22 |             --input-padding-x: .75rem;
 23 |             --input-padding-y: .75rem;
 24 |         }
 25 | 
 26 |         html {
 27 |             scroll-behavior: smooth;
 28 |         }
 29 | 
 30 |         body {
 31 |             padding-top: 3.5rem;
 32 |             position: relative;
 33 | 
 34 |             transition: background-color .1s ease-in-out, color .1s ease-in-out;
 35 |         }
 36 | 
 37 |         body.dark {
 38 |             background-color: #222;
 39 |             color: #fcfcfc;
 40 |         }
 41 | 
 42 |         .dark .card,
 43 |         .dark .jumbotron {
 44 |             background-color: #333;
 45 |             border-color: rgba(255, 255, 255, 0.13);
 46 |         }
 47 | 
 48 |         .dark hr {
 49 |             border-top: 1px solid rgba(255, 255, 255, 0.13);
 50 |         }
 51 | 
 52 |         .dark .text-dark {
 53 |             color: #fff !important;
 54 |         }
 55 | 
 56 |         .dark a.text-dark:focus,
 57 |         .dark a.text-dark:hover {
 58 |             color: #fff !important;
 59 |         }
 60 | 
 61 |         svg.theme-switch {
 62 |             fill: #fc0;
 63 |         }
 64 | 
 65 |         svg.theme-switch .shadow {
 66 |             fill: #343a4000;
 67 |             transition: fill .1s ease-in-out, content .1s ease-in-out;
 68 |         }
 69 | 
 70 |         .dark svg.theme-switch {
 71 |             fill: #cac9c5;
 72 |         }
 73 | 
 74 |         .dark svg.theme-switch .shadow {
 75 |             fill: #343a40;
 76 |         }
 77 | 
 78 |         .form-mobileconfig {
 79 |             max-width: 420px;
 80 |             padding: 15px;
 81 |         }
 82 | 
 83 |         .form-label-group {
 84 |             position: relative;
 85 |             margin-bottom: 1rem;
 86 |         }
 87 | 
 88 |         .form-label-group>input,
 89 |         .form-label-group>label {
 90 |             padding: var(--input-padding-y) var(--input-padding-x);
 91 |         }
 92 | 
 93 |         .form-label-group>label {
 94 |             position: absolute;
 95 |             top: 0;
 96 |             left: 0;
 97 |             display: block;
 98 |             width: 100%;
 99 |             margin-bottom: 0;
100 |             /* Override default `<label>` margin */
101 |             line-height: 1.5;
102 |             color: #495057;
103 |             border: 1px solid transparent;
104 |             border-radius: .25rem;
105 |             transition: all .1s ease-in-out;
106 |         }
107 | 
108 |         .form-label-group input::-webkit-input-placeholder {
109 |             color: transparent;
110 |         }
111 | 
112 |         .form-label-group input:-ms-input-placeholder {
113 |             color: transparent;
114 |         }
115 | 
116 |         .form-label-group input::-ms-input-placeholder {
117 |             color: transparent;
118 |         }
119 | 
120 |         .form-label-group input::-moz-placeholder {
121 |             color: transparent;
122 |         }
123 | 
124 |         .form-label-group input::placeholder {
125 |             color: transparent;
126 |         }
127 | 
128 |         .form-label-group input:not(:placeholder-shown) {
129 |             padding-top: calc(var(--input-padding-y) + var(--input-padding-y) * (2 / 3));
130 |             padding-bottom: calc(var(--input-padding-y) / 3);
131 |         }
132 | 
133 |         .form-label-group input:not(:placeholder-shown)~label {
134 |             padding-top: calc(var(--input-padding-y) / 3);
135 |             padding-bottom: calc(var(--input-padding-y) / 3);
136 |             font-size: 12px;
137 |             color: #777;
138 |         }
139 | 
140 |         .form-label-group input {
141 |             cursor: text;
142 |             transition: all .1s ease-in-out;
143 |         }
144 | 
145 |         .form-label-group input:invalid {
146 |             border: 1px solid #dc35469d;
147 |         }
148 | 
149 |         .form-label-group input:focus:invalid {
150 |             box-shadow: 0px 0px 3px 2px #dc35469d;
151 |         }
152 | 
153 |         .form-label-group input:focus:valid {
154 |             border: 1px solid #28a7459d;
155 |             box-shadow: 0px 0px 3px 2px #28a7459d;
156 |         }
157 |     </style>
158 | 
159 |     <script>
160 |         function fallbackCopyTextToClipboard(text) {
161 |             var textArea = document.createElement("textarea");
162 |             textArea.value = text;
163 |             document.body.appendChild(textArea);
164 |             textArea.focus();
165 |             textArea.select();
166 | 
167 |             try {
168 |                 var successful = document.execCommand('copy');
169 |                 var msg = successful ? 'successful' : 'unsuccessful';
170 |                 console.log('Fallback: Copying text command was ' + msg);
171 |             } catch (err) {
172 |                 console.error('Fallback: Oops, unable to copy', err);
173 |             }
174 | 
175 |             document.body.removeChild(textArea);
176 |         }
177 |         function copyTextToClipboard(text) {
178 |             if (!navigator.clipboard) {
179 |                 fallbackCopyTextToClipboard(text);
180 |                 return;
181 |             }
182 |             navigator.clipboard.writeText(text).then(function () {
183 |                 console.log('Async: Copying to clipboard was successful!');
184 |             }, function (err) {
185 |                 console.error('Async: Could not copy text: ', err);
186 |             });
187 |         }
188 | 
189 |         function copy(domId) {
190 |             let dom = document.getElementById(domId);
191 |             if (dom) {
192 |                 copyTextToClipboard(dom.innerText);
193 |             }
194 |         }
195 | 
196 |         function getCookie(cname) {
197 |             var name = cname + '=';
198 |             var decodedCookie = decodeURIComponent(document.cookie);
199 |             var ca = decodedCookie.split(';');
200 |             for (var i = 0; i < ca.length; i++) {
201 |                 var c = ca[i];
202 |                 while (c.charAt(0) == ' ') {
203 |                     c = c.substring(1);
204 |                 }
205 |                 if (c.indexOf(name) == 0) {
206 |                     return c.substring(name.length, c.length);
207 |                 }
208 |             }
209 |             return null;
210 |         }
211 | 
212 |         function setTheme(theme) {
213 |             // One month duration
214 |             const defaultDuration = 1000 * 60 * 60 * 24 * 31;
215 |             const expiry = new Date(Date.now() + defaultDuration);
216 |             const mainThemeCookie = "main_theme";
217 |             document.cookie = mainThemeCookie + '=' + theme + '; expires=' + expiry.toGMTString();
218 |             document.getElementById('body').className = theme;
219 |         }
220 | 
221 |         function switchTheme() {
222 |             var forceSide = document.getElementById('body').className;
223 | 
224 |             if (forceSide === 'light') {
225 |                 console.log('Come to the dark side! We have cookies!');
226 |                 forceSide = 'dark';
227 |             } else {
228 |                 console.log('I find your lack of faith disturbing.');
229 |                 forceSide = 'light';
230 |             }
231 | 
232 |             setTheme(forceSide);
233 |         }
234 |     </script>
235 | </head>
236 | 
237 | <body id="body" data-spy="scroll" data-target="#navbar-main" class="light">
238 |     <nav id="navbar-main" class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
239 |         <a class="navbar-brand" href="#">{{info.name}}</a>
240 |         <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsDefault"
241 |             aria-controls="navbarsDefault" aria-expanded="false" aria-label="Toggle navigation">
242 |             <span class="navbar-toggler-icon"></span>
243 |         </button>
244 | 
245 |         <div class="collapse navbar-collapse" id="navbarsDefault">
246 |             <ul class="navbar-nav mr-autonav-tabs mr-auto" role="tablist">
247 |                 <li class="nav-item">
248 |                     <a class="nav-link" href="#automatic">Automatic</a>
249 |                 </li>
250 |                 {% if mobile.identifier %}<li class="nav-item">
251 |                     <a class="nav-link" href="#mobileconfig">iOS</a>
252 |                 </li>{% endif %}
253 |                 <li class="nav-item">
254 |                     <a class="nav-link" href="#manualconfig">Manual configuration</a>
255 |                 </li>
256 |             </ul>
257 | 
258 |             <div class="mt-2 mt-md-0 align-items-center">
259 |                 <a class="text-muted" href="#" onclick="switchTheme();">
260 |                     <svg xmlns="http://www.w3.org/2000/svg" class="theme-switch" width="30" height="30"
261 |                         stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="mx-3" role="img"
262 |                         viewBox="0 0 24 24" focusable="false">
263 |                         <title>Switch theme</title>
264 |                         <circle cx="12.5" cy="12.5" r="10"></circle>
265 |                         <circle cx="5" cy="12.5" r="10" class="shadow"></circle>
266 |                     </svg>
267 |                 </a>
268 |             </div>
269 |         </div>
270 |     </nav>
271 | 
272 |     <main role="main">
273 |         <div class="jumbotron">
274 |             <div class="container">
275 |                 <h1 class="display-4">{{info.name}} generic settings</h1>
276 |                 <p class="lead">Generic settings support page</p>
277 |                 <p>This is a simple support page for email automatic configuration service.
278 |                     It provides IMAP/POP/SMTP/LDAP Autodiscover capabilities on Microsoft Outlook/Apple Mail, Autoconfig
279 |                     capabilities for Thunderbird, and Configuration Profiles for iOS/Apple Mail.
280 |                 </p>
281 |                 <p><a class="btn btn-primary btn-lg" href="https://github.com/Monogramm/autodiscover-email-settings"
282 |                         target="_blank" role="button">Learn more &raquo</a></p>
283 |             </div>
284 |         </div>
285 | 
286 |         <div class="container">
287 |             <h3 id="automatic" class="h3 font-weight-normal">Automatic settings</h3>
288 | 
289 |             <div class="mb-5">
290 |                 <p>Thanks to the <a href="/mail/config-v1.1.xml">autoconfig</a> and
291 |                     <a href="/autodiscover/autodiscover.xml">autodiscover</a> services,
292 |                     <strong>most of the recent mail clients</strong> (<em>Microsoft Outlook</em>, <em>Apple Mail</em>, 
293 |                     <em>Mozilla Thunderbird</em>, ...) <strong>should automatically be configured</strong> with the
294 |                     recommended settings for this email server just after entering your email address <code>@{{domain}}</code>.</p>
295 | 
296 |                 <p>If you encounter some issues, depending on your situation, you can:</p>
297 |                 <ul>
298 |                     {% if mobile.identifier %}<li>easily configure your Apple Mobile devices (<em>iPhone / iPad</em>) with
299 |                         <a href="#mobileconfig">this simple form</a></li>{% endif %}
300 |                     <li>setup your email application with the <a href="#manualconfig">manual configuration</a></li>
301 |                 </ul>
302 |             </div>
303 | 
304 |             <hr>
305 | 
306 |         </div> <!-- /container -->
307 | 
308 |         {%- if mobile.identifier %}
309 |         <div class="container">
310 |             <h3 id="mobileconfig" class="h3 font-weight-normal">Apple Configuration Profile</h3>
311 | 
312 |             <div class="mb-5">
313 |                 <p>Enter your username or full email address and click the download button to setup your Apple mobile
314 |                     device.</p>
315 | 
316 |                 <form class="form-mobileconfig" action="/email.mobileconfig" method="get">
317 | 
318 |                     <div class="form-label-group">
319 |                         <input type="text" name="email" id="inputId" class="form-control form-control-lg"
320 |                             placeholder="Username or email" required />
321 |                         <label for="inputId">Username or email</label>
322 |                     </div>
323 | 
324 |                     <button class="btn btn-lg btn-primary btn-block" type="submit">Download</button>
325 |                 </form>
326 |             </div>
327 | 
328 |             <hr>
329 | 
330 |         </div> <!-- /container -->
331 |         {% endif -%}
332 | 
333 |         <div class="container">
334 |             <h3 id="manualconfig" class="h3 font-weight-normal">Manual configuration</h3>
335 | 
336 |             <div class="mb-5">
337 |                 <p>Copy the following settings to your email application.</p>
338 | 
339 |                 <div class="row">
340 |                     {%- if imap.host %}
341 |                     <div class="col-md-6">
342 |                         <h5 id="manualconfig-imap">Incoming server (IMAP)</h5>
343 |                         <dl>
344 |                             <dt>Hostname <button type="button"
345 |                                 class="btn btn-outline-secondary btn-sm"
346 |                                 title="Copy IMAP hostname"
347 |                                 onclick="copy('manualconfig-imap-hostname')">Copy</button></dt>
348 |                             <dd id="manualconfig-imap-hostname">{{imap.host}}</dd>
349 | 
350 |                             <dt>Port <button type="button"
351 |                                 class="btn btn-outline-secondary btn-sm"
352 |                                 title="Copy IMAP hostname"
353 |                                 onclick="copy('manualconfig-imap-port')">Copy</button></dt>
354 |                             <dd id="manualconfig-imap-port">{{imap.port}}</dd>
355 | 
356 |                             <dt>Encryption <button type="button"
357 |                                 class="btn btn-outline-secondary btn-sm"
358 |                                 title="Copy IMAP hostname"
359 |                                 onclick="copy('manualconfig-imap-socket')">Copy</button></dt>
360 |                             <dd id="manualconfig-imap-socket">{{imap.socket}}</dd>
361 |                         </dl>
362 |                     </div>
363 |                     {% endif -%}
364 | 
365 |                     {%- if pop.host %}
366 |                     <div class="col-md-6">
367 |                         <h5 id="manualconfig-pop">Incoming server (POP)</h5>
368 |                         <dl>
369 |                             <dt>Hostname <button type="button"
370 |                                 class="btn btn-outline-secondary btn-sm"
371 |                                 title="Copy POP hostname"
372 |                                 onclick="copy('manualconfig-pop-hostname')">Copy</button></dt>
373 |                             <dd id="manualconfig-pop-hostname">{{pop.host}}</dd>
374 | 
375 |                             <dt>Port <button type="button"
376 |                                 class="btn btn-outline-secondary btn-sm"
377 |                                 title="Copy POP hostname"
378 |                                 onclick="copy('manualconfig-pop-port')">Copy</button></dt>
379 |                             <dd id="manualconfig-pop-port">{{pop.port}}</dd>
380 | 
381 |                             <dt>Encryption <button type="button"
382 |                                 class="btn btn-outline-secondary btn-sm"
383 |                                 title="Copy POP hostname"
384 |                                 onclick="copy('manualconfig-pop-socket')">Copy</button></dt>
385 |                             <dd id="manualconfig-pop-socket">{{pop.socket}}</dd>
386 |                         </dl>
387 |                     </div>
388 |                     {% endif -%}
389 |                 </div>
390 | 
391 |                 <div class="row">
392 |                     {%- if smtp.host %}
393 |                     <div class="col-md-6">
394 |                         <h5 id="manualconfig-smtp">Outgoing server (SMTP)</h5>
395 |                         <dl>
396 |                             <dt>Hostname <button type="button"
397 |                                 class="btn btn-outline-secondary btn-sm"
398 |                                 title="Copy IMAP hostname"
399 |                                 onclick="copy('manualconfig-smtp-hostname')">Copy</button></dt>
400 |                             <dd id="manualconfig-smtp-hostname">{{smtp.host}}</dd>
401 | 
402 |                             <dt>Port <button type="button"
403 |                                 class="btn btn-outline-secondary btn-sm"
404 |                                 title="Copy IMAP hostname"
405 |                                 onclick="copy('manualconfig-smtp-port')">Copy</button></dt>
406 |                             <dd id="manualconfig-smtp-port">{{smtp.port}}</dd>
407 | 
408 |                             <dt>Encryption <button type="button"
409 |                                 class="btn btn-outline-secondary btn-sm"
410 |                                 title="Copy IMAP hostname"
411 |                                 onclick="copy('manualconfig-smtp-socket')">Copy</button></dt>
412 |                             <dd id="manualconfig-smtp-socket">{{smtp.socket}}</dd>
413 |                         </dl>
414 |                     </div>
415 |                     {% endif -%}
416 |                 </div>
417 | 
418 |                 {%- if ldap.host %}
419 |                 <p>If your email application supports LDAP contacts, copy the following settings.</p>
420 | 
421 |                 <div class="row">
422 |                     <div class="col-md-12">
423 |                         <h5 id="manualconfig-ldap">Contacts (LDAP)</h5>
424 |                         <dl>
425 |                             <dt>Hostname <button type="button"
426 |                                 class="btn btn-outline-secondary btn-sm"
427 |                                 title="Copy IMAP hostname"
428 |                                 onclick="copy('manualconfig-ldap-hostname')">Copy</button></dt>
429 |                             <dd id="manualconfig-ldap-hostname">{{ldap.host}}</dd>
430 | 
431 |                             <dt>Port <button type="button"
432 |                                 class="btn btn-outline-secondary btn-sm"
433 |                                 title="Copy IMAP hostname"
434 |                                 onclick="copy('manualconfig-ldap-port')">Copy</button></dt>
435 |                             <dd id="manualconfig-ldap-port">{{ldap.port}}</dd>
436 | 
437 |                             <dt>Encryption <button type="button"
438 |                                 class="btn btn-outline-secondary btn-sm"
439 |                                 title="Copy IMAP hostname"
440 |                                 onclick="copy('manualconfig-ldap-socket')">Copy</button></dt>
441 |                             <dd id="manualconfig-ldap-socket">{{ldap.socket}}</dd>
442 | 
443 |                             <dt>Base <button type="button"
444 |                                 class="btn btn-outline-secondary btn-sm"
445 |                                 title="Copy IMAP hostname"
446 |                                 onclick="copy('manualconfig-ldap-base')">Copy</button></dt>
447 |                             <dd id="manualconfig-ldap-base">{{ldap.base}}</dd>
448 | 
449 |                             <dt>Username (replace <code>your.username</code> with your actual username) <button type="button"
450 |                                 class="btn btn-outline-secondary btn-sm"
451 |                                 title="Copy IMAP hostname"
452 |                                 onclick="copy('manualconfig-ldap-username')">Copy</button></dt>
453 |                             <dd id="manualconfig-ldap-username">{{ldap.userfield}}=<code>your.username</code>,{{ldap.usersbase}}</dd>
454 | 
455 |                             <dt>Search Filter <button type="button"
456 |                                 class="btn btn-outline-secondary btn-sm"
457 |                                 title="Copy IMAP hostname"
458 |                                 onclick="copy('manualconfig-ldap-searchfilter')">Copy</button></dt>
459 |                             <dd id="manualconfig-ldap-searchfilter">{{ldap.searchfilter}}</dd>
460 |                         </dl>
461 |                     </div>
462 |                 </div>
463 |                 {% endif -%}
464 |             </div>
465 | 
466 |             <hr>
467 | 
468 |         </div> <!-- /container -->
469 | 
470 |     </main>
471 | 
472 |     <footer class="container">
473 |         <p class="mt-5 mb-3 text-muted text-center">&copy; {{info.name}}</p>
474 |     </footer>
475 | 
476 |     <!-- Bootstrap core JavaScript ================================================== -->
477 |     <script src="https://code.jquery.com/jquery-3.4.1.slim.min.js"
478 |         integrity="sha384-J6qa4849blE2+poT4WnyKhv5vZF5SrPo0iEjwBvKU7imGFAV0wwj1yYfoRSJoZ+n"
479 |         crossorigin="anonymous"></script>
480 |     <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js"
481 |         integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo"
482 |         crossorigin="anonymous"></script>
483 |     <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js"
484 |         integrity="sha384-wfSDF2E50Y2D1uUdj0O3uMBJnjuUD4Ih7YwaYd1iqfktj0Uod8GCExl3Og8ifwB6"
485 |         crossorigin="anonymous"></script>
486 | 
487 |     <!-- Custom JavaScript ================================================== -->
488 |     <script>
489 |         const mainThemeCookie = "main_theme";
490 |         let bodyClass;
491 |         if (document.cookie) {
492 |             bodyClass = getCookie(mainThemeCookie);
493 |         }
494 |         if (!!!bodyClass) {
495 |             bodyClass = "light";
496 |         }
497 |         document.getElementById('body').className = bodyClass;
498 |     </script>
499 | </body>
500 | 
501 | </html>


--------------------------------------------------------------------------------
/autodiscover/views/mobileconfig.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
  3 | <plist version="1.0">
  4 | <dict>
  5 | 	<key>HasRemovalPasscode</key>
  6 | 	<false/>
  7 | 	<key>PayloadContent</key>
  8 | 	<array>
  9 | {% if imap.host || pop.host %}
 10 | 		<dict>
 11 | 			<key>EmailAccountDescription</key>
 12 | 			<string>{{email}}</string>
 13 | 			<key>EmailAccountName</key>
 14 | 			<string>{{email}}</string>
 15 | 			<key>EmailAccountType</key>
 16 | 			<string>{% if imap.host %}EmailTypeIMAP{% else %}EmailTypePOP{% endif %}</string>
 17 | 			<key>EmailAddress</key>
 18 | 			<string>{{email}}</string>
 19 | 			<key>IncomingMailServerAuthentication</key>
 20 | 			<string>EmailAuthPassword</string>
 21 | 			<key>IncomingMailServerHostName</key>
 22 | 			<string>{% if imap.host %}{{imap.host}}{% else %}{{pop.host}}{% endif %}</string>
 23 | 			<key>IncomingMailServerPortNumber</key>
 24 | 			<integer>{% if imap.host %}{{imap.port}}{% else %}{{pop.port}}{% endif %}</integer>
 25 | 			<key>IncomingMailServerUseSSL</key>
 26 | 			<{%- if imap.host %}{{imapssl}}{% else %}{{popssl}}{% endif -%}/>
 27 | 			<key>IncomingMailServerUsername</key>
 28 | 			<string>{{email}}</string>
 29 | 			<key>OutgoingPasswordSameAsIncomingPassword</key>
 30 | 			<true/>
 31 | 			<key>OutgoingMailServerAuthentication</key>
 32 | 			<string>EmailAuthPassword</string>
 33 | 			<key>OutgoingMailServerHostName</key>
 34 | 			<string>{{smtp.host}}</string>
 35 | 			<key>OutgoingMailServerPortNumber</key>
 36 | 			<integer>{{smtp.port}}</integer>
 37 | 			<key>OutgoingMailServerUseSSL</key>
 38 | 			<{{smtpssl}}/>
 39 | 			<key>OutgoingMailServerUsername</key>
 40 | 			<string>{{email}}</string>
 41 | 			<key>SMIMEEnabled</key>
 42 | 			<false/>
 43 | 			<key>SMIMEEnablePerMessageSwitch</key>
 44 | 			<false/>
 45 | 			<key>SMIMEEnableEncryptionPerMessageSwitch</key>
 46 | 			<false/>
 47 | 			<key>disableMailRecentsSyncing</key>
 48 | 			<false/>
 49 | 			<key>PayloadDescription</key>
 50 | 			<string>{{info.name}} Email</string>
 51 | 			<key>PayloadDisplayName</key>
 52 | 			<string>{{email}}</string>
 53 | 			<key>PayloadIdentifier</key>
 54 | 			<string>{{mobile.identifier}}.com.apple.mail.managed.{{mobile.mail.uuid}}</string>
 55 | 			<key>PayloadType</key>
 56 | 			<string>com.apple.mail.managed</string>
 57 | 			<key>PayloadUUID</key>
 58 | 			<string>{{mobile.mail.uuid}}</string>
 59 | 			<key>PayloadVersion</key>
 60 | 			<real>1</real>
 61 | 		</dict>
 62 | {% endif %}
 63 | {% if ldap.host %}
 64 | 		<dict>
 65 | 			<key>LDAPAccountDescription</key>
 66 | 			<string>{{info.name}} LDAP</string>
 67 | 			<key>LDAPAccountHostName</key>
 68 | 			<string>{{ldap.host}}</string>
 69 | 			<key>LDAPAccountUseSSL</key>
 70 | 			<{{ldapssl}}/>
 71 | 			<key>LDAPAccountUserName</key>
 72 | 			<string>{{ldap.userfield}}={{username}},{{ldap.usersbase}}</string>
 73 | 			<key>LDAPSearchSettings</key>
 74 | 			<array>
 75 | 				<dict>
 76 | 					<key>LDAPSearchSettingDescription</key>
 77 | 					<string>{{info.name}} Contacts</string>
 78 | 					<key>LDAPSearchSettingSearchBase</key>
 79 | 					<string>{{ldap.base}}</string>
 80 | 					<key>LDAPSearchSettingScope</key>
 81 | 					<string>LDAPSearchSettingScopeSubtree</string>
 82 | 				</dict>
 83 | 			</array>
 84 | 			<key>PayloadDescription</key>
 85 | 			<string>{{info.name}} LDAP</string>
 86 | 			<key>PayloadDisplayName</key>
 87 | 			<string>{{info.name}} Contacts</string>
 88 | 			<key>PayloadIdentifier</key>
 89 | 			<string>{{mobile.identifier}}.com.apple.ldap.account.{{mobile.ldap.uuid}}</string>
 90 | 			<key>PayloadType</key>
 91 | 			<string>com.apple.ldap.account</string>
 92 | 			<key>PayloadUUID</key>
 93 | 			<string>{{mobile.ldap.uuid}}</string>
 94 | 			<key>PayloadVersion</key>
 95 | 			<real>1</real>
 96 | 		</dict>
 97 | {% endif %}
 98 | 	</array>
 99 | 	<key>PayloadDescription</key>
100 | 	<string>{{info.name}}</string>
101 | 	<key>PayloadDisplayName</key>
102 | 	<string>{{info.name}}</string>
103 | 	<key>PayloadIdentifier</key>
104 | 	<string>{{mobile.identifier}}</string>
105 | 	<key>PayloadOrganization</key>
106 | 	<string>{{domain}}</string>
107 | 	<key>PayloadRemovalDisallowed</key>
108 | 	<false/>
109 | 	<key>PayloadType</key>
110 | 	<string>Configuration</string>
111 | 	<key>PayloadUUID</key>
112 | 	<string>{{mobile.uuid}}</string>
113 | 	<key>PayloadVersion</key>
114 | 	<integer>2</integer>
115 | </dict>
116 | </plist>
117 | 


--------------------------------------------------------------------------------
/autodiscover/yarn.lock:
--------------------------------------------------------------------------------
  1 | # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
  2 | # yarn lockfile v1
  3 | 
  4 | 
  5 | accepts@^1.2.2:
  6 |   version "1.3.7"
  7 |   resolved "https://registry.yarnpkg.com/accepts/-/accepts-1.3.7.tgz#531bc726517a3b2b41f850021c6cc15eaab507cd"
  8 |   integrity sha512-Il80Qs2WjYlJIBNzNkK6KYqlVMTbZLXgHx2oT0pU/fjRHyEp+PEfEPY0R3WCwAGVOtauxh1hOxNgIf5bv7dQpA==
  9 |   dependencies:
 10 |     mime-types "~2.1.24"
 11 |     negotiator "0.6.2"
 12 | 
 13 | align-text@^0.1.1, align-text@^0.1.3:
 14 |   version "0.1.4"
 15 |   resolved "https://registry.yarnpkg.com/align-text/-/align-text-0.1.4.tgz#0cd90a561093f35d0a99256c22b7069433fad117"
 16 |   integrity sha1-DNkKVhCT810KmSVsIrcGlDP60Rc=
 17 |   dependencies:
 18 |     kind-of "^3.0.2"
 19 |     longest "^1.0.1"
 20 |     repeat-string "^1.5.2"
 21 | 
 22 | any-promise@^1.0.0, any-promise@^1.1.0:
 23 |   version "1.3.0"
 24 |   resolved "https://registry.yarnpkg.com/any-promise/-/any-promise-1.3.0.tgz#abc6afeedcea52e809cdc0376aed3ce39635d17f"
 25 |   integrity sha1-q8av7tzqUugJzcA3au0845Y10X8=
 26 | 
 27 | async@~0.2.6:
 28 |   version "0.2.10"
 29 |   resolved "https://registry.yarnpkg.com/async/-/async-0.2.10.tgz#b6bbe0b0674b9d719708ca38de8c237cb526c3d1"
 30 |   integrity sha1-trvgsGdLnXGXCMo43owjfLUmw9E=
 31 | 
 32 | bluebird@^2.3.2:
 33 |   version "2.11.0"
 34 |   resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-2.11.0.tgz#534b9033c022c9579c56ba3b3e5a5caafbb650e1"
 35 |   integrity sha1-U0uQM8AiyVecVro7Plpcqvu2UOE=
 36 | 
 37 | bytes@1.0.0:
 38 |   version "1.0.0"
 39 |   resolved "https://registry.yarnpkg.com/bytes/-/bytes-1.0.0.tgz#3569ede8ba34315fab99c3e92cb04c7220de1fa8"
 40 |   integrity sha1-NWnt6Lo0MV+rmcPpLLBMciDeH6g=
 41 | 
 42 | camelcase@^1.0.2:
 43 |   version "1.2.1"
 44 |   resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-1.2.1.tgz#9bb5304d2e0b56698b2c758b08a3eaa9daa58a39"
 45 |   integrity sha1-m7UwTS4LVmmLLHWLCKPqqdqlijk=
 46 | 
 47 | center-align@^0.1.1:
 48 |   version "0.1.3"
 49 |   resolved "https://registry.yarnpkg.com/center-align/-/center-align-0.1.3.tgz#aa0d32629b6ee972200411cbd4461c907bc2b7ad"
 50 |   integrity sha1-qg0yYptu6XIgBBHL1EYckHvCt60=
 51 |   dependencies:
 52 |     align-text "^0.1.3"
 53 |     lazy-cache "^1.0.3"
 54 | 
 55 | cliui@^2.1.0:
 56 |   version "2.1.0"
 57 |   resolved "https://registry.yarnpkg.com/cliui/-/cliui-2.1.0.tgz#4b475760ff80264c762c3a1719032e91c7fea0d1"
 58 |   integrity sha1-S0dXYP+AJkx2LDoXGQMukcf+oNE=
 59 |   dependencies:
 60 |     center-align "^0.1.1"
 61 |     right-align "^0.1.1"
 62 |     wordwrap "0.0.2"
 63 | 
 64 | co-body@^1.0.0:
 65 |   version "1.2.0"
 66 |   resolved "https://registry.yarnpkg.com/co-body/-/co-body-1.2.0.tgz#2a01b3b7b9c0a5c0fab2f6e6e4642cf878e070ab"
 67 |   integrity sha1-KgGzt7nApcD6svbm5GQs+HjgcKs=
 68 |   dependencies:
 69 |     qs "~2.3.3"
 70 |     raw-body "~1.3.3"
 71 | 
 72 | co@^4.0.2, co@^4.4.0, co@^4.6.0:
 73 |   version "4.6.0"
 74 |   resolved "https://registry.yarnpkg.com/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184"
 75 |   integrity sha1-bqa989hTrlTMuOR7+gvz+QMfsYQ=
 76 | 
 77 | composition@^2.1.1:
 78 |   version "2.3.0"
 79 |   resolved "https://registry.yarnpkg.com/composition/-/composition-2.3.0.tgz#742805374cab550c520a33662f5a732e0208d6f2"
 80 |   integrity sha1-dCgFN0yrVQxSCjNmL1pzLgII1vI=
 81 |   dependencies:
 82 |     any-promise "^1.1.0"
 83 |     co "^4.0.2"
 84 | 
 85 | content-disposition@~0.5.0:
 86 |   version "0.5.3"
 87 |   resolved "https://registry.yarnpkg.com/content-disposition/-/content-disposition-0.5.3.tgz#e130caf7e7279087c5616c2007d0485698984fbd"
 88 |   integrity sha512-ExO0774ikEObIAEV9kDo50o+79VCUdEB6n6lzKgGwupcVeRlhrj3qGAfwq8G6uBJjkqLrhT0qEYFcWng8z1z0g==
 89 |   dependencies:
 90 |     safe-buffer "5.1.2"
 91 | 
 92 | content-type@^1.0.0:
 93 |   version "1.0.4"
 94 |   resolved "https://registry.yarnpkg.com/content-type/-/content-type-1.0.4.tgz#e138cc75e040c727b1966fe5e5f8c9aee256fe3b"
 95 |   integrity sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA==
 96 | 
 97 | cookies@~0.8.0:
 98 |   version "0.8.0"
 99 |   resolved "https://registry.yarnpkg.com/cookies/-/cookies-0.8.0.tgz#1293ce4b391740a8406e3c9870e828c4b54f3f90"
100 |   integrity sha512-8aPsApQfebXnuI+537McwYsDtjVxGm8gTIzQI3FDW6t5t/DAhERxtnbEPN/8RX+uZthoz4eCOgloXaE5cYyNow==
101 |   dependencies:
102 |     depd "~2.0.0"
103 |     keygrip "~1.1.0"
104 | 
105 | core-util-is@~1.0.0:
106 |   version "1.0.2"
107 |   resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.2.tgz#b5fd54220aa2bc5ab57aab7140c940754503c1a7"
108 |   integrity sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=
109 | 
110 | debug@^2.2.0, debug@^2.6.9, debug@^2.x:
111 |   version "2.6.9"
112 |   resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f"
113 |   integrity sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==
114 |   dependencies:
115 |     ms "2.0.0"
116 | 
117 | decamelize@^1.0.0:
118 |   version "1.2.0"
119 |   resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290"
120 |   integrity sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=
121 | 
122 | deep-equal@~1.0.1:
123 |   version "1.0.1"
124 |   resolved "https://registry.yarnpkg.com/deep-equal/-/deep-equal-1.0.1.tgz#f5d260292b660e084eff4cdbc9f08ad3247448b5"
125 |   integrity sha1-9dJgKStmDghO/0zbyfCK0yR0SLU=
126 | 
127 | delegates@^1.0.0:
128 |   version "1.0.0"
129 |   resolved "https://registry.yarnpkg.com/delegates/-/delegates-1.0.0.tgz#84c6e159b81904fdca59a0ef44cd870d31250f9a"
130 |   integrity sha1-hMbhWbgZBP3KWaDvRM2HDTElD5o=
131 | 
132 | depd@~1.1.2:
133 |   version "1.1.2"
134 |   resolved "https://registry.yarnpkg.com/depd/-/depd-1.1.2.tgz#9bcd52e14c097763e749b274c4346ed2e560b5a9"
135 |   integrity sha1-m81S4UwJd2PnSbJ0xDRu0uVgtak=
136 | 
137 | depd@~2.0.0:
138 |   version "2.0.0"
139 |   resolved "https://registry.yarnpkg.com/depd/-/depd-2.0.0.tgz#b696163cc757560d09cf22cc8fad1571b79e76df"
140 |   integrity sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==
141 | 
142 | destroy@^1.0.3:
143 |   version "1.0.4"
144 |   resolved "https://registry.yarnpkg.com/destroy/-/destroy-1.0.4.tgz#978857442c44749e4206613e37946205826abd80"
145 |   integrity sha1-l4hXRCxEdJ5CBmE+N5RiBYJqvYA=
146 | 
147 | ee-first@1.1.1:
148 |   version "1.1.1"
149 |   resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d"
150 |   integrity sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=
151 | 
152 | error-inject@~1.0.0:
153 |   version "1.0.0"
154 |   resolved "https://registry.yarnpkg.com/error-inject/-/error-inject-1.0.0.tgz#e2b3d91b54aed672f309d950d154850fa11d4f37"
155 |   integrity sha1-4rPZG1Su1nLzCdlQ0VSFD6EdTzc=
156 | 
157 | escape-html@~1.0.1:
158 |   version "1.0.3"
159 |   resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988"
160 |   integrity sha1-Aljq5NPQwJdN4cFpGI7wBR0dGYg=
161 | 
162 | fresh@^0.5.2:
163 |   version "0.5.2"
164 |   resolved "https://registry.yarnpkg.com/fresh/-/fresh-0.5.2.tgz#3d8cadd90d976569fa835ab1f8e4b23a105605a7"
165 |   integrity sha1-PYyt2Q2XZWn6g1qx+OSyOhBWBac=
166 | 
167 | http-assert@^1.1.0:
168 |   version "1.4.1"
169 |   resolved "https://registry.yarnpkg.com/http-assert/-/http-assert-1.4.1.tgz#c5f725d677aa7e873ef736199b89686cceb37878"
170 |   integrity sha512-rdw7q6GTlibqVVbXr0CKelfV5iY8G2HqEUkhSk297BMbSpSL8crXC+9rjKoMcZZEsksX30le6f/4ul4E28gegw==
171 |   dependencies:
172 |     deep-equal "~1.0.1"
173 |     http-errors "~1.7.2"
174 | 
175 | http-errors@^1.2.8, http-errors@^1.3.1, http-errors@~1.7.2:
176 |   version "1.7.3"
177 |   resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-1.7.3.tgz#6c619e4f9c60308c38519498c14fbb10aacebb06"
178 |   integrity sha512-ZTTX0MWrsQ2ZAhA1cejAwDLycFsd7I7nVtnkT3Ol0aqodaKW+0CTZDQ1uBv5whptCnc8e8HeRRJxRs0kmm/Qfw==
179 |   dependencies:
180 |     depd "~1.1.2"
181 |     inherits "2.0.4"
182 |     setprototypeof "1.1.1"
183 |     statuses ">= 1.5.0 < 2"
184 |     toidentifier "1.0.0"
185 | 
186 | iconv-lite@0.4.8:
187 |   version "0.4.8"
188 |   resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.8.tgz#c6019a7595f2cefca702eab694a010bcd9298d20"
189 |   integrity sha1-xgGadZXyzvynAuq2lKAQvNkpjSA=
190 | 
191 | inherits@2.0.4, inherits@~2.0.1:
192 |   version "2.0.4"
193 |   resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c"
194 |   integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==
195 | 
196 | is-buffer@^1.1.5:
197 |   version "1.1.6"
198 |   resolved "https://registry.yarnpkg.com/is-buffer/-/is-buffer-1.1.6.tgz#efaa2ea9daa0d7ab2ea13a97b2b8ad51fefbe8be"
199 |   integrity sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w==
200 | 
201 | isarray@0.0.1:
202 |   version "0.0.1"
203 |   resolved "https://registry.yarnpkg.com/isarray/-/isarray-0.0.1.tgz#8a18acfca9a8f4177e09abfc6038939b05d1eedf"
204 |   integrity sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=
205 | 
206 | keygrip@~1.1.0:
207 |   version "1.1.0"
208 |   resolved "https://registry.yarnpkg.com/keygrip/-/keygrip-1.1.0.tgz#871b1681d5e159c62a445b0c74b615e0917e7226"
209 |   integrity sha512-iYSchDJ+liQ8iwbSI2QqsQOvqv58eJCEanyJPJi+Khyu8smkcKSFUCbPwzFcL7YVtZ6eONjqRX/38caJ7QjRAQ==
210 |   dependencies:
211 |     tsscmp "1.0.6"
212 | 
213 | kind-of@^3.0.2:
214 |   version "3.2.2"
215 |   resolved "https://registry.yarnpkg.com/kind-of/-/kind-of-3.2.2.tgz#31ea21a734bab9bbb0f32466d893aea51e4a3c64"
216 |   integrity sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=
217 |   dependencies:
218 |     is-buffer "^1.1.5"
219 | 
220 | koa-buddy@^0.1.0:
221 |   version "0.1.0"
222 |   resolved "https://registry.yarnpkg.com/koa-buddy/-/koa-buddy-0.1.0.tgz#e2cd2f8b30c9788efbd765a59305ae1a80b04d3f"
223 |   integrity sha1-4s0vizDJeI7712WlkwWuGoCwTT8=
224 |   dependencies:
225 |     bluebird "^2.3.2"
226 |     co-body "^1.0.0"
227 |     multiparty "^3.3.2"
228 |     xml-parser "^1.0.0"
229 | 
230 | koa-compose@^2.3.0:
231 |   version "2.5.1"
232 |   resolved "https://registry.yarnpkg.com/koa-compose/-/koa-compose-2.5.1.tgz#726cfb17694de5cb9fbf03c0adf172303f83f156"
233 |   integrity sha1-cmz7F2lN5cufvwPArfFyMD+D8VY=
234 | 
235 | koa-is-json@^1.0.0:
236 |   version "1.0.0"
237 |   resolved "https://registry.yarnpkg.com/koa-is-json/-/koa-is-json-1.0.0.tgz#273c07edcdcb8df6a2c1ab7d59ee76491451ec14"
238 |   integrity sha1-JzwH7c3Ljfaiwat9We52SRRR7BQ=
239 | 
240 | koa-router@^5.1.2:
241 |   version "5.4.2"
242 |   resolved "https://registry.yarnpkg.com/koa-router/-/koa-router-5.4.2.tgz#4dbdba7e715953d5686c03b7c3fdbd214631f870"
243 |   integrity sha1-Tb26fnFZU9VobAO3w/29IUYx+HA=
244 |   dependencies:
245 |     co "^4.6.0"
246 |     debug "^2.2.0"
247 |     http-errors "^1.3.1"
248 |     methods "^1.0.1"
249 |     path-to-regexp "^1.1.1"
250 | 
251 | koa-swig@^2.0.0:
252 |   version "2.2.1"
253 |   resolved "https://registry.yarnpkg.com/koa-swig/-/koa-swig-2.2.1.tgz#0cc30c581faa7a8f0c1e5b5242fb3bd04a895969"
254 |   integrity sha1-DMMMWB+qeo8MHltSQvs70EqJWWk=
255 |   dependencies:
256 |     debug "^2.x"
257 |     swig-templates "^2.0.2"
258 |     thenify "^3.1.0"
259 |     utils-merge "^1.0.0"
260 | 
261 | koa@^1.0.0:
262 |   version "1.7.0"
263 |   resolved "https://registry.yarnpkg.com/koa/-/koa-1.7.0.tgz#bd9c4239704b51f5dc6833058a900d79afd8901d"
264 |   integrity sha512-bgKsbYjJac0E8O6ya+m6KosXXUigJ15N4XFCnCA0P/kNViu9OnMLv5WcnEeQ5q1SeuKqlqcf0WiroZQBiPHp8Q==
265 |   dependencies:
266 |     accepts "^1.2.2"
267 |     co "^4.4.0"
268 |     composition "^2.1.1"
269 |     content-disposition "~0.5.0"
270 |     content-type "^1.0.0"
271 |     cookies "~0.8.0"
272 |     debug "^2.6.9"
273 |     delegates "^1.0.0"
274 |     destroy "^1.0.3"
275 |     error-inject "~1.0.0"
276 |     escape-html "~1.0.1"
277 |     fresh "^0.5.2"
278 |     http-assert "^1.1.0"
279 |     http-errors "^1.2.8"
280 |     koa-compose "^2.3.0"
281 |     koa-is-json "^1.0.0"
282 |     mime-types "^2.0.7"
283 |     on-finished "^2.1.0"
284 |     only "0.0.2"
285 |     parseurl "^1.3.0"
286 |     statuses "^1.2.0"
287 |     type-is "^1.5.5"
288 |     vary "^1.0.0"
289 | 
290 | lazy-cache@^1.0.3:
291 |   version "1.0.4"
292 |   resolved "https://registry.yarnpkg.com/lazy-cache/-/lazy-cache-1.0.4.tgz#a1d78fc3a50474cb80845d3b3b6e1da49a446e8e"
293 |   integrity sha1-odePw6UEdMuAhF07O24dpJpEbo4=
294 | 
295 | longest@^1.0.1:
296 |   version "1.0.1"
297 |   resolved "https://registry.yarnpkg.com/longest/-/longest-1.0.1.tgz#30a0b2da38f73770e8294a0d22e6625ed77d0097"
298 |   integrity sha1-MKCy2jj3N3DoKUoNIuZiXtd9AJc=
299 | 
300 | media-typer@0.3.0:
301 |   version "0.3.0"
302 |   resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
303 |   integrity sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=
304 | 
305 | methods@^1.0.1:
306 |   version "1.1.2"
307 |   resolved "https://registry.yarnpkg.com/methods/-/methods-1.1.2.tgz#5529a4d67654134edcc5266656835b0f851afcee"
308 |   integrity sha1-VSmk1nZUE07cxSZmVoNbD4Ua/O4=
309 | 
310 | mime-db@1.44.0:
311 |   version "1.44.0"
312 |   resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.44.0.tgz#fa11c5eb0aca1334b4233cb4d52f10c5a6272f92"
313 |   integrity sha512-/NOTfLrsPBVeH7YtFPgsVWveuL+4SjjYxaQ1xtM1KMFj7HdxlBlxeyNLzhyJVx7r4rZGJAZ/6lkKCitSc/Nmpg==
314 | 
315 | mime-types@^2.0.7, mime-types@~2.1.24:
316 |   version "2.1.27"
317 |   resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.27.tgz#47949f98e279ea53119f5722e0f34e529bec009f"
318 |   integrity sha512-JIhqnCasI9yD+SsmkquHBxTSEuZdQX5BuQnS2Vc7puQQQ+8yiP5AY5uWhpdv4YL4VM5c6iliiYWPgJ/nJQLp7w==
319 |   dependencies:
320 |     mime-db "1.44.0"
321 | 
322 | minimist@^1.2.5:
323 |   version "1.2.5"
324 |   resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.5.tgz#67d66014b66a6a8aaa0c083c5fd58df4e4e97602"
325 |   integrity sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==
326 | 
327 | minimist@~0.0.1:
328 |   version "0.0.10"
329 |   resolved "https://registry.yarnpkg.com/minimist/-/minimist-0.0.10.tgz#de3f98543dbf96082be48ad1a0c7cda836301dcf"
330 |   integrity sha1-3j+YVD2/lggr5IrRoMfNqDYwHc8=
331 | 
332 | ms@2.0.0:
333 |   version "2.0.0"
334 |   resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8"
335 |   integrity sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=
336 | 
337 | multiparty@^3.3.2:
338 |   version "3.3.2"
339 |   resolved "https://registry.yarnpkg.com/multiparty/-/multiparty-3.3.2.tgz#35de6804dc19643e5249f3d3e3bdc6c8ce301d3f"
340 |   integrity sha1-Nd5oBNwZZD5SSfPT473GyM4wHT8=
341 |   dependencies:
342 |     readable-stream "~1.1.9"
343 |     stream-counter "~0.2.0"
344 | 
345 | negotiator@0.6.2:
346 |   version "0.6.2"
347 |   resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-0.6.2.tgz#feacf7ccf525a77ae9634436a64883ffeca346fb"
348 |   integrity sha512-hZXc7K2e+PgeI1eDBe/10Ard4ekbfrrqG8Ep+8Jmf4JID2bNg7NvCPOZN+kfF574pFQI7mum2AUqDidoKqcTOw==
349 | 
350 | on-finished@^2.1.0:
351 |   version "2.3.0"
352 |   resolved "https://registry.yarnpkg.com/on-finished/-/on-finished-2.3.0.tgz#20f1336481b083cd75337992a16971aa2d906947"
353 |   integrity sha1-IPEzZIGwg811M3mSoWlxqi2QaUc=
354 |   dependencies:
355 |     ee-first "1.1.1"
356 | 
357 | only@0.0.2:
358 |   version "0.0.2"
359 |   resolved "https://registry.yarnpkg.com/only/-/only-0.0.2.tgz#2afde84d03e50b9a8edc444e30610a70295edfb4"
360 |   integrity sha1-Kv3oTQPlC5qO3EROMGEKcCle37Q=
361 | 
362 | optimist@~0.6:
363 |   version "0.6.1"
364 |   resolved "https://registry.yarnpkg.com/optimist/-/optimist-0.6.1.tgz#da3ea74686fa21a19a111c326e90eb15a0196686"
365 |   integrity sha1-2j6nRob6IaGaERwybpDrFaAZZoY=
366 |   dependencies:
367 |     minimist "~0.0.1"
368 |     wordwrap "~0.0.2"
369 | 
370 | parseurl@^1.3.0:
371 |   version "1.3.3"
372 |   resolved "https://registry.yarnpkg.com/parseurl/-/parseurl-1.3.3.tgz#9da19e7bee8d12dff0513ed5b76957793bc2e8d4"
373 |   integrity sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==
374 | 
375 | path-to-regexp@^1.1.1:
376 |   version "1.8.0"
377 |   resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-1.8.0.tgz#887b3ba9d84393e87a0a0b9f4cb756198b53548a"
378 |   integrity sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==
379 |   dependencies:
380 |     isarray "0.0.1"
381 | 
382 | qs@^6.9.3:
383 |   version "6.9.3"
384 |   resolved "https://registry.yarnpkg.com/qs/-/qs-6.9.3.tgz#bfadcd296c2d549f1dffa560619132c977f5008e"
385 |   integrity sha512-EbZYNarm6138UKKq46tdx08Yo/q9ZhFoAXAI1meAFd2GtbRDhbZY2WQSICskT0c5q99aFzLG1D4nvTk9tqfXIw==
386 | 
387 | qs@~2.3.3:
388 |   version "2.3.3"
389 |   resolved "https://registry.yarnpkg.com/qs/-/qs-2.3.3.tgz#e9e85adbe75da0bbe4c8e0476a086290f863b404"
390 |   integrity sha1-6eha2+ddoLvkyOBHaghikPhjtAQ=
391 | 
392 | raw-body@~1.3.3:
393 |   version "1.3.4"
394 |   resolved "https://registry.yarnpkg.com/raw-body/-/raw-body-1.3.4.tgz#ccc7ddfc46b72861cdd5bb433c840b70b6f27f54"
395 |   integrity sha1-zMfd/Ea3KGHN1btDPIQLcLbyf1Q=
396 |   dependencies:
397 |     bytes "1.0.0"
398 |     iconv-lite "0.4.8"
399 | 
400 | readable-stream@~1.1.8, readable-stream@~1.1.9:
401 |   version "1.1.14"
402 |   resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-1.1.14.tgz#7cf4c54ef648e3813084c636dd2079e166c081d9"
403 |   integrity sha1-fPTFTvZI44EwhMY23SB54WbAgdk=
404 |   dependencies:
405 |     core-util-is "~1.0.0"
406 |     inherits "~2.0.1"
407 |     isarray "0.0.1"
408 |     string_decoder "~0.10.x"
409 | 
410 | repeat-string@^1.5.2:
411 |   version "1.6.1"
412 |   resolved "https://registry.yarnpkg.com/repeat-string/-/repeat-string-1.6.1.tgz#8dcae470e1c88abc2d600fff4a776286da75e637"
413 |   integrity sha1-jcrkcOHIirwtYA//Sndihtp15jc=
414 | 
415 | right-align@^0.1.1:
416 |   version "0.1.3"
417 |   resolved "https://registry.yarnpkg.com/right-align/-/right-align-0.1.3.tgz#61339b722fe6a3515689210d24e14c96148613ef"
418 |   integrity sha1-YTObci/mo1FWiSENJOFMlhSGE+8=
419 |   dependencies:
420 |     align-text "^0.1.1"
421 | 
422 | safe-buffer@5.1.2:
423 |   version "5.1.2"
424 |   resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d"
425 |   integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==
426 | 
427 | setprototypeof@1.1.1:
428 |   version "1.1.1"
429 |   resolved "https://registry.yarnpkg.com/setprototypeof/-/setprototypeof-1.1.1.tgz#7e95acb24aa92f5885e0abef5ba131330d4ae683"
430 |   integrity sha512-JvdAWfbXeIGaZ9cILp38HntZSFSo3mWg6xGcJJsd+d4aRMOqauag1C63dJfDw7OaMYwEbHMOxEZ1lqVRYP2OAw==
431 | 
432 | source-map@~0.5.1:
433 |   version "0.5.7"
434 |   resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.5.7.tgz#8a039d2d1021d22d1ea14c80d8ea468ba2ef3fcc"
435 |   integrity sha1-igOdLRAh0i0eoUyA2OpGi6LvP8w=
436 | 
437 | "statuses@>= 1.5.0 < 2", statuses@^1.2.0:
438 |   version "1.5.0"
439 |   resolved "https://registry.yarnpkg.com/statuses/-/statuses-1.5.0.tgz#161c7dac177659fd9811f43771fa99381478628c"
440 |   integrity sha1-Fhx9rBd2Wf2YEfQ3cfqZOBR4Yow=
441 | 
442 | stream-counter@~0.2.0:
443 |   version "0.2.0"
444 |   resolved "https://registry.yarnpkg.com/stream-counter/-/stream-counter-0.2.0.tgz#ded266556319c8b0e222812b9cf3b26fa7d947de"
445 |   integrity sha1-3tJmVWMZyLDiIoErnPOyb6fZR94=
446 |   dependencies:
447 |     readable-stream "~1.1.8"
448 | 
449 | string_decoder@~0.10.x:
450 |   version "0.10.31"
451 |   resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-0.10.31.tgz#62e203bc41766c6c28c9fc84301dab1c5310fa94"
452 |   integrity sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ=
453 | 
454 | swig-templates@^2.0.2:
455 |   version "2.0.3"
456 |   resolved "https://registry.yarnpkg.com/swig-templates/-/swig-templates-2.0.3.tgz#6b4c43b462175df2a8da857a2043379ec6ea6fd0"
457 |   integrity sha512-QojPTuZWdpznSZWZDB63/grsZuDwT/7geMeGlftbJXDoYBIZEnTcKvz4iwYDv3SwfPX9/B4RtGRSXNnm3S2wwg==
458 |   dependencies:
459 |     optimist "~0.6"
460 |     uglify-js "2.6.0"
461 | 
462 | thenify@^3.1.0:
463 |   version "3.3.0"
464 |   resolved "https://registry.yarnpkg.com/thenify/-/thenify-3.3.0.tgz#e69e38a1babe969b0108207978b9f62b88604839"
465 |   integrity sha1-5p44obq+lpsBCCB5eLn2K4hgSDk=
466 |   dependencies:
467 |     any-promise "^1.0.0"
468 | 
469 | toidentifier@1.0.0:
470 |   version "1.0.0"
471 |   resolved "https://registry.yarnpkg.com/toidentifier/-/toidentifier-1.0.0.tgz#7e1be3470f1e77948bc43d94a3c8f4d7752ba553"
472 |   integrity sha512-yaOH/Pk/VEhBWWTlhI+qXxDFXlejDGcQipMlyxda9nthulaxLZUNcUqFxokp0vcYnvteJln5FNQDRrxj3YcbVw==
473 | 
474 | tsscmp@1.0.6:
475 |   version "1.0.6"
476 |   resolved "https://registry.yarnpkg.com/tsscmp/-/tsscmp-1.0.6.tgz#85b99583ac3589ec4bfef825b5000aa911d605eb"
477 |   integrity sha512-LxhtAkPDTkVCMQjt2h6eBVY28KCjikZqZfMcC15YBeNjkgUpdCfBu5HoiOTDu86v6smE8yOjyEktJ8hlbANHQA==
478 | 
479 | type-is@^1.5.5:
480 |   version "1.6.18"
481 |   resolved "https://registry.yarnpkg.com/type-is/-/type-is-1.6.18.tgz#4e552cd05df09467dcbc4ef739de89f2cf37c131"
482 |   integrity sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==
483 |   dependencies:
484 |     media-typer "0.3.0"
485 |     mime-types "~2.1.24"
486 | 
487 | uglify-js@2.6.0:
488 |   version "2.6.0"
489 |   resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-2.6.0.tgz#25eaa1cc3550e39410ceefafd1cfbb6b6d15f001"
490 |   integrity sha1-JeqhzDVQ45QQzu+v0c+7a20V8AE=
491 |   dependencies:
492 |     async "~0.2.6"
493 |     source-map "~0.5.1"
494 |     uglify-to-browserify "~1.0.0"
495 |     yargs "~3.10.0"
496 | 
497 | uglify-to-browserify@~1.0.0:
498 |   version "1.0.2"
499 |   resolved "https://registry.yarnpkg.com/uglify-to-browserify/-/uglify-to-browserify-1.0.2.tgz#6e0924d6bda6b5afe349e39a6d632850a0f882b7"
500 |   integrity sha1-bgkk1r2mta/jSeOabWMoUKD4grc=
501 | 
502 | utils-merge@^1.0.0:
503 |   version "1.0.1"
504 |   resolved "https://registry.yarnpkg.com/utils-merge/-/utils-merge-1.0.1.tgz#9f95710f50a267947b2ccc124741c1028427e713"
505 |   integrity sha1-n5VxD1CiZ5R7LMwSR0HBAoQn5xM=
506 | 
507 | vary@^1.0.0:
508 |   version "1.1.2"
509 |   resolved "https://registry.yarnpkg.com/vary/-/vary-1.1.2.tgz#2299f02c6ded30d4a5961b0b9f74524a18f634fc"
510 |   integrity sha1-IpnwLG3tMNSllhsLn3RSShj2NPw=
511 | 
512 | window-size@0.1.0:
513 |   version "0.1.0"
514 |   resolved "https://registry.yarnpkg.com/window-size/-/window-size-0.1.0.tgz#5438cd2ea93b202efa3a19fe8887aee7c94f9c9d"
515 |   integrity sha1-VDjNLqk7IC76Ohn+iIeu58lPnJ0=
516 | 
517 | wordwrap@0.0.2:
518 |   version "0.0.2"
519 |   resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-0.0.2.tgz#b79669bb42ecb409f83d583cad52ca17eaa1643f"
520 |   integrity sha1-t5Zpu0LstAn4PVg8rVLKF+qhZD8=
521 | 
522 | wordwrap@~0.0.2:
523 |   version "0.0.3"
524 |   resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-0.0.3.tgz#a3d5da6cd5c0bc0008d37234bbaf1bed63059107"
525 |   integrity sha1-o9XabNXAvAAI03I0u68b7WMFkQc=
526 | 
527 | xml-parser@^1.0.0:
528 |   version "1.2.1"
529 |   resolved "https://registry.yarnpkg.com/xml-parser/-/xml-parser-1.2.1.tgz#c31f4c34f2975db82ad013222120592736156fcd"
530 |   integrity sha1-wx9MNPKXXbgq0BMiISBZJzYVb80=
531 |   dependencies:
532 |     debug "^2.2.0"
533 | 
534 | yargs@~3.10.0:
535 |   version "3.10.0"
536 |   resolved "https://registry.yarnpkg.com/yargs/-/yargs-3.10.0.tgz#f7ee7bd857dd7c1d2d38c0e74efbd681d1431fd1"
537 |   integrity sha1-9+572FfdfB0tOMDnTvvWgdFDH9E=
538 |   dependencies:
539 |     camelcase "^1.0.2"
540 |     cliui "^2.1.0"
541 |     decamelize "^1.0.0"
542 |     window-size "0.1.0"
543 | 


--------------------------------------------------------------------------------
/docker-compose.yml:
--------------------------------------------------------------------------------
  1 | version: "3.8"
  2 | 
  3 | services:
  4 |   mail:
  5 |     build: ./mail
  6 |     hostname: ${OVERRIDE_HOSTNAME}
  7 |     domainname: ${DOMAINNAME}
  8 |     container_name: Mailbox
  9 |     depends_on:
 10 |       - postfixdb
 11 |     volumes:
 12 |       - ./mail/data/mail:/var/mail
 13 |       - ./mail/data/conf:/var/mail-state
 14 |       - ./mail/data/logs:/var/log/mail
 15 |       - ./mail/config/:/tmp/docker-mailserver/
 16 |       - /etc/localtime:/etc/localtime:ro
 17 |       # ? if SELinux is enabled, uncomment the line below and comment the line above
 18 |       # - ./config/:/tmp/docker-mailserver/${SELINUX_LABEL}
 19 |     networks:
 20 |       - mailserver
 21 |     ports:
 22 |       - "25:25" # SMTP  (explicit TLS => STARTTLS)
 23 |       - "143:143" # IMAP4 (explicit TLS => STARTTLS)
 24 |       - "465:465" # ESMTP (implicit TLS)
 25 |       - "587:587" # ESMTP (explicit TLS => STARTTLS)
 26 |       - "993:993" # IMAP4 (implicit TLS)
 27 |     environment:
 28 |       # General Configurations
 29 |       SMTP_ONLY: 0
 30 |       ONE_DIR: 1
 31 |       DMS_DEBUG: 1
 32 |       # Security Configurations
 33 |       TLS_LEVEL: modern
 34 |       SSL_TYPE: letsencrypt
 35 |       SPOOF_PROTECTION: 1
 36 |       ENABLE_SPAMASSASSIN: 1
 37 |       ENABLE_CLAMAV: 0
 38 |       ENABLE_FAIL2BAN: 0
 39 |       ENABLE_POSTGREY: 0
 40 |       # Networking
 41 |       PERMIT_DOCKER: connected-networks
 42 |       POSTFIX_INET_PROTOCOLS: ipv4
 43 |       # External SMTP Configurations
 44 |       DEFAULT_RELAY_HOST: ${DEFAULT_RELAY_HOST}
 45 |       RELAY_HOST: ${RELAY_HOST}
 46 |       RELAY_PORT: ${RELAY_PORT}
 47 |       RELAY_USER: ${RELAY_USER}
 48 |       RELAY_PASSWORD: ${RELAY_PASSWORD}
 49 |       # SQL Configurations
 50 |       ENABLE_SQL: 1
 51 |       SQL_DRIVER: mysql
 52 |       SQL_HOSTS: postfixdb
 53 |       SQL_USER: ${MYSQL_USER}
 54 |       SQL_DBNAME: ${MYSQL_DATABASE}
 55 |       SQL_PASSWORD: ${MYSQL_PASSWORD}
 56 |       DEFAULT_PASS_SCHEME: MD5-CRYPT
 57 |       # Enable/Disable Components
 58 |       ENABLE_POP3: null
 59 |       ENABLE_SRS: 0
 60 |     restart: always
 61 |     stop_grace_period: 1m
 62 |     cap_add: [ "NET_ADMIN", "SYS_PTRACE" ]
 63 |   postfixdb:
 64 |     container_name: PostfixDB
 65 |     image: mysql:5.7
 66 |     volumes:
 67 |       # - ./mysql:/docker-entrypoint-initdb.d
 68 |       - sqldata:/var/lib/mysql
 69 |     networks:
 70 |       - mailserver
 71 |     expose:
 72 |       - "3306"
 73 |     environment:
 74 |       MYSQL_DATABASE: ${MYSQL_DATABASE}
 75 |       MYSQL_USER: ${MYSQL_USER}
 76 |       MYSQL_PASSWORD: ${MYSQL_PASSWORD}
 77 |       MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
 78 |     restart: always
 79 |   postfixadmin:
 80 |     image: postfixadmin
 81 |     container_name: PostfixAdmin
 82 |     depends_on:
 83 |       - postfixdb
 84 |       - mail
 85 |     networks:
 86 |       - mailserver
 87 |     ports:
 88 |       - 8080:80
 89 |     environment:
 90 |       POSTFIXADMIN_DB_TYPE: mysqli
 91 |       POSTFIXADMIN_DB_HOST: postfixdb
 92 |       POSTFIXADMIN_DB_USER: ${MYSQL_USER}
 93 |       POSTFIXADMIN_DB_NAME: ${MYSQL_DATABASE}
 94 |       POSTFIXADMIN_DB_PASSWORD: ${MYSQL_PASSWORD}
 95 |       POSTFIXADMIN_SETUP_PASSWORD: ${POSTFIXADMIN_SETUP_PASSWORD}
 96 |       POSTFIXADMIN_SMTP_SERVER: mail
 97 |       POSTFIXADMIN_SMTP_PORT: 25
 98 |     restart: always
 99 |     labels:
100 |       - "traefik.enable=true"
101 |       - "traefik.http.routers.postfixadmin.rule=Host(`mail.${DOMAINNAME}`)"
102 |       - "traefik.http.routers.postfixadmin.entrypoints=websecure"
103 |       - "traefik.http.routers.postfixadmin.tls.certresolver=myresolver"
104 |   autodiscover:
105 |     image: monogramm/autodiscover-email-settings:latest
106 |     container_name: AutoDiscover
107 |     networks:
108 |       - mailserver
109 |     environment:
110 |       COMPANY_NAME: ${COMPANY_NAME}
111 |       SUPPORT_URL: https://autodiscover.${DOMAINNAME}
112 |       DOMAIN: ${DOMAINNAME}
113 |       # IMAP configuration (host mandatory to enable)
114 |       IMAP_HOST: mail.${DOMAINNAME}
115 |       IMAP_PORT: 993
116 |       IMAP_SOCKET: SSL
117 |       # POP configuration (host mandatory to enable)
118 |       POP_HOST: mail.${DOMAINNAME}
119 |       POP_PORT: 995
120 |       POP_SOCKET: SSL
121 |       # SMTP configuration (host mandatory to enable)
122 |       SMTP_HOST: mail.${DOMAINNAME}
123 |       SMTP_PORT: 587
124 |       SMTP_SOCKET: STARTTLS
125 |     labels:
126 |       - "traefik.enable=true"
127 |       - "traefik.http.routers.autodiscover.rule=Host(`autoconfig.${DOMAINNAME}`\
128 |         ,`autodiscover.${DOMAINNAME}`)"
129 |       - "traefik.http.routers.autodiscover.entrypoints=websecure"
130 |       - "traefik.http.routers.autodiscover.tls.certresolver=myresolver"
131 |   traefik:
132 |     image: traefik:latest
133 |     container_name: Traefik
134 |     restart: unless-stopped
135 |     command:
136 |       #- "--log.level=DEBUG"
137 |       - "--api.insecure=true"
138 |       - "--providers.docker=true"
139 |       - "--providers.docker.exposedbydefault=false"
140 |       - "--entryPoints.web.address=:80"
141 |       - "--entryPoints.websecure.address=:443"
142 |       - "--certificatesresolvers.myresolver.acme.tlschallenge=true"
143 |       # - "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory"
144 |       - "--certificatesResolvers.myresolver.acme.email=postmaster@${DOMAINNAME}"
145 |       - "--certificatesResolvers.myresolver.acme.storage=/letsencrypt/acme.json"
146 |     networks:
147 |       - mailserver
148 |     ports:
149 |       - "80:80"
150 |       - "443:443"
151 |     labels:
152 |       - "traefik.enable=true"
153 |       # Middleware Redirect
154 |       - "traefik.http.middlewares.redirect-to-https.redirectscheme.scheme=https"
155 |       # Global Redirect to HTTPS
156 |       - "traefik.http.routers.redirs.rule=hostregexp(`{host:.+}`)"
157 |       - "traefik.http.routers.redirs.entrypoints=web"
158 |       - "traefik.http.routers.redirs.middlewares=redirect-to-https"
159 |     volumes:
160 |       - "./mail/data/letsencrypt:/letsencrypt"
161 |       - "/var/run/docker.sock:/var/run/docker.sock:ro"
162 | networks:
163 |   mailserver:
164 |     name: mailserver
165 |     driver: bridge
166 | volumes:
167 |   sqldata:
168 |     name: SQLData
169 |     external: false
170 | 


--------------------------------------------------------------------------------
/mail/Dockerfile:
--------------------------------------------------------------------------------
 1 | FROM mailserver/docker-mailserver
 2 | 
 3 | # –––––––––––––––––––––––––––––––––––––––––––––––
 4 | # ––– Install Basic Software ––––––––––––––––––––
 5 | # –––––––––––––––––––––––––––––––––––––––––––––––
 6 | 
 7 | RUN apt-get -qq update && \
 8 |   apt-get -y --no-install-recommends install dovecot-mysql postfix-mysql && \
 9 |   # cleanup
10 |   apt-get -qq autoclean && \
11 |   apt-get -qq clean && \
12 |   rm -rf /var/lib/apt/lists/* && \
13 |   c_rehash 2>/dev/null
14 | # –––––––––––––––––––––––––––––––––––––––––––––––
15 | # ––– MySQL Postfix & Dovecot ––––––––––––––––---
16 | # –––––––––––––––––––––––––––––––––––––––––––––––
17 | 
18 | COPY \
19 |   target/dovecot/dovecot-sql.conf.ext \
20 |   target/dovecot/dovecot-dict-sql.conf.ext \
21 |   /etc/dovecot/
22 | 
23 | COPY \
24 |   target/dovecot/10-master.conf \
25 |   /etc/dovecot/conf.d/
26 | 
27 | COPY \
28 |   target/postfix/sql/domains_maps.cf \
29 |   target/postfix/sql/mailbox_maps.cf \
30 |   target/postfix/sql/alias_domain_mailbox_maps.cf \
31 |   target/postfix/sql/alias_maps.cf \
32 |   target/postfix/sql/alias_domain_maps.cf \
33 |   target/postfix/sql/alias_domain_catchall_maps.cf \
34 |   /etc/postfix/sql/
35 | 
36 | # –––––––––––––––––––––––––––––––––––––––––––––––
37 | # ––– Scripts & Miscellaneous –––––––––––––––––––
38 | # –––––––––––––––––––––––––––––––––––––––––––––––
39 | 
40 | COPY \
41 |   ./target/bin/* \
42 |   ./target/scripts/*.sh \
43 |   ./target/scripts/startup/*.sh \
44 |   ./target/docker-configomat/configomat.sh \
45 |   /usr/local/bin/
46 | 
47 | RUN \
48 |   chmod +x /usr/local/bin/*
49 | 


--------------------------------------------------------------------------------
/mail/config/dovecot-quotas.cf:
--------------------------------------------------------------------------------
1 | # define user's quota in this file
2 | # E.g;
3 | # user@domain:50M
4 | 


--------------------------------------------------------------------------------
/mail/config/dovecot.cf:
--------------------------------------------------------------------------------
1 | # File for additional dovecot configurations.
2 | # For more informations read http://wiki.dovecot.org/BasicConfiguration
3 | 
4 | #mail_max_userip_connections = 50
5 | 


--------------------------------------------------------------------------------
/mail/config/fail2ban-fail2ban.cf:
--------------------------------------------------------------------------------
 1 | [Definition]
 2 | 
 3 | # Option: loglevel
 4 | # Notes.: Set the log level output.
 5 | #         CRITICAL
 6 | #         ERROR
 7 | #         WARNING
 8 | #         NOTICE
 9 | #         INFO
10 | #         DEBUG
11 | # Values: [ LEVEL ]  Default: ERROR
12 | #
13 | 
14 | # loglevel = INFO
15 | 
16 | # Options: dbpurgeage
17 | # Notes.: Sets age at which bans should be purged from the database
18 | # Values: [ SECONDS ] Default: 86400 (24hours), 604800 (1week)
19 | # dbpurgeage = 604800
20 | 


--------------------------------------------------------------------------------
/mail/config/fail2ban-jail.cf:
--------------------------------------------------------------------------------
 1 | [DEFAULT]
 2 | 
 3 | # "bantime" is the number of seconds that a host is banned.
 4 | #bantime  = 10800
 5 | 
 6 | # A host is banned if it has generated "maxretry" during the last "findtime"
 7 | # seconds.
 8 | #findtime  = 600
 9 | 
10 | # "maxretry" is the number of failures before a host get banned.
11 | #maxretry = 3
12 | 


--------------------------------------------------------------------------------
/mail/config/fetchmail.cf:
--------------------------------------------------------------------------------
 1 | ## Example configuration: IMAP
 2 | #poll imap.example.com with proto IMAP
 3 | #	user 'username' there with
 4 | #	password 'secret'
 5 | #	is 'user1@domain.tld'
 6 | #	here ssl
 7 | 
 8 | ## Example configuration: POP3
 9 | #poll pop3.example.com with proto POP3
10 | #	user 'username' there with
11 | #	password 'secret'
12 | #	is 'user2@domain.tld'
13 | #	here options keep ssl
14 | 


--------------------------------------------------------------------------------
/mail/config/postfix-accounts.cf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aqeltech/Dockerised-GUI-Mailserver/5d747e05a7fc4f86fb9826dab5a6a0b6e0a04c83/mail/config/postfix-accounts.cf


--------------------------------------------------------------------------------
/mail/config/postfix-aliases.cf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aqeltech/Dockerised-GUI-Mailserver/5d747e05a7fc4f86fb9826dab5a6a0b6e0a04c83/mail/config/postfix-aliases.cf


--------------------------------------------------------------------------------
/mail/config/postfix-main.cf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aqeltech/Dockerised-GUI-Mailserver/5d747e05a7fc4f86fb9826dab5a6a0b6e0a04c83/mail/config/postfix-main.cf


--------------------------------------------------------------------------------
/mail/config/postfix-master.cf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aqeltech/Dockerised-GUI-Mailserver/5d747e05a7fc4f86fb9826dab5a6a0b6e0a04c83/mail/config/postfix-master.cf


--------------------------------------------------------------------------------
/mail/config/postfix-virtual.cf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aqeltech/Dockerised-GUI-Mailserver/5d747e05a7fc4f86fb9826dab5a6a0b6e0a04c83/mail/config/postfix-virtual.cf


--------------------------------------------------------------------------------
/mail/config/spamassassin-rules.cf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aqeltech/Dockerised-GUI-Mailserver/5d747e05a7fc4f86fb9826dab5a6a0b6e0a04c83/mail/config/spamassassin-rules.cf


--------------------------------------------------------------------------------
/mail/config/user-patches.sh.dist:
--------------------------------------------------------------------------------
1 | #! /bin/bash
2 | ##
3 | # This user patches script runs right before starting the daemons. That means, all the other configuration is in place, so the script can make final adjustments.
4 | # If you modify any supervisord configuration, make sure to run "supervisorctl update" or "supervisorctl reload" afterwards.
5 | # To enable the script, you must save it in your config directory as "user-patches.sh".
6 | ##
7 | echo "Default user-patches.sh successfully executed"
8 | 


--------------------------------------------------------------------------------
/mail/setup.sh:
--------------------------------------------------------------------------------
  1 | #! /bin/bash
  2 | 
  3 | # version   v1.0.0
  4 | # executed  manually / via Make
  5 | # task      wrapper for various setup scripts
  6 | 
  7 | CONFIG_PATH=
  8 | CONTAINER_NAME=
  9 | CRI=
 10 | DEFAULT_CONFIG_PATH=
 11 | DESIRED_CONFIG_PATH=
 12 | DIR="$(pwd)"
 13 | DMS_CONFIG='/tmp/docker-mailserver'
 14 | IMAGE_NAME=
 15 | DEFAULT_IMAGE_NAME='docker.io/mailserver/docker-mailserver:latest'
 16 | INFO=
 17 | PODMAN_ROOTLESS=false
 18 | USE_SELINUX=
 19 | USE_TTY=
 20 | VOLUME=
 21 | 
 22 | RED="\e[31m\e[1m"
 23 | WHITE="\e[37m"
 24 | ORANGE="\e[38;5;214m"
 25 | LBLUE="\e[94m"
 26 | RESET="\e[0m"
 27 | 
 28 | set -euEo pipefail
 29 | shopt -s inherit_errexit
 30 | trap '__err "${BASH_SOURCE}" "${FUNCNAME[0]:-?}" "${BASH_COMMAND:-?}" "${LINENO:-?}" "${?:-?}"' ERR
 31 | 
 32 | function __err
 33 | {
 34 |   [[ ${5} -gt 1 ]] && exit 1
 35 | 
 36 |   local ERR_MSG="\n--- ${RED}UNCHECKED ERROR${RESET}"
 37 |   ERR_MSG+="\n  - script    = ${1}"
 38 |   ERR_MSG+="\n  - function  = ${2}"
 39 |   ERR_MSG+="\n  - command   = ${3}"
 40 |   ERR_MSG+="\n  - line      = ${4}"
 41 |   ERR_MSG+="\n  - exit code = ${5}"
 42 |   ERR_MSG+='\n\nThis should not have happened. Please file a bug report.\n'
 43 | 
 44 |   echo -e "${ERR_MSG}"
 45 | }
 46 | 
 47 | function _show_local_usage
 48 | {
 49 |   # shellcheck disable=SC2059
 50 |   printf "${ORANGE}OPTIONS${RESET}
 51 |     ${LBLUE}Config path, container or image adjustments${RESET}
 52 |         -i IMAGE_NAME
 53 |             Provides the name of the 'docker-mailserver' image. The default value is
 54 |             '${WHITE}${DEFAULT_IMAGE_NAME}${RESET}'
 55 | 
 56 |         -c CONTAINER_NAME
 57 |             Provides the name of the running container.
 58 | 
 59 |         -p PATH
 60 |             Provides the local path of the config folder to the temporary container instance.
 61 |             Does not work if an existing a 'docker-mailserver' container is already running.
 62 | 
 63 |     ${LBLUE}SELinux${RESET}
 64 |         -z
 65 |             Allows container access to the bind mount content that is shared among
 66 |             multiple containers on a SELinux-enabled host.
 67 | 
 68 |         -Z
 69 |             Allows container access to the bind mount content that is private and
 70 |             unshared with other containers on a SELinux-enabled host.
 71 | 
 72 |     ${LBLUE}Podman${RESET}
 73 |         -R
 74 |             Accept running in Podman rootless mode. Ignored when using Docker / Docker Compose.
 75 | 
 76 | "
 77 | 
 78 |   [[ ${1:-} == 'no-exit' ]] && return 0
 79 | 
 80 |   # shellcheck disable=SC2059
 81 |   printf "${ORANGE}EXIT STATUS${RESET}
 82 |     Exit status is 0 if the command was successful. If there was an unexpected error, an error
 83 |     message is shown describing the error. In case of an error, the script will exit with exit
 84 |     status 1.
 85 | 
 86 | "
 87 | }
 88 | 
 89 | function _get_absolute_script_directory
 90 | {
 91 |   if [[ "$(uname)" == 'Darwin' ]]
 92 |   then
 93 |     readlink() {
 94 |       # requires coreutils
 95 |       greadlink "${@:+$@}"
 96 |     }
 97 |   fi
 98 | 
 99 |   if dirname "$(readlink -f "${0}")" &>/dev/null
100 |   then
101 |     DIR="$(dirname "$(readlink -f "${0}")")"
102 |   elif realpath -e -L "${0}" &>/dev/null
103 |   then
104 |     DIR="$(realpath -e -L "${0}")"
105 |     DIR="${DIR%/setup.sh}"
106 |   fi
107 | }
108 | 
109 | function _set_default_config_path
110 | {
111 |   if [[ -d "${DIR}/config" ]]
112 |   then
113 |     # legacy path (pre v10.2.0)
114 |     DEFAULT_CONFIG_PATH="${DIR}/config"
115 |   else
116 |     DEFAULT_CONFIG_PATH="${DIR}/docker-data/dms/config"
117 |   fi
118 | }
119 | 
120 | function _handle_config_path
121 | {
122 |   if [[ -z ${DESIRED_CONFIG_PATH} ]]
123 |   then
124 |     # no desired config path
125 |     if [[ -n ${CONTAINER_NAME} ]]
126 |     then
127 |       VOLUME=$(${CRI} inspect "${CONTAINER_NAME}" \
128 |         --format="{{range .Mounts}}{{ println .Source .Destination}}{{end}}" | \
129 |         grep "${DMS_CONFIG}$" 2>/dev/null || :)
130 |     fi
131 | 
132 |     if [[ -n ${VOLUME} ]]
133 |     then
134 |       CONFIG_PATH=$(echo "${VOLUME}" | awk '{print $1}')
135 |     fi
136 | 
137 |     if [[ -z ${CONFIG_PATH} ]]
138 |     then
139 |       CONFIG_PATH=${DEFAULT_CONFIG_PATH}
140 |     fi
141 |   else
142 |     CONFIG_PATH=${DESIRED_CONFIG_PATH}
143 |   fi
144 | }
145 | 
146 | function _run_in_new_container
147 | {
148 |   # start temporary container with specified image
149 |   if ! ${CRI} history -q "${IMAGE_NAME}" &>/dev/null
150 |   then
151 |     echo "Image '${IMAGE_NAME}' not found. Pulling ..."
152 |     ${CRI} pull "${IMAGE_NAME}"
153 |   fi
154 | 
155 |   ${CRI} run --rm "${USE_TTY}" \
156 |     -v "${CONFIG_PATH}:${DMS_CONFIG}${USE_SELINUX}" \
157 |     "${IMAGE_NAME}" "${@:+$@}"
158 | }
159 | 
160 | function _main
161 | {
162 |   _get_absolute_script_directory
163 |   _set_default_config_path
164 | 
165 |   local OPTIND
166 |   while getopts ":c:i:p:zZR" OPT
167 |   do
168 |     case ${OPT} in
169 |       ( i )     IMAGE_NAME="${OPTARG}"     ;;
170 |       ( z | Z ) USE_SELINUX=":${OPT}"      ;;
171 |       ( c )     CONTAINER_NAME="${OPTARG}" ;;
172 |       ( R )     PODMAN_ROOTLESS=true       ;;
173 |       ( p )
174 |         case "${OPTARG}" in
175 |           ( /* ) DESIRED_CONFIG_PATH="${OPTARG}"        ;;
176 |           ( *  ) DESIRED_CONFIG_PATH="${DIR}/${OPTARG}" ;;
177 |         esac
178 | 
179 |         if [[ ! -d ${DESIRED_CONFIG_PATH} ]]
180 |         then
181 |           echo "Specified directory '${DESIRED_CONFIG_PATH}' doesn't exist" >&2
182 |           exit 1
183 |         fi
184 |         ;;
185 | 
186 |       ( * )
187 |         echo "Invalid option: '-${OPTARG}'" >&2
188 |         echo -e "Use './setup.sh help' to get a complete overview.\n" >&2
189 |         _show_local_usage 'no-exit'
190 |         exit 1
191 |         ;;
192 | 
193 |     esac
194 |   done
195 |   shift $(( OPTIND - 1 ))
196 | 
197 |   if command -v docker &>/dev/null
198 |   then
199 |     CRI=docker
200 |   elif command -v podman &>/dev/null
201 |   then
202 |     CRI=podman
203 |     if ! ${PODMAN_ROOTLESS} && [[ ${EUID} -ne 0 ]]
204 |     then
205 |       read -r -p "You are running Podman in rootless mode. Continue? [Y/n] "
206 |       [[ -n ${REPLY} ]] && [[ ${REPLY} =~ (n|N) ]] && exit 0
207 |     fi
208 |   else
209 |     echo 'No supported Container Runtime Interface detected.'
210 |     exit 1
211 |   fi
212 | 
213 |   INFO=$(${CRI} ps --no-trunc --format "{{.Image}};{{.Names}}" --filter \
214 |     label=org.opencontainers.image.title="docker-mailserver" | tail -1)
215 | 
216 |   CONTAINER_NAME=${INFO#*;}
217 |   [[ -z ${IMAGE_NAME} ]] && IMAGE_NAME=${INFO%;*}
218 |   if [[ -z ${IMAGE_NAME} ]]
219 |   then
220 |     IMAGE_NAME=${NAME:-${DEFAULT_IMAGE_NAME}}
221 |   fi
222 | 
223 |   if test -t 0
224 |   then
225 |     USE_TTY="-it"
226 |   else
227 |     # GitHub Actions will fail (or really anything else
228 |     #   lacking an interactive tty) if we don't set a
229 |     #   value here; "-t" alone works for these cases.
230 |     USE_TTY="-t"
231 |   fi
232 | 
233 |   _handle_config_path
234 | 
235 |   if [[ -n ${CONTAINER_NAME} ]]
236 |   then
237 |     ${CRI} exec "${USE_TTY}" "${CONTAINER_NAME}" setup "${@:+$@}"
238 |   else
239 |     _run_in_new_container setup "${@:+$@}"
240 |   fi
241 | 
242 |   [[ ${1} == 'help' ]] && _show_local_usage
243 | 
244 |   return 0
245 | }
246 | 
247 | _main "${@:+$@}"


--------------------------------------------------------------------------------
/mail/target/bin/addalias:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=../scripts/helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | DATABASE=${DATABASE:-/tmp/docker-mailserver/postfix-virtual.cf}
 7 | 
 8 | function __usage
 9 | {
10 |   printf "\e[35mADDALIAS\e[31m(\e[93m8\e[31m)
11 | 
12 | \e[38;5;214mNAME\e[39m
13 |     addalias - add an email alias for an existing user
14 | 
15 | \e[38;5;214mSYNOPSIS\e[39m
16 |     ./setup.sh alias add <EMAIL ADDRESS> <RECIPIENT>
17 | 
18 | \e[38;5;214mOPTIONS\e[39m
19 |     \e[94mGeneric Program Information\e[39m
20 |         help       Print the usage information.
21 | 
22 | \e[38;5;214mEXAMPLES\e[39m
23 |     \e[37m./setup.sh alias add alias-for-me@domain.tld admin@domain.tld\e[39m
24 |         Add the alias alias-for-me@doamin.tld for the existing user
25 |         admin@domain.tld.
26 | 
27 | \e[38;5;214mEXIT STATUS\e[39m
28 |     Exit status is 0 if command was successful. If wrong arguments are provided
29 |     or arguments contain errors, the script will exit early with exit status 1.
30 | 
31 | "
32 | }
33 | 
34 | [[ ${1:-} == 'help' ]] && { __usage ; exit 0 ; }
35 | 
36 | EMAIL="${1}"
37 | RECIPIENT="${2}"
38 | 
39 | [[ -z ${EMAIL} ]] && { __usage ; errex 'No alias specified' ; }
40 | [[ -z ${RECIPIENT} ]] && { __usage ; errex 'No recipient specified' ; }
41 | 
42 | grep \
43 |   -qi "^$(escape "${EMAIL}")[a-zA-Z@.\ ]*$(escape "${RECIPIENT}")" \
44 |   "${DATABASE}" 2>/dev/null && errex "Alias \"${EMAIL} ${RECIPIENT}\" already exists"
45 | 
46 | if grep -qi "^$(escape "${EMAIL}")" "${DATABASE}" 2>/dev/null
47 | then
48 |   sed -i "/${EMAIL}/s/$/,${RECIPIENT}/" "${DATABASE}"
49 | else
50 |   echo "${EMAIL} ${RECIPIENT}" >> "${DATABASE}"
51 | fi
52 | 


--------------------------------------------------------------------------------
/mail/target/bin/addmailuser:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck disable=SC2094
 4 | 
 5 | # shellcheck source=../scripts/helper-functions.sh
 6 | . /usr/local/bin/helper-functions.sh
 7 | 
 8 | DATABASE=${DATABASE:-/tmp/docker-mailserver/postfix-accounts.cf}
 9 | 
10 | function __usage
11 | {
12 |   printf "\e[35mADDMAILUSER\e[31m(\e[93m8\e[31m)
13 | 
14 | \e[38;5;214mNAME\e[39m
15 |     addmailuser - add an email address (i.e. a user)
16 | 
17 | \e[38;5;214mSYNOPSIS\e[39m
18 |     ./setup.sh email add <EMAIL ADDRESS> [<PASSWORD>]
19 | 
20 | \e[38;5;214mOPTIONS\e[39m
21 |     \e[94mGeneric Program Information\e[39m
22 |         help       Print the usage information.
23 | 
24 | \e[38;5;214mEXAMPLES\e[39m
25 |     \e[37m./setup.sh email add test@domain.tld\e[39m
26 |         Add the email account test@domain.tld. You will be prompted
27 |         to input a password afterwards since no password was supplied.
28 | 
29 | \e[38;5;214mEXIT STATUS\e[39m
30 |     Exit status is 0 if command was successful. If wrong arguments are provided
31 |     or arguments contain errors, the script will exit early with exit status 1.
32 | 
33 | "
34 | }
35 | 
36 | [[ ${1:-} == 'help' ]] && { __usage ; exit 0 ; }
37 | 
38 | USER="${1}"
39 | shift
40 | PASSWD="${*}"
41 | 
42 | [[ -z ${USER} ]] && { __usage ; errex 'No username specified' ; }
43 | [[ "${USER}" =~ .*\@.* ]] || { __usage ; errex 'Username must include the domain' ; }
44 | 
45 | # Protect config file with lock to avoid race conditions
46 | touch "${DATABASE}"
47 | (
48 |   flock -e 200
49 | 
50 |   if grep -qi "^$(escape "${USER}")|" "${DATABASE}" 2>/dev/null
51 |   then
52 |     echo "User '${USER}' already exists."
53 |     exit 1
54 |   fi
55 | 
56 |   if [[ -z ${PASSWD} ]]
57 |   then
58 |     read -r -s -p "Enter Password: " PASSWD
59 |     echo
60 |     [[ -z ${PASSWD} ]] && errex "Password must not be empty"
61 |   fi
62 | 
63 |   HASH="$(doveadm pw -s SHA512-CRYPT -u "${USER}" -p "${PASSWD}")"
64 |   echo "${USER}|${HASH}" >> "${DATABASE}"
65 | ) 200< "${DATABASE}"
66 | 


--------------------------------------------------------------------------------
/mail/target/bin/addrelayhost:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=../scripts/helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | DATABASE=${DATABASE:-/tmp/docker-mailserver/postfix-relaymap.cf}
 7 | 
 8 | function __usage
 9 | {
10 |   printf "\e[35mADDRELAYHOST\e[31m(\e[93m8\e[31m)
11 | 
12 | \e[38;5;214mNAME\e[39m
13 |     addrelayhost - add an relay host
14 | 
15 | \e[38;5;214mSYNOPSIS\e[39m
16 |     ./setup.sh relay add-domain <DOMAIN> <HOST> [<PORT>]
17 | 
18 | \e[38;5;214mOPTIONS\e[39m
19 |     \e[94mGeneric Program Information\e[39m
20 |         help       Print the usage information.
21 | 
22 | \e[38;5;214mEXIT STATUS\e[39m
23 |     Exit status is 0 if command was successful. If wrong arguments are provided
24 |     or arguments contain errors, the script will exit early with exit status 1.
25 | 
26 | "
27 | }
28 | 
29 | [[ ${1:-} == 'help' ]] && { __usage ; exit 0 ; }
30 | 
31 | DOMAIN="${1}"
32 | HOST="${2}"
33 | PORT="${3}"
34 | 
35 | [[ -z ${DOMAIN} ]] && { __usage ; errex 'No domain specified' ; }
36 | [[ -z ${HOST} ]] && { __usage ; errex 'No relay host specified' ; }
37 | [[ -z ${PORT} ]] && PORT=25
38 | 
39 | if grep -qi "^@${DOMAIN}" "${DATABASE}" 2>/dev/null
40 | then
41 |   sed -i \
42 |     "s|^@${DOMAIN}.*|@${DOMAIN}\t\t[${HOST}]:${PORT}|" \
43 |     "${DATABASE}"
44 | else
45 |   echo -e "@${DOMAIN}\t\t[${HOST}]:${PORT}" >>"${DATABASE}"
46 | fi
47 | 


--------------------------------------------------------------------------------
/mail/target/bin/addsaslpassword:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=../scripts/helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | DATABASE=${DATABASE:-/tmp/docker-mailserver/postfix-sasl-password.cf}
 7 | 
 8 | function __usage { echo "Usage: addsaslpassword <domain> <username> <password>" ; }
 9 | 
10 | [[ ${1:-} == 'help' ]] && { __usage ; exit 0 ; }
11 | 
12 | DOMAIN="${1}"
13 | USER="${2}"
14 | PASSWD="${3}"
15 | 
16 | [[ -z ${DOMAIN} ]] && { __usage ; errex 'No domain specified' ; }
17 | [[ -z ${USER} ]] && { __usage ; errex 'No username specified' ; }
18 | 
19 | if [[ -z ${PASSWD} ]]
20 | then
21 |   read -r -s -p "Enter Password: " PASSWD
22 |   echo
23 |   [[ -z ${PASSWD} ]] && errex 'Password must not be empty'
24 | fi
25 | 
26 | if grep -qi "^@${DOMAIN}" "${DATABASE}" 2>/dev/null
27 | then
28 |   sed -i \
29 |     "s|^@${DOMAIN}.*|@${DOMAIN}\t\t${USER}:${PASSWD}|" \
30 |     "${DATABASE}"
31 | else
32 |   echo -e "@${DOMAIN}\t\t${USER}:${PASSWD}" >>"${DATABASE}"
33 | fi
34 | 


--------------------------------------------------------------------------------
/mail/target/bin/debug-fetchmail:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | /usr/local/bin/setup-fetchmail
 4 | 
 5 | su -s /bin/sh -c "/usr/bin/fetchmail \
 6 |   --verbose \
 7 |   --daemon 0 \
 8 |   --check \
 9 |   --nosyslog \
10 |   --nodetach \
11 |   -f /etc/fetchmailrc" fetchmail <&- 2>&1
12 | 


--------------------------------------------------------------------------------
/mail/target/bin/delalias:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=../scripts/helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | DATABASE=${DATABASE:-/tmp/docker-mailserver/postfix-virtual.cf}
 7 | 
 8 | EMAIL="${1}"
 9 | RECIPIENT="${2}"
10 | 
11 | function __usage { echo "Usage: delalias <alias@domain> <recipient@other>" ; }
12 | 
13 | [[ ${1:-} == 'help' ]] && { __usage ; exit 0 ; }
14 | 
15 | [[ -z ${EMAIL} ]] && { __usage ; errex "Error: No alias specified" ; }
16 | [[ -z ${RECIPIENT} ]] && { __usage ; errex "Error: No recipient specified" ; }
17 | [[ -s ${DATABASE} ]] || exit 0
18 | 
19 | sed -i \
20 |   -e "/^${EMAIL} *${RECIPIENT}$/d" \
21 |   -e "/^${EMAIL}/s/,${RECIPIENT}//g" \
22 |   -e "/^${EMAIL}/s/${RECIPIENT},//g" \
23 |   "${DATABASE}"
24 | 


--------------------------------------------------------------------------------
/mail/target/bin/delmailuser:
--------------------------------------------------------------------------------
  1 | #! /bin/bash
  2 | 
  3 | # shellcheck disable=SC2094
  4 | # ? This is done to ignore the message "Make sure not to read and write
  5 | # ? the same file in the same pipeline", which is a result of ${DATABASE}
  6 | # ? being used below. (This disables the message file-wide.)
  7 | 
  8 | # shellcheck source=../scripts/helper-functions.sh
  9 | . /usr/local/bin/helper-functions.sh
 10 | 
 11 | DATABASE=${DATABASE:-/tmp/docker-mailserver/postfix-accounts.cf}
 12 | ALIAS_DATABASE="/tmp/docker-mailserver/postfix-virtual.cf"
 13 | QUOTA_DATABASE="/tmp/docker-mailserver/dovecot-quotas.cf"
 14 | MAILDEL=false
 15 | 
 16 | function __usage
 17 | {
 18 |   echo -e "\e[35mDELMAILUSER\e[31m(\e[93m8\e[31m)
 19 | 
 20 | \e[38;5;214mNAME\e[39m
 21 |     delmailuser - delete a user and related data
 22 | 
 23 | \e[38;5;214mSYNOPSIS\e[39m
 24 |     ./setup.sh email del [ OPTIONS ] { <MAIL ADDRESS> \e[31m|\e[39m help }
 25 | 
 26 | \e[38;5;214mDESCRIPTION\e[39m
 27 |     Delete a mail user, aliases, quotas and mail data.
 28 | 
 29 | \e[38;5;214mOPTIONS\e[39m
 30 |     -y
 31 |         Indicate that \e[1mall mail data\e[22m is to be deleted without another prompt.
 32 | 
 33 |     -h
 34 |         Show this help dialogue.
 35 | 
 36 | \e[38;5;214mEXAMPLES\e[39m
 37 |     \e[37m./setup.sh email del woohoo@some-domain.org\e[39m
 38 |         Delete the mail user, quotas and aliases, but ask
 39 |         again whether mailbox data should be deleted.
 40 | 
 41 |     \e[37m./setup.sh email del -y test@domain.com\e[39m
 42 |         Delete all mail data for the users 'test' and do not
 43 |         prompt to ask if all mail data should be deleted.
 44 | 
 45 | \e[38;5;214mEXIT STATUS\e[39m
 46 |     Exit status is 0 if command was successful, and 1 if there was an error.
 47 | "
 48 | }
 49 | 
 50 | if [[ ${1} == 'help' ]]
 51 | then
 52 |   __usage
 53 |   exit 0
 54 | fi
 55 | 
 56 | while getopts ":yYh" OPT
 57 | do
 58 |   case ${OPT} in
 59 |     y | Y )
 60 |       MAILDEL=true
 61 |       ;;
 62 | 
 63 |     h )
 64 |       __usage
 65 |       exit 0
 66 |       ;;
 67 | 
 68 |     * )
 69 |       __usage
 70 |       errex "The option ${OPT} is unknown."
 71 |       ;;
 72 | 
 73 |   esac
 74 | done
 75 | shift $((OPTIND-1))
 76 | 
 77 | [[ -z ${*} ]] && { __usage ; errex "No user specifed" ; }
 78 | [[ -s ${DATABASE} ]] || exit 0
 79 | 
 80 | if ! ${MAILDEL}
 81 | then
 82 |   read -r -p "Do you want to delete the mailbox as well (removing all mails) ? [Y/n] " MAILDEL_CHOSEN
 83 |   if [[ ${MAILDEL_CHOSEN} =~ (y|Y|yes|Yes) ]] || [[ -z ${MAILDEL_CHOSEN} ]]
 84 |   then
 85 |     MAILDEL=true
 86 |   fi
 87 | fi
 88 | 
 89 | (
 90 |   flock -e 200
 91 | 
 92 |   ERROR=false
 93 |   EMAIL="${*}"
 94 | 
 95 |   # very simple plausibility check
 96 |   [[ ${EMAIL} != *@*.* ]] && errex "No valid address: ${EMAIL}"
 97 | 
 98 |   USER="${EMAIL%@*}"
 99 |   DOMAIN="${EMAIL#*@}"
100 | 
101 |   # ${EMAIL} must not contain /s and other syntactic characters
102 |   UNESCAPED_EMAIL="${EMAIL}"
103 |   EMAIL=$(escape "${EMAIL}")
104 | 
105 |   if [[ -f ${DATABASE} ]]
106 |   then
107 |     if ! sed -i "/^${EMAIL}|/d" "${DATABASE}"
108 |     then
109 |       echo "${UNESCAPED_EMAIL} couldn't be deleted in ${DATABASE}." >&2
110 |       ERROR=true
111 |     fi
112 |   fi
113 | 
114 |   if [[ -f ${ALIAS_DATABASE} ]]
115 |   then
116 |     # delete all aliases where the user is the only recipient( " ${EMAIL}" )
117 |     # delete user only for all aliases that deliver to multiple recipients ( ",${EMAIL}" "${EMAIL,}" )
118 |     if sed -i \
119 |       -e "/ ${EMAIL}$/d" -e "s/,${EMAIL}//g" -e "s/${EMAIL},//g" \
120 |       "${ALIAS_DATABASE}"
121 |     then
122 |       echo "${UNESCAPED_EMAIL} and potential aliases deleted."
123 |     else
124 |       echo "Aliases for ${UNESCAPED_EMAIL} couldn't be deleted in ${ALIAS_DATABASE}." >&2
125 |       ERROR=true
126 |     fi
127 |   fi
128 | 
129 |   # remove quota directives
130 |   if [[ -f ${QUOTA_DATABASE} ]]
131 |   then
132 |     if ! sed -i -e "/^${EMAIL}:.*$/d" "${QUOTA_DATABASE}"
133 |     then
134 |       echo "Quota for ${UNESCAPED_EMAIL} couldn't be deleted in ${QUOTA_DATABASE}." >&2
135 |     fi
136 |   fi
137 | 
138 |   if ! ${MAILDEL}
139 |   then
140 |     echo "Leaving the mailbox untouched.
141 | If you want to delete it at a later point,
142 | use 'sudo docker exec mailserver rm -R /var/mail/${DOMAIN}/${USER}'"
143 |     exit 0
144 |   fi
145 | 
146 |   if [[ -e "/var/mail/${DOMAIN}/${USER}" ]]
147 |   then
148 |     if rm -R "/var/mail/${DOMAIN}/${USER}"
149 |     then
150 |       echo "Mailbox deleted."
151 |     else
152 |       echo "Mailbox couldn't be deleted." >&2
153 |       ERROR=true
154 |     fi
155 |   else
156 |     echo "Mailbox directory '/var/mail/${DOMAIN}/${USER}' did not exist." >&2
157 |     ERROR=true
158 |   fi
159 | 
160 |   ${ERROR} && errex 'See the messages above.'
161 | 
162 | ) 200< "${DATABASE}"
163 | 
164 | exit 0
165 | 


--------------------------------------------------------------------------------
/mail/target/bin/delquota:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=../scripts/helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | DATABASE=${DATABASE:-/tmp/docker-mailserver/dovecot-quotas.cf}
 7 | USER_DATABASE=${USER_DATABASE:-/tmp/docker-mailserver/postfix-accounts.cf}
 8 | 
 9 | function __usage { echo "Usage: delquota <username@domain>" ; }
10 | 
11 | [[ ${1:-} == 'help' ]] && { __usage ; exit 0 ; }
12 | 
13 | USER="${1}"
14 | 
15 | [[ -z ${USER} ]]  && { __usage ; errex "No username specified" ; }
16 | [[ "${USER}" =~ .*\@.* ]] || { __usage ; errex "Username must include the domain"; }
17 | 
18 | if ! grep -qE "^${USER}\|" "${USER_DATABASE}"
19 | then
20 |   __usage
21 |   errex "user ${USER} does not exist"
22 | fi
23 | 
24 | [[ -s ${DATABASE} ]] || exit 0
25 | 
26 | sed -i -e "/^${USER}:.*$/d" "${DATABASE}"
27 | 


--------------------------------------------------------------------------------
/mail/target/bin/excluderelaydomain:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=../scripts/helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | DATABASE=${DATABASE:-/tmp/docker-mailserver/postfix-relaymap.cf}
 7 | 
 8 | DOMAIN="${1}"
 9 | 
10 | function usage { echo "Usage: excluderelayhost <domain>" ; }
11 | 
12 | [[ -z ${DOMAIN} ]] && { usage ; errex "no domain specified" ; }
13 | 
14 | if grep -qi "^@${DOMAIN}" "${DATABASE}" 2>/dev/null
15 | then
16 |   sed -i "s/^@${DOMAIN}.*/@${DOMAIN}/" "${DATABASE}"
17 | else
18 |   echo -e "@${DOMAIN}" >> "${DATABASE}"
19 | fi
20 | 


--------------------------------------------------------------------------------
/mail/target/bin/fail2ban:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=../scripts/helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | function usage { echo "Usage: ${0} [<unban> <ip-address>]" ; }
 7 | 
 8 | unset JAILS
 9 | declare -a JAILS
10 | for LIST in $(fail2ban-client status | grep "Jail list" | cut -f2- | sed 's/,/ /g')
11 | do
12 |   JAILS+=("${LIST}")
13 | done
14 | 
15 | if [[ -z ${1} ]]
16 | then
17 | 
18 |   IP_COUNT=0
19 | 
20 |   for JAIL in "${JAILS[@]}"
21 |   do
22 |     BANNED_IP="$(iptables -L "f2b-${JAIL}" -n 2>/dev/null | grep -Eo '[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}' | grep -v '0.0.0.0')"
23 | 
24 |     if [[ -n ${BANNED_IP} ]]
25 |     then
26 |       echo "Banned in ${JAIL}: ${BANNED_IP//$'\n'/, }"
27 |       IP_COUNT=$(( IP_COUNT + 1 ))
28 |     fi
29 |   done
30 | 
31 |   if [[ ${IP_COUNT} -eq 0 ]]
32 |   then
33 |     echo "No IPs have been banned."
34 |   fi
35 | 
36 | else
37 | 
38 |   case ${1} in
39 | 
40 |     unban)
41 |       shift
42 |       if [[ -n ${1} ]]
43 |       then
44 | 
45 |         for JAIL in "${JAILS[@]}"
46 |         do
47 |           RESULT="$(fail2ban-client set "${JAIL}" unbanip "${@}" 2>&1)"
48 | 
49 |           [[ "${RESULT}" != *"is not banned"* ]] && [[ "${RESULT}" != *"NOK"* ]] && echo -e "Unbanned IP from ${JAIL}: ${RESULT}"
50 |         done
51 | 
52 |       else
53 |         echo "You need to specify an IP address. Run './setup.sh debug fail2ban' to get a list of banned IP addresses." >&2
54 |         exit 0
55 |       fi
56 |       ;;
57 | 
58 |     *)
59 |       usage
60 |       errex "unknown command: ${1}"
61 |       ;;
62 | 
63 |   esac
64 | 
65 | fi
66 | 
67 | exit 0
68 | 


--------------------------------------------------------------------------------
/mail/target/bin/fetchmailrc_split:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # Description: This script will split the content of /etc/fetchmailrc into
 4 | #              smaller fetchmailrc files per server [poll] entries. Each
 5 | #              separate fetchmailrc file is stored in /etc/fetchmailrc.d
 6 | #
 7 | #              The mail purpose for this is to work around what is known
 8 | #              as the Fetchmail IMAP idle issue.
 9 | #
10 | 
11 | FETCHMAILRC="/etc/fetchmailrc"
12 | FETCHMAILRCD="/etc/fetchmailrc.d"
13 | DEFAULT_FILE="${FETCHMAILRCD}/defaults"
14 | 
15 | if [[ ! -r "${FETCHMAILRC}" ]]
16 | then
17 |   echo "Error: File ${FETCHMAILRC} not found"
18 |   exit 1
19 | fi
20 | 
21 | if [[ ! -d ${FETCHMAILRCD} ]]
22 | then
23 |   if ! mkdir "${FETCHMAILRCD}"
24 |   then
25 |     echo "Error: Unable to create folder ${FETCHMAILRCD}"
26 |     exit 1
27 |   fi
28 | fi
29 | 
30 | COUNTER=0
31 | SERVER=0
32 | while read -r LINE
33 | do
34 |   if [[ ${LINE} =~ poll ]]
35 |   then
36 |     # If we read "poll" then we reached a new server definition
37 |     # We need to create a new file with fetchmail defaults from
38 |     # /etc/fetcmailrc
39 |     COUNTER=$((COUNTER+1))
40 |     SERVER=1
41 |     cat "${DEFAULT_FILE}" > "${FETCHMAILRCD}/fetchmail-${COUNTER}.rc"
42 |     echo "${LINE}" >> "${FETCHMAILRCD}/fetchmail-${COUNTER}.rc"
43 |   elif [[ ${SERVER} -eq 0 ]]
44 |   then
45 |     # We have not yet found "poll". Let's assume we are still reading
46 |     # the default settings from /etc/fetchmailrc file
47 |     echo "${LINE}" >> "${DEFAULT_FILE}"
48 |   else
49 |     # Just the server settings that need to be added to the specific rc.d file
50 |     echo "${LINE}" >> "${FETCHMAILRCD}/fetchmail-${COUNTER}.rc"
51 |   fi
52 | done < "${FETCHMAILRC}"
53 | 
54 | rm "${DEFAULT_FILE}"
55 | 


--------------------------------------------------------------------------------
/mail/target/bin/generate-dkim-config:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | touch /tmp/vhost.tmp
 4 | 
 5 | # if no keysize is provided, 2048 is default.
 6 | KEYSIZE=${1:-2048}
 7 | 
 8 | # Getting domains FROM mail accounts
 9 | if [[ -f /tmp/docker-mailserver/postfix-accounts.cf ]]
10 | then
11 |   # shellcheck disable=SC2034
12 |   while IFS=$'|' read -r LOGIN PASS
13 |   do
14 |     DOMAIN=$(echo "${LOGIN}" | cut -d @ -f2)
15 |     echo "${DOMAIN}" >>/tmp/vhost.tmp
16 |   done < <(grep -v "^\s*$\|^\s*\#" /tmp/docker-mailserver/postfix-accounts.cf || true)
17 | fi
18 | 
19 | # Getting domains FROM mail aliases
20 | if [[ -f /tmp/docker-mailserver/postfix-virtual.cf ]]
21 | then
22 |   # shellcheck disable=SC2034
23 |   while read -r FROM TO
24 |   do
25 |     UNAME=$(echo "${FROM}" | cut -d @ -f1)
26 |     DOMAIN=$(echo "${FROM}" | cut -d @ -f2)
27 | 
28 |     test "${UNAME}" != "${DOMAIN}" && echo "${DOMAIN}" >>/tmp/vhost.tmp
29 |   done < <(grep -v "^\s*$\|^\s*\#" /tmp/docker-mailserver/postfix-virtual.cf || true)
30 | fi
31 | 
32 | # keeping unique entries
33 | if [[ -f /tmp/vhost.tmp ]]
34 | then
35 |   sort < /tmp/vhost.tmp | uniq >/tmp/vhost && rm /tmp/vhost.tmp
36 | fi
37 | 
38 | # exit if no entries found
39 | if [[ ! -f /tmp/vhost ]]
40 | then
41 |   echo "No entries found, no keys to make"
42 |   exit 0
43 | fi
44 | 
45 | while read -r DOMAINNAME
46 | do
47 |   mkdir -p "/tmp/docker-mailserver/opendkim/keys/${DOMAINNAME}"
48 | 
49 |   if [[ ! -f "/tmp/docker-mailserver/opendkim/keys/${DOMAINNAME}/mail.private" ]]
50 |   then
51 |     echo "Creating DKIM private key /tmp/docker-mailserver/opendkim/keys/${DOMAINNAME}/mail.private"
52 | 
53 |     opendkim-genkey --bits="${KEYSIZE}" --subdomains --DOMAIN="${DOMAINNAME}" --selector=mail -D "/tmp/docker-mailserver/opendkim/keys/${DOMAINNAME}"
54 |   fi
55 | 
56 |   # write to KeyTable if necessary
57 |   KEYTABLEENTRY="mail._domainkey.${DOMAINNAME} ${DOMAINNAME}:mail:/etc/opendkim/keys/${DOMAINNAME}/mail.private"
58 |   if [[ ! -f "/tmp/docker-mailserver/opendkim/KeyTable" ]]
59 |   then
60 |     echo "Creating DKIM KeyTable"
61 |     echo "${KEYTABLEENTRY}" > /tmp/docker-mailserver/opendkim/KeyTable
62 |   else
63 |     if ! grep -q "${KEYTABLEENTRY}" "/tmp/docker-mailserver/opendkim/KeyTable"
64 |     then
65 |         echo "${KEYTABLEENTRY}" >>/tmp/docker-mailserver/opendkim/KeyTable
66 |     fi
67 |   fi
68 | 
69 |   # write to SigningTable if necessary
70 |   SIGNINGTABLEENTRY="*@${DOMAINNAME} mail._domainkey.${DOMAINNAME}"
71 |   if [[ ! -f /tmp/docker-mailserver/opendkim/SigningTable ]]
72 |   then
73 |     echo "Creating DKIM SigningTable"
74 |     echo "*@${DOMAINNAME} mail._domainkey.${DOMAINNAME}" >/tmp/docker-mailserver/opendkim/SigningTable
75 |   else
76 |     if ! grep -q "${SIGNINGTABLEENTRY}" /tmp/docker-mailserver/opendkim/SigningTable
77 |     then
78 |       echo "${SIGNINGTABLEENTRY}" >> /tmp/docker-mailserver/opendkim/SigningTable
79 |     fi
80 |   fi
81 | done < <(grep -vE '^(\s*$|#)' /tmp/vhost)
82 | 
83 | # creates TrustedHosts if missing
84 | if [[ -d /tmp/docker-mailserver/opendkim ]] && [[ ! -f /tmp/docker-mailserver/opendkim/TrustedHosts ]]
85 | then
86 |   echo "Creating DKIM TrustedHosts"
87 |   echo "127.0.0.1" >/tmp/docker-mailserver/opendkim/TrustedHosts
88 |   echo "localhost" >>/tmp/docker-mailserver/opendkim/TrustedHosts
89 | fi
90 | 


--------------------------------------------------------------------------------
/mail/target/bin/generate-dkim-domain:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | set -e
 4 | 
 5 | if [[ ${#} -ne 1 ]]
 6 | then
 7 |   echo "${0}: usage: generate-dkim-domain domain"
 8 |   exit 1
 9 | fi
10 | 
11 | DOMAINNAME=${1}
12 | mkdir -p "/tmp/docker-mailserver/opendkim/keys/${DOMAINNAME}"
13 | 
14 | if [[ ! -f "/tmp/docker-mailserver/opendkim/keys/${DOMAINNAME}/mail.private" ]]
15 | then
16 |   echo "Creating DKIM private key /tmp/docker-mailserver/opendkim/keys/${DOMAINNAME}/mail.private"
17 |   opendkim-genkey --subdomains --domain="${DOMAINNAME}" --selector=mail -D "/tmp/docker-mailserver/opendkim/keys/${DOMAINNAME}"
18 | fi
19 | 
20 | # Write to KeyTable if necessary
21 | KEYTABLEENTRY="mail._domainkey.${DOMAINNAME} ${DOMAINNAME}:mail:/etc/opendkim/keys/${DOMAINNAME}/mail.private"
22 | if [[ ! -f "/tmp/docker-mailserver/opendkim/KeyTable" ]]
23 | then
24 |   echo "Creating DKIM KeyTable"
25 |   echo "${KEYTABLEENTRY}" > /tmp/docker-mailserver/opendkim/KeyTable
26 | else
27 |   if ! grep -q "${KEYTABLEENTRY}" "/tmp/docker-mailserver/opendkim/KeyTable"
28 |   then
29 |     echo "${KEYTABLEENTRY}" >> /tmp/docker-mailserver/opendkim/KeyTable
30 |   fi
31 | fi
32 | 
33 | # Write to SigningTable if necessary
34 | SIGNINGTABLEENTRY="*@${DOMAINNAME} mail._domainkey.${DOMAINNAME}"
35 | if [[ ! -f /tmp/docker-mailserver/opendkim/SigningTable ]]
36 | then
37 |   echo "Creating DKIM SigningTable"
38 |   echo "*@${DOMAINNAME} mail._domainkey.${DOMAINNAME}" > /tmp/docker-mailserver/opendkim/SigningTable
39 | else
40 |   if ! grep -q "${SIGNINGTABLEENTRY}" "/tmp/docker-mailserver/opendkim/SigningTable"
41 |   then
42 |     echo "${SIGNINGTABLEENTRY}" >>/tmp/docker-mailserver/opendkim/SigningTable
43 |   fi
44 | fi
45 | 


--------------------------------------------------------------------------------
/mail/target/bin/generate-ssl-certificate:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | set -e
 4 | 
 5 | # check if FQDN was passed as arguement in setup.sh
 6 | if [[ -z ${1} ]]
 7 | then
 8 |   FQDN="$(hostname --fqdn)"
 9 | else
10 |   FQDN="${1}"
11 | fi
12 | 
13 | SSL_CFG_PATH="/tmp/docker-mailserver/ssl"
14 | 
15 | if [[ ! -d ${SSL_CFG_PATH} ]]
16 | then
17 |   mkdir --parents "${SSL_CFG_PATH}"
18 | fi
19 | 
20 | cd "${SSL_CFG_PATH}" || { echo "cd ${SSL_CFG_PATH} error" ; exit ; }
21 | 
22 | # Create CA certificate
23 | /usr/lib/ssl/misc/CA.pl -newca
24 | 
25 | # Create an unpassworded private key and create an unsigned public key certificate
26 | openssl req -new -nodes -keyout "${SSL_CFG_PATH}"/"${FQDN}"-key.pem -out "${SSL_CFG_PATH}"/"${FQDN}"-req.pem -days 3652
27 | 
28 | # Sign the public key certificate with CA certificate
29 | openssl ca -out "${SSL_CFG_PATH}"/"${FQDN}"-cert.pem -infiles "${SSL_CFG_PATH}"/"${FQDN}"-req.pem
30 | 
31 | # Combine certificates for courier
32 | cat "${SSL_CFG_PATH}"/"${FQDN}"-key.pem "${SSL_CFG_PATH}"/"${FQDN}"-cert.pem > "${SSL_CFG_PATH}"/"${FQDN}"-combined.pem
33 | 


--------------------------------------------------------------------------------
/mail/target/bin/listalias:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=../scripts/helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | DATABASE=${DATABASE:-/tmp/docker-mailserver/postfix-virtual.cf}
 7 | 
 8 | [[ -f ${DATABASE} ]] || errex "Error: No postfix-virtual.cf file"
 9 | [[ -s ${DATABASE} ]] || errex "Error: Empty postfix-virtual.cf - no aliases have been added"
10 | 
11 | grep -v "^\s*$\|^\s*\#" "${DATABASE}"
12 | exit 0
13 | 


--------------------------------------------------------------------------------
/mail/target/bin/listmailuser:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=../scripts/helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | DATABASE=${DATABASE:-/tmp/docker-mailserver/postfix-accounts.cf}
 7 | 
 8 | [[ -f ${DATABASE} ]] || errex "Error: No postfix-virtual.cf file"
 9 | [[ -s ${DATABASE} ]] || errex "Error: Empty postfix-virtual.cf - no aliases have been added"
10 | 
11 | { grep -v "^\s*$\|^\s*\#" "${DATABASE}" || true ; } | awk -F '|' '{ print $1; }'
12 | exit 0
13 | 


--------------------------------------------------------------------------------
/mail/target/bin/open-dkim:
--------------------------------------------------------------------------------
  1 | #! /bin/bash
  2 | 
  3 | KEYSIZE=4096
  4 | SELECTOR=mail
  5 | DOMAINS=
  6 | 
  7 | function __usage
  8 | {
  9 |   printf "\e[35mOPEN-DKIM\e[31m(\e[93m8\e[31m)
 10 | 
 11 | \e[38;5;214mNAME\e[39m
 12 |     open-dkim - configure DomainKeys Identified Mail (DKIM)
 13 | 
 14 | \e[38;5;214mSYNOPSIS\e[39m
 15 |     ./setup.sh config dkim [ OPTIONS\e[31m...\e[39m ]
 16 | 
 17 | \e[38;5;214mDESCRIPTION\e[39m
 18 |     Configures DKIM keys. OPTIONS can be used to configure a more complex setup.
 19 |     LDAP setups require these options.
 20 | 
 21 | \e[38;5;214mOPTIONS\e[39m
 22 |     \e[94mGeneric Program Information\e[39m
 23 |         help       Print the usage information.
 24 | 
 25 |     \e[94mConfiguration adjustments\e[39m
 26 |         keysize    Set the size of the keys to be generated. Possible are 1024, 2024 and 4096 (default).
 27 |         selector   Set a manual selector (default is 'mail') for the key. (\e[96mATTENTION\e[39m: NOT IMPLEMENTED YET!)
 28 |         domain     Provide the domain(s) for which keys are to be generated.
 29 | 
 30 | \e[38;5;214mEXAMPLES\e[39m
 31 |     \e[37m./setup.sh config dkim keysize 2048\e[39m
 32 |         Creates keys of length 2048 bit in a default setup where domains are obtained from
 33 |         your accounts.
 34 | 
 35 |     \e[37m./setup.sh config dkim keysize 2048 selector 2021-dkim\e[39m
 36 |         Creates keys of length 2048 bit in a default setup where domains are obtained from
 37 |         your accounts. The DKIM selector used is '2021-dkim'.
 38 | 
 39 |     \e[37m./setup.sh config dkim keysize 2048 selector 2021-dkim domain 'whoami.com,whoareyou.org'\e[39m
 40 |         Appropriate for an LDAP setup. Creates keys of length 2048 bit in a default setup
 41 |         where domains are obtained from your accounts. The DKIM selector used is '2021-dkim'.
 42 |         The domains for which DKIM keys are generated are 'whoami.com' and 'whoareyou.org'.
 43 | 
 44 | \e[38;5;214mEXIT STATUS\e[39m
 45 |     Exit status is 0 if command was successful. If wrong arguments are provided or arguments contain
 46 |     errors, the script will exit early with exit status 2.
 47 | 
 48 | "
 49 | }
 50 | 
 51 | [[ ${1:-} == 'help' ]] && { __usage ; exit 0 ; }
 52 | 
 53 | while [[ ${#} -gt 0 ]]
 54 | do
 55 |   case ${1} in
 56 |     keysize )
 57 |       if [[ -n ${2+'set'} ]]
 58 |       then
 59 |         KEYSIZE="${2}"
 60 |         shift
 61 |         shift
 62 |       else
 63 |         echo "No keysize provided after 'keysize' argument. Aborting." >&2
 64 |         exit 2
 65 |       fi
 66 |       ;;
 67 | 
 68 |     selector )
 69 |       if [[ -n ${2+'set'} ]]
 70 |       then
 71 |         # shellcheck disable=SC2034
 72 |         SELECTOR="${2}"
 73 |         shift
 74 |         shift
 75 |       else
 76 |         echo "No selector provided after 'selector' argument. Aborting." >&2
 77 |         exit 2
 78 |       fi
 79 |       ;;
 80 | 
 81 |     domain )
 82 |       if [[ -n ${2+'set'} ]]
 83 |       then
 84 |         DOMAINS="${2}"
 85 |         shift
 86 |         shift
 87 |       else
 88 |         echo "No domain(s) provided after 'domain' argument. Aborting." >&2
 89 |         exit 2
 90 |       fi
 91 |       ;;
 92 | 
 93 |     * )
 94 |       __usage
 95 |       echo -e "\nUnknown options ${1} ${2:-}. Aborting." >&2
 96 |       exit 2
 97 |       ;;
 98 | 
 99 |   esac
100 | done
101 | 
102 | touch /tmp/vhost.dkim.tmp
103 | 
104 | if [[ -z ${DOMAINS} ]]
105 | then
106 |   # getting domains FROM mail accounts
107 |   if [[ -f /tmp/docker-mailserver/postfix-accounts.cf ]]
108 |   then
109 |     # shellcheck disable=SC2034
110 |     while IFS=$'|' read -r LOGIN PASS
111 |     do
112 |       DOMAIN=$(echo "${LOGIN}" | cut -d @ -f2)
113 |       echo "${DOMAIN}" >>/tmp/vhost.dkim.tmp
114 |     done < <(grep -v "^\s*$\|^\s*\#" /tmp/docker-mailserver/postfix-accounts.cf || true)
115 |   fi
116 | 
117 |   # getting domains FROM mail aliases
118 |   if [[ -f /tmp/docker-mailserver/postfix-virtual.cf ]]
119 |   then
120 |     # shellcheck disable=SC2034
121 |     while read -r FROM TO
122 |     do
123 |       UNAME=$(echo "${FROM}" | cut -d @ -f1)
124 |       DOMAIN=$(echo "${FROM}" | cut -d @ -f2)
125 | 
126 |       [[ ${UNAME} != "${DOMAIN}" ]] && echo "${DOMAIN}" >>/tmp/vhost.dkim.tmp
127 |     done < <(grep -v "^\s*$\|^\s*\#" /tmp/docker-mailserver/postfix-virtual.cf || true)
128 |   fi
129 | else
130 |   tr ',' '\n' <<< "${DOMAINS}" > /tmp/vhost.dkim.tmp
131 | fi
132 | 
133 | sort < /tmp/vhost.dkim.tmp | uniq >/tmp/vhost
134 | rm /tmp/vhost.dkim.tmp
135 | 
136 | if [[ ! -s /tmp/vhost ]]
137 | then
138 |   echo "No entries found, no keys to make."
139 |   exit 0
140 | fi
141 | 
142 | while read -r DOMAINNAME
143 | do
144 |   mkdir -p "/tmp/docker-mailserver/opendkim/keys/${DOMAINNAME}"
145 | 
146 |   if [[ ! -f "/tmp/docker-mailserver/opendkim/keys/${DOMAINNAME}/${SELECTOR}.private" ]]
147 |   then
148 |     echo "Creating DKIM private key /tmp/docker-mailserver/opendkim/keys/${DOMAINNAME}/${SELECTOR}.private"
149 | 
150 |     opendkim-genkey \
151 |       --bits="${KEYSIZE}" \
152 |       --subdomains \
153 |       --DOMAIN="${DOMAINNAME}" \
154 |       --selector="${SELECTOR}" \
155 |       -D "/tmp/docker-mailserver/opendkim/keys/${DOMAINNAME}"
156 |   fi
157 | 
158 |   # write to KeyTable if necessary
159 |   KEYTABLEENTRY="${SELECTOR}._domainkey.${DOMAINNAME} ${DOMAINNAME}:${SELECTOR}:/etc/opendkim/keys/${DOMAINNAME}/${SELECTOR}.private"
160 |   if [[ ! -f "/tmp/docker-mailserver/opendkim/KeyTable" ]]
161 |   then
162 |     echo "Creating DKIM KeyTable"
163 |     echo "${KEYTABLEENTRY}" >/tmp/docker-mailserver/opendkim/KeyTable
164 |   else
165 |     if ! grep -q "${KEYTABLEENTRY}" "/tmp/docker-mailserver/opendkim/KeyTable"
166 |     then
167 |       echo "${KEYTABLEENTRY}" >>/tmp/docker-mailserver/opendkim/KeyTable
168 |     fi
169 |   fi
170 | 
171 |   # write to SigningTable if necessary
172 |   SIGNINGTABLEENTRY="*@${DOMAINNAME} ${SELECTOR}._domainkey.${DOMAINNAME}"
173 |   if [[ ! -f /tmp/docker-mailserver/opendkim/SigningTable ]]
174 |   then
175 |     echo "Creating DKIM SigningTable"
176 |     echo "*@${DOMAINNAME} ${SELECTOR}._domainkey.${DOMAINNAME}" >/tmp/docker-mailserver/opendkim/SigningTable
177 |   else
178 |     if ! grep -q "${SIGNINGTABLEENTRY}" /tmp/docker-mailserver/opendkim/SigningTable
179 |     then
180 |       echo "${SIGNINGTABLEENTRY}" >>/tmp/docker-mailserver/opendkim/SigningTable
181 |     fi
182 |   fi
183 | done < <(grep -vE '^(\s*$|#)' /tmp/vhost)
184 | 
185 | # create TrustedHosts if missing
186 | if [[ -d /tmp/docker-mailserver/opendkim ]] && [[ ! -f /tmp/docker-mailserver/opendkim/TrustedHosts ]]
187 | then
188 |   echo "Creating DKIM TrustedHosts"
189 |   echo "127.0.0.1" >/tmp/docker-mailserver/opendkim/TrustedHosts
190 |   echo "localhost" >>/tmp/docker-mailserver/opendkim/TrustedHosts
191 | fi
192 | 


--------------------------------------------------------------------------------
/mail/target/bin/postfix-summary:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=../scripts/helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | HOSTNAME=${1}
 7 | RECIPIENT=${2}
 8 | SENDER=${3}
 9 | 
10 | [[ -x /usr/sbin/pflogsumm ]] || errex "Critical: /usr/sbin/pflogsumm not found"
11 | 
12 | # The case that the mail.log.1 file isn't readable shouldn't
13 | # actually be possible with logrotate not rotating empty files..
14 | # But you never know!
15 | if [[ -r "/var/log/mail/mail.log.1" ]]
16 | then
17 |   BODY=$(/usr/sbin/pflogsumm /var/log/mail/mail.log.1 --problems-first)
18 | else
19 |   BODY="Error: Mail log not readable or not found: /var/log/mail/mail.log.1
20 | 
21 | In case of mail inactivity since the last report, this might be considered a nuisance warning.
22 | 
23 | Yours faithfully,
24 | The ${HOSTNAME} Mailserver"
25 | fi
26 | 
27 | sendmail -t <<EOF
28 | From: ${SENDER}
29 | To: ${RECIPIENT}
30 | Subject: Postfix Summary for ${HOSTNAME}
31 | Content-Transfer-Encoding: 8bit
32 | Content-Type: text/plain; charset=UTF-8
33 | 
34 | ${BODY}
35 | EOF
36 | 


--------------------------------------------------------------------------------
/mail/target/bin/report-pflogsumm-yesterday:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=../scripts/helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | set -o errexit
 7 | set -o pipefail
 8 | set -o nounset
 9 | 
10 | HOSTNAME=${1}
11 | RECIPIENT=${2}
12 | SENDER=${3}
13 | 
14 | [[ -x /usr/sbin/pflogsumm ]] || errex "Critical: /usr/sbin/pflogsumm not found"
15 | 
16 | # shellcheck disable=SC2046
17 | BODY=$(gzip -cdfq $(ls -tr /var/log/mail/mail.log*) | /usr/sbin/pflogsumm --problems_first -d yesterday)
18 | 
19 | sendmail -t <<EOF
20 | From: ${SENDER}
21 | To: ${RECIPIENT}
22 | Subject: Postfix summary for ${HOSTNAME} sent $(date '+%Y-%m-%d_%H%M%S')
23 | Content-Transfer-Encoding: 8bit
24 | Content-Type: text/plain; charset=UTF-8
25 | 
26 | ${BODY}
27 | EOF
28 | 


--------------------------------------------------------------------------------
/mail/target/bin/restrict-access:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=../scripts/helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | MODE="${1}"
 7 | USER="${3}"
 8 | 
 9 | function usage  {	echo "Usage: ${0} <add|del|list> <send|receive> [<email@domain.com>]" ; }
10 | 
11 | [[ -z ${MODE} ]] && errex "missing parameters: <add|del|list> <send|receive> [<email@domain.com>]"
12 | 
13 | case ${2} in
14 |   send)
15 |     DATABASE="/tmp/docker-mailserver/postfix-send-access.cf"
16 |     ;;
17 |   receive)
18 |     DATABASE="/tmp/docker-mailserver/postfix-receive-access.cf"
19 |     ;;
20 |   *)
21 |     usage
22 |     errex "missing parameters. Specify \"send\" or \"receive\""
23 |     ;;
24 | esac
25 | 
26 | if [[ -z ${USER} ]] && [[ ${MODE} != list ]]
27 | then
28 |   read -r -p "User(user@domain.com): " USER
29 |   echo
30 |   [[ -z ${USER} ]] && errex "User must not be empty"
31 | fi
32 | 
33 | case ${MODE} in
34 |   add)
35 |     grep -qi "^$(escape "${USER}")" "${DATABASE}" 2>/dev/null && errex "User \"${USER}\" already denied to ${2} mails"
36 | 
37 |     if [[ ! -f ${DATABASE} ]]
38 |     then
39 |       # shellcheck disable=SC2015
40 |       [[ ${DATABASE} = *"send"* ]] && \
41 |           sed -i 's|smtpd_sender_restrictions =|smtpd_sender_restrictions = check_sender_access texthash:/tmp/docker-mailserver/postfix-send-access.cf,|' /etc/postfix/main.cf \
42 |         || sed -i 's|smtpd_recipient_restrictions =|smtpd_recipient_restrictions = check_recipient_access texthash:/tmp/docker-mailserver/postfix-receive-access.cf,|' /etc/postfix/main.cf
43 | 
44 |       service postfix reload >/dev/null
45 |     fi
46 | 
47 |     echo -e "${USER} \t\t REJECT" >>"${DATABASE}"
48 |   ;;
49 | 
50 |   del)
51 |     sed -ie "/^$(escape "${USER}")/d" "${DATABASE}" 2>/dev/null || errex "User \"${USER}\" not found."
52 |   ;;
53 | 
54 |   list)
55 |     grep "REJECT" "${DATABASE}" 2>/dev/null || echo "Everyone is allowed to ${2} mails."
56 |     ;;
57 |   *)
58 |     usage
59 |     errex "missing mode. Specify \"add\", \"del\" or \"list\""
60 |   ;;
61 | 
62 | esac
63 | 


--------------------------------------------------------------------------------
/mail/target/bin/setquota:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # ? This is done to ignore the message "Make sure not to read and write
 4 | # ? the same file in the same pipeline", which is a result of ${DATABASE}
 5 | # ? being used below. (This disables the message file-wide.)
 6 | # shellcheck disable=SC2094
 7 | 
 8 | # shellcheck source=../scripts/helper-functions.sh
 9 | . /usr/local/bin/helper-functions.sh
10 | 
11 | DATABASE=${DATABASE:-/tmp/docker-mailserver/dovecot-quotas.cf}
12 | USER_DATABASE=${USER_DATABASE:-/tmp/docker-mailserver/postfix-accounts.cf}
13 | 
14 | USER="${1}"
15 | shift
16 | QUOTA="${*}"
17 | 
18 | function usage  { echo "Usage: setquota <user@domain> [<quota>]" ; }
19 | 
20 | [[ -z ${USER} ]] && { usage ; errex "no username specified" ; }
21 | [[ "${USER}" =~ .*\@.* ]] || { usage ; errex "username must include the domain" ; }
22 | 
23 | if ! grep -qE "^${USER}\|" "${USER_DATABASE}"
24 | then
25 |   usage; errex "user ${USER} does not exist"
26 | fi
27 | 
28 | # check quota
29 | if [[ -n ${QUOTA} ]] && ! echo "${QUOTA}" | grep -qE "^([0-9]+(B|k|M|G|T)|0)\$"
30 | then
31 |   usage
32 |   errex "invalid quota format. e.g. 302M (B (byte), k (kilobyte), M (megabyte), G (gigabyte) or T (terabyte))"
33 | fi
34 | 
35 | # Protect config file with lock to avoid race conditions
36 | touch "${DATABASE}"
37 | (
38 |   flock -e 200
39 | 
40 |   if [ -z "${QUOTA}" ]; then
41 |     read -r -s "Enter quota (e.g. 10M): " QUOTA
42 |     echo
43 |     [[ -z "${QUOTA}" ]] && errex "Quota must not be empty. Use 0 for unlimited quota"
44 |   fi
45 | 
46 |   # check quota
47 |   if [[ -n ${QUOTA} ]] && ! echo "${QUOTA}" | grep -qE "^([0-9]+(B|k|M|G|T)|0)\$"
48 |   then
49 |     usage
50 |     errex "invalid quota format. e.g. 302M (B (byte), k (kilobyte), M (megabyte), G (gigabyte) or T (terabyte))"
51 |   fi
52 | 
53 |   delquota "${USER}"
54 |   echo "${USER}:${QUOTA}" >>"${DATABASE}"
55 | ) 200< "${DATABASE}"
56 | 
57 | 


--------------------------------------------------------------------------------
/mail/target/bin/setup-fetchmail:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | CONF=/tmp/docker-mailserver/fetchmail.cf
 4 | RC=/etc/fetchmailrc
 5 | 
 6 | if [[ -f ${CONF} ]]
 7 | then
 8 |   cat /etc/fetchmailrc_general "${CONF}" >"${RC}"
 9 | else
10 |   cat /etc/fetchmailrc_general >"${RC}"
11 | fi
12 | 
13 | chmod 700 "${RC}"
14 | chown fetchmail:root "${RC}"
15 | 


--------------------------------------------------------------------------------
/mail/target/bin/updatemailuser:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # ? This is done to ignore the message "Make sure not to read and write
 4 | # ? the same file in the same pipeline", which is a result of ${DATABASE}
 5 | # ? being used below. (This disables the message file-wide.)
 6 | # shellcheck disable=SC2094
 7 | 
 8 | # shellcheck source=../scripts/helper-functions.sh
 9 | . /usr/local/bin/helper-functions.sh
10 | 
11 | DATABASE=${DATABASE:-/tmp/docker-mailserver/postfix-accounts.cf}
12 | 
13 | USER="${1}"
14 | shift
15 | PASSWD="${*}"
16 | 
17 | function usage  {	echo "Usage: updatemailuser <user@domain.tld> [password]" ; }
18 | 
19 | [[ -z ${USER} ]] && { usage ; errex "no username specified" ; }
20 | 
21 | if [[ -z ${PASSWD} ]]
22 | then
23 |   read -r -s -p "Enter Password: " PASSWD
24 |   echo
25 |   [[ -z ${PASSWD} ]] && errex "Password must not be empty"
26 | fi
27 | 
28 | HASH="$(doveadm pw -s SHA512-CRYPT -u "${USER}" -p "${PASSWD}")"
29 | 
30 | # Protect config file with lock to avoid race conditions
31 | (
32 |   flock -e 200
33 |   grep -qi "^$(escape "${USER}")|" "${DATABASE}" 2>/dev/null || errex "User \"${USER}\" does not exist"
34 |   sed -i "s ^""${USER}""|.* ""${USER}""|""${HASH}"" " "${DATABASE}"
35 | ) 200< "${DATABASE}"
36 | 


--------------------------------------------------------------------------------
/mail/target/bin/virus-wiper:
--------------------------------------------------------------------------------
1 | #! /bin/bash
2 | 
3 | find /var/lib/amavis/virusmails/ -type f -mtime +"${VIRUSMAILS_DELETE_DELAY}" -delete
4 | 


--------------------------------------------------------------------------------
/mail/target/docker-configomat/configomat.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | _version="0.0.0"
 4 | 
 5 | configomat_do_work() {
 6 | 	echo -e "\nStarting to do overrides:"
 7 | 
 8 | 	declare -A config_overrides
 9 | 
10 | 	_env_variable_prefix=$1
11 | 	[ -z ${_env_variable_prefix} ] && \
12 |     echo "I could not find the env prefix. Exiting ..." && \
13 | 	return 1
14 | 
15 | 	IFS=" " read -r -a _config_files <<< $2
16 | 
17 | 	_tmpf=$(mktemp /tmp/configomat.XXXXXX) || exit 1
18 | 
19 | 	printenv | grep $_env_variable_prefix > $_tmpf
20 | 
21 | 	# dispatch env variables
22 | 	# for env_variable in $(printenv | grep $_env_variable_prefix);do
23 | 	while read env_variable
24 | 	do
25 | 		# get key
26 | 		# IFS not working because values like ldap_query_filter or search base consists of several '='
27 | 		# IFS="=" read -r -a __values <<< $env_variable
28 | 		# key="${__values[0]}"
29 | 		# value="${__values[1]}"
30 | 		key="$(echo $env_variable | cut -d '=' -f1)"
31 | 		key=${key#"${_env_variable_prefix}"}
32 | 		# make key lowercase
33 | 		key=${key,,}
34 | 		# get value
35 | 		value="$(echo $env_variable | cut -d '=' -f2-)"
36 | 		config_overrides[$key]="$value"
37 | 	done <$_tmpf
38 | 
39 | 	rm -f $_tmpf
40 | 
41 | 	for f in "${_config_files[@]}"
42 | 	do
43 | 		if [ ! -f "${f}" ];then
44 | 			echo "Can not find ${f}. Skipping override"
45 | 		else
46 | 			for key in ${!config_overrides[@]}
47 | 			do
48 | 				[ -z $key ] && echo -e "\t no key provided" && return 1
49 | 
50 | 				echo "  >> $f: $key = ${config_overrides[$key]}"
51 | 
52 | 				# Escape special characters
53 | 				config_overrides[$key]="$((echo ${config_overrides[$key]}|sed -r 's/([\=\&\|\$\.\*\/\[\\^])/\\\1/g'|sed 's/[]]/\\]/g')>&1)"
54 | 
55 | 				sed -i -e "s|^${key}[[:space:]]\+.*|${key} = ${config_overrides[$key]}|g" \
56 | 				${f}
57 | 
58 | 			done
59 | 		fi
60 | 	done
61 |   return 0
62 | }
63 | 
64 | echo -e "\nConfig'O'mat. Version $_version"
65 | 
66 | # Initial Checks
67 | [[ "$#" -ne 2 ]] && echo "I need two arguments: Env prefix (e.g. CONFIGOMAT_) and " \
68 |                          "the file to parse. Exiting ..." && exit 1
69 | 
70 | [[ ! -f "$2" ]] && echo "The file could not be found: $2. Exiting ..." && exit 1
71 | 
72 | echo "-------------------"
73 | echo "Got the ENV_PREFIX: $1"
74 | echo "Got the CONF_FILE:  $2"
75 | echo "-------------------"
76 | 
77 | configomat_do_work $1 $2
78 | exit $?


--------------------------------------------------------------------------------
/mail/target/dovecot/10-master.conf:
--------------------------------------------------------------------------------
  1 | #default_process_limit = 100
  2 | #default_client_limit = 1000
  3 | 
  4 | # Default VSZ (virtual memory size) limit for service processes. This is mainly
  5 | # intended to catch and kill processes that leak memory before they eat up
  6 | # everything.
  7 | #default_vsz_limit = 256M
  8 | 
  9 | # Login user is internally used by login processes. This is the most untrusted
 10 | # user in Dovecot system. It shouldn't have access to anything at all.
 11 | #default_login_user = dovenull
 12 | 
 13 | # Internal user is used by unprivileged processes. It should be separate from
 14 | # login user, so that login processes can't disturb other processes.
 15 | #default_internal_user = dovecot
 16 | 
 17 | service imap-login {
 18 |   inet_listener imap {
 19 |     #port = 143
 20 |   }
 21 |   inet_listener imaps {
 22 |     #port = 993
 23 |     #ssl = yes
 24 |   }
 25 | 
 26 |   # Number of connections to handle before starting a new process. Typically
 27 |   # the only useful values are 0 (unlimited) or 1. 1 is more secure, but 0
 28 |   # is faster. <doc/wiki/LoginProcess.txt>
 29 |   #service_count = 1
 30 | 
 31 |   # Number of processes to always keep waiting for more connections.
 32 |   #process_min_avail = 0
 33 | 
 34 |   # If you set service_count=0, you probably need to grow this.
 35 |   #vsz_limit = $default_vsz_limit
 36 | }
 37 | 
 38 | service pop3-login {
 39 |   inet_listener pop3 {
 40 |     #port = 110
 41 |   }
 42 |   inet_listener pop3s {
 43 |     #port = 995
 44 |     #ssl = yes
 45 |   }
 46 | }
 47 | 
 48 | service lmtp {
 49 |   unix_listener lmtp {
 50 |     mode = 0660
 51 |     group = postfix
 52 |   }
 53 | 
 54 |   # Create inet listener only if you can't use the above UNIX socket
 55 |   #inet_listener lmtp {
 56 |     # Avoid making LMTP visible for the entire internet
 57 |     #address =
 58 |     #port =
 59 |   #}
 60 | }
 61 | 
 62 | service imap {
 63 |   # Most of the memory goes to mmap()ing files. You may need to increase this
 64 |   # limit if you have huge mailboxes.
 65 |   #vsz_limit = $default_vsz_limit
 66 | 
 67 |   # Max. number of IMAP processes (connections)
 68 |   #process_limit = 1024
 69 | }
 70 | 
 71 | service pop3 {
 72 |   # Max. number of POP3 processes (connections)
 73 |   #process_limit = 1024
 74 | }
 75 | 
 76 | service auth {
 77 |   # auth_socket_path points to this userdb socket by default. It's typically
 78 |   # used by dovecot-lda, doveadm, possibly imap process, etc. Users that have
 79 |   # full permissions to this socket are able to get a list of all usernames and
 80 |   # get the results of everyone's userdb lookups.
 81 |   #
 82 |   # The default 0666 mode allows anyone to connect to the socket, but the
 83 |   # userdb lookups will succeed only if the userdb returns an "uid" field that
 84 |   # matches the caller process's UID. Also if caller's uid or gid matches the
 85 |   # socket's uid or gid the lookup succeeds. Anything else causes a failure.
 86 |   #
 87 |   # To give the caller full permissions to lookup all users, set the mode to
 88 |   # something else than 0666 and Dovecot lets the kernel enforce the
 89 |   # permissions (e.g. 0777 allows everyone full permissions).
 90 |   unix_listener auth-userdb {
 91 |     mode = 0666
 92 |     user = docker
 93 |     group = docker
 94 |   }
 95 | 
 96 |   unix_listener auth-master {
 97 |     mode = 0600
 98 |     user = docker
 99 |     group = docker
100 |   }
101 | 
102 |   # Postfix smtp-auth
103 |   unix_listener /var/spool/postfix/private/auth {
104 |     mode = 0666
105 |     user = docker
106 |     group = docker
107 |   }
108 | 
109 |   # Auth process is run as this user.
110 |   #user = $default_internal_user
111 | }
112 | 
113 | service auth-worker {
114 |   # Auth worker process is run as root by default, so that it can access
115 |   # /etc/shadow. If this isn't necessary, the user should be changed to
116 |   # $default_internal_user.
117 |   #user = root
118 | }
119 | 
120 | service dict {
121 |   # If dict proxy is used, mail processes should have access to its socket.
122 |   # For example: mode=0660, group=vmail and global mail_access_groups=vmail
123 |   unix_listener dict {
124 |     # mode = 0600
125 |     # user = docker
126 |     # group = docker
127 |   }
128 | }


--------------------------------------------------------------------------------
/mail/target/dovecot/dovecot-dict-sql.conf.ext:
--------------------------------------------------------------------------------
 1 | # This file is commonly accessed via dict {} section in dovecot.conf
 2 | 
 3 | connect = "host={{SQL_HOSTS}} dbname={{SQL_DBNAME}} user={{SQL_USER}} password={{SQL_PASSWORD}}"
 4 | 
 5 | 
 6 | # CREATE TABLE quota (
 7 | #   username varchar(100) not null,
 8 | #   bytes bigint not null default 0,
 9 | #   messages integer not null default 0,
10 | #   primary key (username)
11 | # );
12 | 
13 | map {
14 |   pattern = priv/quota/storage
15 |   table = quota2
16 |   username_field = username
17 |   value_field = bytes
18 | }
19 | map {
20 |   pattern = priv/quota/messages
21 |   table = quota2
22 |   username_field = username
23 |   value_field = messages
24 | }
25 | 
26 | # CREATE TABLE expires (
27 | #   username varchar(100) not null,
28 | #   mailbox varchar(255) not null,
29 | #   expire_stamp integer not null,
30 | #   primary key (username, mailbox)
31 | # );
32 | 
33 | # map {
34 | #   pattern = shared/expire/$user/$mailbox
35 | #   table = expires
36 | #   value_field = expire_stamp
37 | 
38 | #   fields {
39 | #     username = $user
40 | #     mailbox = $mailbox
41 | #   }
42 | # }
43 | 


--------------------------------------------------------------------------------
/mail/target/dovecot/dovecot-sql.conf.ext:
--------------------------------------------------------------------------------
1 | driver 				= {{SQL_DRIVER}}
2 | connect 			= "host={{SQL_HOSTS}} dbname={{SQL_DBNAME}} user={{SQL_USER}} password={{SQL_PASSWORD}}"
3 | default_pass_scheme = {{SQL_PASS_SCHEME}}
4 | password_query 		= SELECT username AS user,password FROM mailbox WHERE username = '%u' AND active = TRUE
5 | user_query 			= SELECT CONCAT('/var/mail/', maildir) AS home, 5000 AS uid, 5000 AS gid, CONCAT('*:bytes=', quota) AS quota_rule FROM mailbox WHERE username = '%u' AND active = TRUE
6 | iterate_query 		= SELECT username AS user FROM mailbox


--------------------------------------------------------------------------------
/mail/target/fetchmail/fetchmailrc:
--------------------------------------------------------------------------------
1 | # General options
2 | 
3 | set daemon 300
4 | set syslog
5 | 
6 | # Fetch rules
7 | 
8 | 


--------------------------------------------------------------------------------
/mail/target/postfix/sql/alias_domain_catchall_maps.cf:
--------------------------------------------------------------------------------
1 | hosts = {{SQL_HOSTS}}
2 | dbname = {{SQL_DBNAME}}
3 | user = {{SQL_USER}}
4 | password = {{SQL_PASSWORD}}
5 | query  = SELECT goto FROM alias,alias_domain WHERE alias_domain.alias_domain = '%d' and alias.address = CONCAT('@', alias_domain.target_domain) AND alias.active = TRUE AND alias_domain.active = TRUE


--------------------------------------------------------------------------------
/mail/target/postfix/sql/alias_domain_mailbox_maps.cf:
--------------------------------------------------------------------------------
1 | hosts = {{SQL_HOSTS}}
2 | dbname = {{SQL_DBNAME}}
3 | user = {{SQL_USER}}
4 | password = {{SQL_PASSWORD}}
5 | query = SELECT maildir FROM mailbox,alias_domain WHERE alias_domain.alias_domain = '%d' and mailbox.username = CONCAT('%u', '@', alias_domain.target_domain) AND mailbox.active = TRUE AND alias_domain.active = TRUE


--------------------------------------------------------------------------------
/mail/target/postfix/sql/alias_domain_maps.cf:
--------------------------------------------------------------------------------
1 | hosts = {{SQL_HOSTS}}
2 | dbname = {{SQL_DBNAME}}
3 | user = {{SQL_USER}}
4 | password = {{SQL_PASSWORD}}
5 | query = SELECT goto FROM alias,alias_domain WHERE alias_domain.alias_domain = '%d' and alias.address = CONCAT('%u', '@', alias_domain.target_domain) AND alias.active = TRUE AND alias_domain.active = TRUE


--------------------------------------------------------------------------------
/mail/target/postfix/sql/alias_maps.cf:
--------------------------------------------------------------------------------
1 | hosts = {{SQL_HOSTS}}
2 | dbname = {{SQL_DBNAME}}
3 | user = {{SQL_USER}}
4 | password = {{SQL_PASSWORD}}
5 | query = SELECT goto FROM alias WHERE address='%s' AND active = TRUE
6 | #expansion_limit = 100


--------------------------------------------------------------------------------
/mail/target/postfix/sql/domains_maps.cf:
--------------------------------------------------------------------------------
 1 | hosts = {{SQL_HOSTS}}
 2 | dbname = {{SQL_DBNAME}}
 3 | user = {{SQL_USER}}
 4 | password = {{SQL_PASSWORD}}
 5 | query = SELECT domain FROM domain WHERE domain='%s' AND active = TRUE
 6 | #query = SELECT domain FROM domain WHERE domain='%s'
 7 | #optional query to use when relaying for backup MX
 8 | #query = SELECT domain FROM domain WHERE domain='%s' AND backupmx = '0' AND active = TRUE
 9 | #expansion_limit = 100
10 | 


--------------------------------------------------------------------------------
/mail/target/postfix/sql/mailbox_maps.cf:
--------------------------------------------------------------------------------
1 | hosts = {{SQL_HOSTS}}
2 | dbname = {{SQL_DBNAME}}
3 | user = {{SQL_USER}}
4 | password = {{SQL_PASSWORD}}
5 | query = SELECT maildir FROM mailbox WHERE username='%s' AND active = TRUE
6 | #expansion_limit = 100
7 | 


--------------------------------------------------------------------------------
/mail/target/scripts/check-for-changes.sh:
--------------------------------------------------------------------------------
  1 | #! /bin/bash
  2 | # TODO: Adapt for compatibility with LDAP
  3 | # Only the cert renewal change detection may be relevant for LDAP?
  4 | 
  5 | # shellcheck source=./helper-functions.sh
  6 | . /usr/local/bin/helper-functions.sh
  7 | 
  8 | function _log_date
  9 | {
 10 |   date +"%Y-%m-%d %H:%M:%S"
 11 | }
 12 | 
 13 | LOG_DATE=$(_log_date)
 14 | _notify 'task' "${LOG_DATE} Start check-for-changes script."
 15 | 
 16 | # ? --------------------------------------------- Checks
 17 | 
 18 | cd /tmp/docker-mailserver || exit 1
 19 | 
 20 | # check postfix-accounts.cf exist else break
 21 | if [[ ! -f postfix-accounts.cf ]]
 22 | then
 23 |   _notify 'inf' "${LOG_DATE} postfix-accounts.cf is missing! This should not run! Exit!"
 24 |   exit 0
 25 | fi
 26 | 
 27 | # verify checksum file exists; must be prepared by start-mailserver.sh
 28 | if [[ ! -f ${CHKSUM_FILE} ]]
 29 | then
 30 |   _notify 'err' "${LOG_DATE} ${CHKSUM_FILE} is missing! Start script failed? Exit!"
 31 |   exit 0
 32 | fi
 33 | 
 34 | # ? --------------------------------------------- Actual script begins
 35 | 
 36 | # determine postmaster address, duplicated from start-mailserver.sh
 37 | # this script previously didn't work when POSTMASTER_ADDRESS was empty
 38 | _obtain_hostname_and_domainname
 39 | 
 40 | PM_ADDRESS="${POSTMASTER_ADDRESS:=postmaster@${DOMAINNAME}}"
 41 | _notify 'inf' "${LOG_DATE} Using postmaster address ${PM_ADDRESS}"
 42 | 
 43 | # Change detection delayed during startup to avoid conflicting writes
 44 | sleep 10
 45 | 
 46 | _notify 'inf' "$(_log_date) check-for-changes is ready"
 47 | 
 48 | while true
 49 | do
 50 |   # get chksum and check it, no need to lock config yet
 51 |   _monitored_files_checksums >"${CHKSUM_FILE}.new"
 52 |   cmp --silent -- "${CHKSUM_FILE}" "${CHKSUM_FILE}.new"
 53 |   # cmp return codes
 54 |   # 0 – files are identical
 55 |   # 1 – files differ
 56 |   # 2 – inaccessible or missing argument
 57 |   if [[ ${?} -eq 1 ]]
 58 |   then
 59 |     _notify 'inf' "$(_log_date) Change detected"
 60 |     create_lock # Shared config safety lock
 61 |     CHANGED=$(grep -Fxvf "${CHKSUM_FILE}" "${CHKSUM_FILE}.new" | sed 's/^[^ ]\+  //')
 62 | 
 63 |     # Bug alert! This overwrites the alias set by start-mailserver.sh
 64 |     # Take care that changes in one script are propagated to the other
 65 | 
 66 |     # ! NEEDS FIX -----------------------------------------
 67 |     # TODO FIX --------------------------------------------
 68 |     # ! NEEDS EXTENSIONS ----------------------------------
 69 |     # TODO Perform updates below conditionally too --------
 70 |     # Also note that changes are performed in place and are not atomic
 71 |     # We should fix that and write to temporary files, stop, swap and start
 72 | 
 73 |     # `acme.json` is only relevant to Traefik, and is where it stores the certificates it manages.
 74 |     # When a change is detected it's assumed to be a possible cert renewal that needs to be
 75 |     # extracted for `docker-mailserver` services to adjust to.
 76 |     if [[ ${CHANGED} =~ /etc/letsencrypt/acme.json ]]
 77 |     then
 78 |       _notify 'inf' "'/etc/letsencrypt/acme.json' has changed, extracting certs.."
 79 | 
 80 |       # This breaks early as we only need the first successful extraction.
 81 |       # For more details see the `SSL_TYPE=letsencrypt` case handling in `setup-stack.sh`.
 82 |       #
 83 |       # NOTE: HOSTNAME is set via `helper-functions.sh`, it is not the original system HOSTNAME ENV anymore.
 84 |       # TODO: SSL_DOMAIN is Traefik specific, it no longer seems relevant and should be considered for removal.
 85 |       FQDN_LIST=("${SSL_DOMAIN}" "${HOSTNAME}" "${DOMAINNAME}")
 86 |       for CERT_DOMAIN in "${FQDN_LIST[@]}"
 87 |       do
 88 |         _notify 'inf' "Attempting to extract for '${CERT_DOMAIN}'"
 89 | 
 90 |         if _extract_certs_from_acme "${CERT_DOMAIN}"
 91 |         then
 92 |           # Prevent an unnecessary change detection from the newly extracted cert files by updating their hashes in advance:
 93 |           CERT_DOMAIN=$(_strip_wildcard_prefix "${CERT_DOMAIN}")
 94 |           ACME_CERT_DIR="/etc/letsencrypt/live/${CERT_DOMAIN}"
 95 | 
 96 |           sed -i "\|${ACME_CERT_DIR}|d" "${CHKSUM_FILE}.new"
 97 |           sha512sum "${ACME_CERT_DIR}"/*.pem >> "${CHKSUM_FILE}.new"
 98 | 
 99 |           break
100 |         fi
101 |       done
102 |     fi
103 | 
104 |     # If monitored certificate files in /etc/letsencrypt/live have changed and no `acme.json` is in use,
105 |     # They presently have no special handling other than to trigger a change that will restart Postfix/Dovecot.
106 |     # TODO: That should be all that's required, unless the cert file paths have also changed (Postfix/Dovecot configs then need to be updated).
107 | 
108 |     # regenerate postfix accounts
109 |     [[ ${SMTP_ONLY} -ne 1 ]] && _create_accounts
110 | 
111 |     _rebuild_relayhost
112 | 
113 |     # regenerate postix aliases
114 |     _create_aliases
115 | 
116 |     # regenerate /etc/postfix/vhost
117 |     # NOTE: If later adding support for LDAP with change detection and this method is called,
118 |     # be sure to mimic `setup-stack.sh:_setup_ldap` which appends to `/tmp/vhost.tmp`.
119 |     _create_postfix_vhost
120 | 
121 |     if find /var/mail -maxdepth 3 -a \( \! -user 5000 -o \! -group 5000 \) | read -r
122 |     then
123 |       chown -R 5000:5000 /var/mail
124 |     fi
125 | 
126 |     _notify 'inf' "Restarting services due to detected changes.."
127 | 
128 |     supervisorctl restart postfix
129 | 
130 |     # prevent restart of dovecot when smtp_only=1
131 |     [[ ${SMTP_ONLY} -ne 1 ]] && supervisorctl restart dovecot
132 | 
133 |     remove_lock
134 |     _notify 'inf' "$(_log_date) Completed handling of detected change"
135 |   fi
136 | 
137 |   # mark changes as applied
138 |   mv "${CHKSUM_FILE}.new" "${CHKSUM_FILE}"
139 | 
140 |   sleep 1
141 | done
142 | 
143 | exit 0
144 | 


--------------------------------------------------------------------------------
/mail/target/scripts/fail2ban-wrapper.sh:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # You cannot start fail2ban in some foreground mode and
 4 | # it's more or less important that docker doesn't kill
 5 | # fail2ban and its chilren if you stop the container.
 6 | #
 7 | # Use this script with supervisord and it will take
 8 | # care about starting and stopping fail2ban correctly.
 9 | #
10 | # supervisord config snippet for fail2ban-wrapper:
11 | #
12 | # [program:fail2ban]
13 | # process_name = fail2ban
14 | # command = /path/to/fail2ban-wrapper.sh
15 | # startsecs = 0
16 | # autorestart = false
17 | #
18 | 
19 | trap "/usr/bin/fail2ban-client stop" SIGINT
20 | trap "/usr/bin/fail2ban-client stop" SIGTERM
21 | trap "/usr/bin/fail2ban-client reload" SIGHUP
22 | 
23 | /usr/bin/fail2ban-client start
24 | sleep 5
25 | 
26 | # wait until fail2ban is dead (triggered by trap)
27 | while kill -0 "$(< /var/run/fail2ban/fail2ban.pid)"
28 | do
29 |   sleep 5
30 | done
31 | 
32 | 


--------------------------------------------------------------------------------
/mail/target/scripts/helper-functions.sh:
--------------------------------------------------------------------------------
  1 | #! /bin/bash
  2 | 
  3 | # These helpers are used by `setup-stack.sh` and `check-for-changes.sh`,
  4 | # not by anything within `helper-functions.sh` itself:
  5 | # shellcheck source=target/scripts/helpers/index.sh
  6 | . /usr/local/bin/helpers/index.sh
  7 | 
  8 | DMS_DEBUG="${DMS_DEBUG:=0}"
  9 | SCRIPT_NAME="$(basename "$0")" # This becomes the sourcing script name (Example: check-for-changes.sh)
 10 | LOCK_ID="$(uuid)" # Used inside of lock files to identify them and prevent removal by other instances of docker-mailserver
 11 | 
 12 | # ? --------------------------------------------- BIN HELPER
 13 | 
 14 | function errex
 15 | {
 16 |   echo -e "Error :: ${*}\nAborting." >&2
 17 |   exit 1
 18 | }
 19 | 
 20 | # `dms_panic` methods are appropriate when the type of error is a not recoverable,
 21 | # or needs to be very clear to the user about misconfiguration.
 22 | #
 23 | # Method is called with args:
 24 | # PANIC_TYPE => (Internal value for matching). You should use the convenience methods below based on your panic type.
 25 | # PANIC_INFO => Provide your own message string to insert into the error message for that PANIC_TYPE.
 26 | # PANIC_SCOPE => Optionally provide a string for debugging to better identify/locate the source of the panic.
 27 | function dms_panic
 28 | {
 29 |   local PANIC_TYPE=${1}
 30 |   local PANIC_INFO=${2}
 31 |   local PANIC_SCOPE=${3} #optional
 32 | 
 33 |   local SHUTDOWN_MESSAGE
 34 | 
 35 |   case "${PANIC_TYPE:-}" in
 36 |     ( 'fail-init' ) # PANIC_INFO == <name of service or process that failed to start / initialize>
 37 |       SHUTDOWN_MESSAGE="Failed to start ${PANIC_INFO}!"
 38 |       ;;
 39 | 
 40 |     ( 'no-env' ) # PANIC_INFO == <ENV VAR name>
 41 |       SHUTDOWN_MESSAGE="Environment Variable: ${PANIC_INFO} is not set!"
 42 |       ;;
 43 | 
 44 |     ( 'no-file' ) # PANIC_INFO == <invalid filepath>
 45 |       SHUTDOWN_MESSAGE="File ${PANIC_INFO} does not exist!"
 46 |       ;;
 47 | 
 48 |     ( 'misconfigured' ) # PANIC_INFO == <something possibly misconfigured, eg an ENV var>
 49 |       SHUTDOWN_MESSAGE="${PANIC_INFO} appears to be misconfigured, please verify."
 50 |       ;;
 51 | 
 52 |     ( 'invalid-value' ) # PANIC_INFO == <an unsupported or invalid value, eg in a case match>
 53 |       SHUTDOWN_MESSAGE="Invalid value for ${PANIC_INFO}!"
 54 |       ;;
 55 | 
 56 |     ( * ) # `dms_panic` was called directly without a valid PANIC_TYPE
 57 |       SHUTDOWN_MESSAGE='Something broke :('
 58 |       ;;
 59 |   esac
 60 | 
 61 |   if [[ -n ${PANIC_SCOPE:-} ]]
 62 |   then
 63 |     _shutdown "${PANIC_SCOPE} | ${SHUTDOWN_MESSAGE}"
 64 |   else
 65 |     _shutdown "${SHUTDOWN_MESSAGE}"
 66 |   fi
 67 | }
 68 | 
 69 | # Convenience wrappers based on type:
 70 | function dms_panic__fail_init { dms_panic 'fail-init' "${1}" "${2}"; }
 71 | function dms_panic__no_env { dms_panic 'no-env' "${1}" "${2}"; }
 72 | function dms_panic__no_file { dms_panic 'no-file' "${1}" "${2}"; }
 73 | function dms_panic__misconfigured { dms_panic 'misconfigured' "${1}" "${2}"; }
 74 | function dms_panic__invalid_value { dms_panic 'invalid-value' "${1}" "${2}"; }
 75 | 
 76 | function escape
 77 | {
 78 |   echo "${1//./\\.}"
 79 | }
 80 | 
 81 | function create_lock
 82 | {
 83 |   LOCK_FILE="/tmp/docker-mailserver/${SCRIPT_NAME}.lock"
 84 |   while [[ -e "${LOCK_FILE}" ]]
 85 |   do
 86 |     _notify 'warn' "Lock file ${LOCK_FILE} exists. Another ${SCRIPT_NAME} execution is happening. Trying again shortly..."
 87 |     # Handle stale lock files left behind on crashes
 88 |     # or premature/non-graceful exits of containers while they're making changes
 89 |     if [[ -n "$(find "${LOCK_FILE}" -mmin +1 2>/dev/null)" ]]
 90 |     then
 91 |       _notify 'warn' "Lock file older than 1 minute. Removing stale lock file."
 92 |       rm -f "${LOCK_FILE}"
 93 |       _notify 'inf' "Removed stale lock ${LOCK_FILE}."
 94 |     fi
 95 |     sleep 5
 96 |   done
 97 |   trap remove_lock EXIT
 98 |   echo "${LOCK_ID}" > "${LOCK_FILE}"
 99 | }
100 | 
101 | function remove_lock
102 | {
103 |   LOCK_FILE="${LOCK_FILE:-"/tmp/docker-mailserver/${SCRIPT_NAME}.lock"}"
104 |   [[ -z "${LOCK_ID}" ]] && errex "Cannot remove ${LOCK_FILE} as there is no LOCK_ID set"
105 |   if [[ -e "${LOCK_FILE}" ]] && grep -q "${LOCK_ID}" "${LOCK_FILE}" # Ensure we don't delete a lock that's not ours
106 |   then
107 |     rm -f "${LOCK_FILE}"
108 |     _notify 'inf' "Removed lock ${LOCK_FILE}."
109 |   fi
110 | }
111 | 
112 | # ? --------------------------------------------- IP & CIDR
113 | 
114 | function _mask_ip_digit
115 | {
116 |   if [[ ${1} -ge 8 ]]
117 |   then
118 |     MASK=255
119 |   elif [[ ${1} -le 0 ]]
120 |   then
121 |     MASK=0
122 |   else
123 |     VALUES=(0 128 192 224 240 248 252 254 255)
124 |     MASK=${VALUES[${1}]}
125 |   fi
126 | 
127 |   local DVAL=${2}
128 |   ((DVAL&=MASK))
129 | 
130 |   echo "${DVAL}"
131 | }
132 | 
133 | # Transforms a specific IP with CIDR suffix
134 | # like 1.2.3.4/16 to subnet with cidr suffix
135 | # like 1.2.0.0/16.
136 | # Assumes correct IP and subnet are provided.
137 | function _sanitize_ipv4_to_subnet_cidr
138 | {
139 |   local DIGIT_PREFIX_LENGTH="${1#*/}"
140 | 
141 |   declare -a MASKED_DIGITS DIGITS
142 |   IFS='.' ; read -r -a DIGITS < <(echo "${1%%/*}") ; unset IFS
143 | 
144 |   for ((i = 0 ; i < 4 ; i++))
145 |   do
146 |     MASKED_DIGITS[i]=$(_mask_ip_digit "${DIGIT_PREFIX_LENGTH}" "${DIGITS[i]}")
147 |     DIGIT_PREFIX_LENGTH=$((DIGIT_PREFIX_LENGTH - 8))
148 |   done
149 | 
150 |   echo "${MASKED_DIGITS[0]}.${MASKED_DIGITS[1]}.${MASKED_DIGITS[2]}.${MASKED_DIGITS[3]}/${1#*/}"
151 | }
152 | export -f _sanitize_ipv4_to_subnet_cidr
153 | 
154 | # ? --------------------------------------------- ACME
155 | 
156 | function _extract_certs_from_acme
157 | {
158 |   local CERT_DOMAIN=${1}
159 |   if [[ -z ${CERT_DOMAIN} ]]
160 |   then
161 |     _notify 'err' "_extract_certs_from_acme | CERT_DOMAIN is empty"
162 |     return 1
163 |   fi
164 | 
165 |   local KEY CERT
166 |   KEY=$(acme_extract /etc/letsencrypt/acme.json "${CERT_DOMAIN}" --key)
167 |   CERT=$(acme_extract /etc/letsencrypt/acme.json "${CERT_DOMAIN}" --cert)
168 | 
169 |   if [[ -z ${KEY} ]] || [[ -z ${CERT} ]]
170 |   then
171 |     _notify 'warn' "_extract_certs_from_acme | Unable to find key and/or cert for '${CERT_DOMAIN}' in '/etc/letsencrypt/acme.json'"
172 |     return 1
173 |   fi
174 | 
175 |   # Currently we advise SSL_DOMAIN for wildcard support using a `*.example.com` value,
176 |   # The filepath however should be `example.com`, avoiding the wildcard part:
177 |   if [[ ${SSL_DOMAIN} == "${CERT_DOMAIN}" ]]
178 |   then
179 |     CERT_DOMAIN=$(_strip_wildcard_prefix "${SSL_DOMAIN}")
180 |   fi
181 | 
182 |   mkdir -p "/etc/letsencrypt/live/${CERT_DOMAIN}/"
183 |   echo "${KEY}" | base64 -d > "/etc/letsencrypt/live/${CERT_DOMAIN}/key.pem" || exit 1
184 |   echo "${CERT}" | base64 -d > "/etc/letsencrypt/live/${CERT_DOMAIN}/fullchain.pem" || exit 1
185 | 
186 |   _notify 'inf' "_extract_certs_from_acme | Certificate successfully extracted for '${CERT_DOMAIN}'"
187 | }
188 | export -f _extract_certs_from_acme
189 | 
190 | # Remove the `*.` prefix if it exists, else returns the input value
191 | function _strip_wildcard_prefix {
192 |   [[ ${1} == "*."* ]] && echo "${1:2}" || echo "${1}"
193 | }
194 | 
195 | # ? --------------------------------------------- Notifications
196 | 
197 | function _notify
198 | {
199 |   { [[ -z ${1:-} ]] || [[ -z ${2:-} ]] ; } && return 0
200 | 
201 |   local RESET LGREEN LYELLOW LRED RED LBLUE LGREY LMAGENTA
202 | 
203 |   RESET='\e[0m' ; LGREEN='\e[92m' ; LYELLOW='\e[93m'
204 |   LRED='\e[31m' ; RED='\e[91m' ; LBLUE='\e[34m'
205 |   LGREY='\e[37m' ; LMAGENTA='\e[95m'
206 | 
207 |   case "${1}" in
208 |     'tasklog'  ) echo "-e${3:-}" "[ ${LGREEN}TASKLOG${RESET} ]  ${2}"  ;;
209 |     'warn'     ) echo "-e${3:-}" "[ ${LYELLOW}WARNING${RESET} ]  ${2}" ;;
210 |     'err'      ) echo "-e${3:-}" "[  ${LRED}ERROR${RESET}  ]  ${2}"    ;;
211 |     'fatal'    ) echo "-e${3:-}" "[  ${RED}FATAL${RESET}  ]  ${2}"     ;;
212 |     'inf'      ) [[ ${DMS_DEBUG} -eq 1 ]] && echo "-e${3:-}" "[[  ${LBLUE}INF${RESET}  ]]  ${2}" ;;
213 |     'task'     ) [[ ${DMS_DEBUG} -eq 1 ]] && echo "-e${3:-}" "[[ ${LGREY}TASKS${RESET} ]]  ${2}" ;;
214 |     *          ) echo "-e${3:-}" "[  ${LMAGENTA}UNKNOWN${RESET}  ]  ${2}" ;;
215 |   esac
216 | 
217 |   return 0
218 | }
219 | export -f _notify
220 | 
221 | # ? --------------------------------------------- File Checksums
222 | 
223 | # file storing the checksums of the monitored files.
224 | # shellcheck disable=SC2034
225 | CHKSUM_FILE=/tmp/docker-mailserver-config-chksum
226 | 
227 | # Compute checksums of monitored files,
228 | # returned output is lines of hashed content + filepath pairs.
229 | function _monitored_files_checksums
230 | {
231 |   # If a wildcard path pattern (or an empty ENV) would yield an invalid path
232 |   # or no results, `shopt -s nullglob` prevents it from being added.
233 |   shopt -s nullglob
234 | 
235 |   # React to any cert changes within the following letsencrypt locations:
236 |   local CERT_FILES=(
237 |     /etc/letsencrypt/live/"${SSL_DOMAIN}"/*.pem
238 |     /etc/letsencrypt/live/"${HOSTNAME}"/*.pem
239 |     /etc/letsencrypt/live/"${DOMAINNAME}"/*.pem
240 |   )
241 | 
242 |   # CERT_FILES should expand to separate paths, not a single string;
243 |   # otherwise fails to generate checksums for these file paths.
244 |   #shellcheck disable=SC2068
245 |   (
246 |     cd /tmp/docker-mailserver || exit 1
247 |     exec sha512sum 2>/dev/null -- \
248 |       postfix-accounts.cf \
249 |       postfix-virtual.cf \
250 |       postfix-aliases.cf \
251 |       dovecot-quotas.cf \
252 |       /etc/letsencrypt/acme.json \
253 |       ${CERT_FILES[@]}
254 |   )
255 | }
256 | export -f _monitored_files_checksums
257 | 
258 | # ? --------------------------------------------- General
259 | 
260 | # Outputs the DNS label count (delimited by `.`) for the given input string.
261 | # Useful for determining an FQDN like `mail.example.com` (3), vs `example.com` (2).
262 | function _get_label_count
263 | {
264 |   awk -F '.' '{ print NF }' <<< "${1}"
265 | }
266 | 
267 | # Sets HOSTNAME and DOMAINNAME globals used throughout the scripts,
268 | # and any subprocesses called that intereact with it.
269 | function _obtain_hostname_and_domainname
270 | {
271 |   # Normally this value would match the output of `hostname` which mirrors `/proc/sys/kernel/hostname`,
272 |   # However for legacy reasons, the system ENV `HOSTNAME` was replaced here with `hostname -f` instead.
273 |   #
274 |   # TODO: Consider changing to `DMS_FQDN`; a more accurate name, and removing the `export`, assuming no
275 |   # subprocess like postconf would be called that would need access to the same value via `$HOSTNAME` ENV.
276 |   #
277 |   # TODO: `OVERRIDE_HOSTNAME` was introduced for non-Docker runtimes that could not configure an explicit hostname.
278 |   # k8s was the particular runtime in 2017. This does not update `/etc/hosts` or other locations, thus risking
279 |   # inconsistency with expected behaviour. Investigate if it's safe to remove support. (--net=host also uses this as a workaround)
280 |   export HOSTNAME="${OVERRIDE_HOSTNAME:-$(hostname -f)}"
281 | 
282 |   # If the container is misconfigured.. `hostname -f` (which derives it's return value from `/etc/hosts` or DNS query),
283 |   # will result in an error that returns an empty value. This warrants a panic.
284 |   if [[ -z ${HOSTNAME} ]]
285 |   then
286 |     dms_panic__misconfigured 'obtain_hostname' '/etc/hosts'
287 |   fi
288 | 
289 |   # If the `HOSTNAME` is more than 2 labels long (eg: mail.example.com),
290 |   # We take the FQDN from it, minus the 1st label (aka _short hostname_, `hostname -s`).
291 |   #
292 |   # TODO: For some reason we're explicitly separating out a domain name from our FQDN,
293 |   # `hostname -d` was probably not the correct command for this intention either.
294 |   # Needs further investigation for relevance, and if `/etc/hosts` is important for consumers
295 |   # of this variable or if a more deterministic approach with `cut` should be relied on.
296 |   if [[ $(_get_label_count "${HOSTNAME}") -gt 2 ]]
297 |   then
298 |     if [[ -n ${OVERRIDE_HOSTNAME} ]]
299 |     then
300 |       # Emulates the intended behaviour of `hostname -d`:
301 |       # Assign the HOSTNAME value minus everything up to and including the first `.`
302 |       DOMAINNAME=${HOSTNAME#*.}
303 |     else
304 |       # Operates on the FQDN returned from querying `/etc/hosts` or fallback DNS:
305 |       #
306 |       # Note if you want the actual NIS `domainname`, use the `domainname` command,
307 |       # or `cat /proc/sys/kernel/domainname`.
308 |       # Our usage of `domainname` is under consideration as legacy, and not advised
309 |       # going forward. In future our docs should drop any mention of it.
310 | 
311 |       #shellcheck disable=SC2034
312 |       DOMAINNAME="$(hostname -d)"
313 |     fi
314 |   fi
315 | 
316 |   # Otherwise we assign the same value (eg: example.com):
317 |   # Not an else statement in the previous conditional in the event that `hostname -d` fails.
318 |   DOMAINNAME="${DOMAINNAME:-${HOSTNAME}}"
319 | }
320 | 
321 | # Check if string input is an empty line, only whitespaces or `#` as the first non-whitespace character.
322 | function _is_comment
323 | {
324 |   grep -q -E "^\s*$|^\s*#" <<< "${1}"
325 | }
326 | 
327 | # Call this method when you want to panic (emit a 'FATAL' log level error, and exit uncleanly).
328 | # `dms_panic` methods should be preferred if your failure type is supported.
329 | function _shutdown
330 | {
331 |   local FATAL_ERROR_MESSAGE=$1
332 | 
333 |   _notify 'fatal' "${FATAL_ERROR_MESSAGE}"
334 |   _notify 'err' "Shutting down.."
335 |   kill 1
336 | }
337 | 


--------------------------------------------------------------------------------
/mail/target/scripts/helpers/accounts.sh:
--------------------------------------------------------------------------------
  1 | #! /bin/bash
  2 | # Support for Postfix accounts managed via Dovecot
  3 | 
  4 | # It looks like the DOMAIN in below logic is being stored in /etc/postfix/vhost,
  5 | # even if it's a value used for Postfix `main.cf:mydestination`, which apparently isn't good?
  6 | # Only an issue when $myhostname is an exact match (eg: bare domain FQDN).
  7 | 
  8 | function _create_accounts
  9 | {
 10 |   : >/etc/postfix/vmailbox
 11 |   : >/etc/dovecot/userdb
 12 | 
 13 |   if [[ -f /tmp/docker-mailserver/postfix-accounts.cf ]] && [[ ${ENABLE_LDAP} -ne 1 ]]
 14 |   then
 15 |     _notify 'inf' "Checking file line endings"
 16 |     sed -i 's|\r||g' /tmp/docker-mailserver/postfix-accounts.cf
 17 | 
 18 |     _notify 'inf' "Regenerating postfix user list"
 19 |     echo "# WARNING: this file is auto-generated. Modify /tmp/docker-mailserver/postfix-accounts.cf to edit the user list." > /etc/postfix/vmailbox
 20 | 
 21 |     # checking that /tmp/docker-mailserver/postfix-accounts.cf ends with a newline
 22 |     # shellcheck disable=SC1003
 23 |     sed -i -e '$a\' /tmp/docker-mailserver/postfix-accounts.cf
 24 | 
 25 |     chown dovecot:dovecot /etc/dovecot/userdb
 26 |     chmod 640 /etc/dovecot/userdb
 27 | 
 28 |     sed -i -e '/\!include auth-ldap\.conf\.ext/s/^/#/' /etc/dovecot/conf.d/10-auth.conf
 29 |     sed -i -e '/\!include auth-passwdfile\.inc/s/^#//' /etc/dovecot/conf.d/10-auth.conf
 30 | 
 31 |     # creating users ; 'pass' is encrypted
 32 |     # comments and empty lines are ignored
 33 |     local LOGIN PASS USER_ATTRIBUTES
 34 |     while IFS=$'|' read -r LOGIN PASS USER_ATTRIBUTES
 35 |     do
 36 |       # Setting variables for better readability
 37 |       USER=$(echo "${LOGIN}" | cut -d @ -f1)
 38 |       DOMAIN=$(echo "${LOGIN}" | cut -d @ -f2)
 39 | 
 40 |       # test if user has a defined quota
 41 |       if [[ -f /tmp/docker-mailserver/dovecot-quotas.cf ]]
 42 |       then
 43 |         declare -a USER_QUOTA
 44 |         IFS=':' read -r -a USER_QUOTA < <(grep "${USER}@${DOMAIN}:" -i /tmp/docker-mailserver/dovecot-quotas.cf)
 45 | 
 46 |         if [[ ${#USER_QUOTA[@]} -eq 2 ]]
 47 |         then
 48 |           USER_ATTRIBUTES="${USER_ATTRIBUTES:+${USER_ATTRIBUTES} }userdb_quota_rule=*:bytes=${USER_QUOTA[1]}"
 49 |         fi
 50 |       fi
 51 | 
 52 |       if [[ -z ${USER_ATTRIBUTES} ]]
 53 |       then
 54 |         _notify 'inf' "Creating user '${USER}' for domain '${DOMAIN}'"
 55 |       else
 56 |         _notify 'inf' "Creating user '${USER}' for domain '${DOMAIN}' with attributes '${USER_ATTRIBUTES}'"
 57 |       fi
 58 | 
 59 |       echo "${LOGIN} ${DOMAIN}/${USER}/" >> /etc/postfix/vmailbox
 60 |       # Dovecot's userdb has the following format
 61 |       # user:password:uid:gid:(gecos):home:(shell):extra_fields
 62 |       echo \
 63 |         "${LOGIN}:${PASS}:5000:5000::/var/mail/${DOMAIN}/${USER}::${USER_ATTRIBUTES}" \
 64 |         >>/etc/dovecot/userdb
 65 | 
 66 |       mkdir -p "/var/mail/${DOMAIN}/${USER}"
 67 | 
 68 |       # copy user provided sieve file, if present
 69 |       if [[ -e "/tmp/docker-mailserver/${LOGIN}.dovecot.sieve" ]]
 70 |       then
 71 |         cp "/tmp/docker-mailserver/${LOGIN}.dovecot.sieve" "/var/mail/${DOMAIN}/${USER}/.dovecot.sieve"
 72 |       fi
 73 | 
 74 |       echo "${DOMAIN}" >> /tmp/vhost.tmp
 75 |     done < <(grep -v "^\s*$\|^\s*\#" /tmp/docker-mailserver/postfix-accounts.cf)
 76 | 
 77 |     _create_dovecot_alias_dummy_accounts
 78 |   fi
 79 | }
 80 | 
 81 | # Required when using Dovecot Quotas to avoid blacklisting risk from backscatter
 82 | # Note: This is a workaround only suitable for basic aliases that map to single real addresses,
 83 | # not multiple addresses (real accounts or additional aliases), those will not work with Postfix
 84 | # `quota-status` policy service and remain at risk of backscatter.
 85 | #
 86 | # see https://github.com/docker-mailserver/docker-mailserver/pull/2248#issuecomment-953313852
 87 | # for more details on this method
 88 | function _create_dovecot_alias_dummy_accounts
 89 | {
 90 |   if [[ -f /tmp/docker-mailserver/postfix-virtual.cf ]] && [[ ${ENABLE_QUOTAS} -eq 1 ]]
 91 |   then
 92 |     # adding aliases to Dovecot's userdb
 93 |     # ${REAL_FQUN} is a user's fully-qualified username
 94 |     local ALIAS REAL_FQUN
 95 |     while read -r ALIAS REAL_FQUN
 96 |     do
 97 |       # ignore comments
 98 |       [[ ${ALIAS} == \#* ]] && continue
 99 | 
100 |       # alias is assumed to not be a proper e-mail
101 |       # these aliases do not need to be added to Dovecot's userdb
102 |       [[ ! ${ALIAS} == *@* ]] && continue
103 | 
104 |       # clear possibly already filled arrays
105 |       # do not remove the following line of code
106 |       unset REAL_ACC USER_QUOTA
107 |       declare -a REAL_ACC USER_QUOTA
108 | 
109 |       local REAL_USERNAME REAL_DOMAINNAME
110 |       REAL_USERNAME=$(cut -d '@' -f 1 <<< "${REAL_FQUN}")
111 |       REAL_DOMAINNAME=$(cut -d '@' -f 2 <<< "${REAL_FQUN}")
112 | 
113 |       if ! grep -q "${REAL_FQUN}" /tmp/docker-mailserver/postfix-accounts.cf
114 |       then
115 |         _notify 'inf' "Alias '${ALIAS}' is non-local (or mapped to a non-existing account) and will not be added to Dovecot's userdb"
116 |         continue
117 |       fi
118 | 
119 |       _notify 'inf' "Adding alias '${ALIAS}' for user '${REAL_FQUN}' to Dovecot's userdb"
120 | 
121 |       # ${REAL_ACC[0]} => real account name (e-mail address) == ${REAL_FQUN}
122 |       # ${REAL_ACC[1]} => password hash
123 |       # ${REAL_ACC[2]} => optional user attributes
124 |       IFS='|' read -r -a REAL_ACC < <(grep "${REAL_FQUN}" /tmp/docker-mailserver/postfix-accounts.cf)
125 | 
126 |       if [[ -z ${REAL_ACC[1]} ]]
127 |       then
128 |         dms_panic__misconfigured 'postfix-accounts.cf' 'alias configuration'
129 |       fi
130 | 
131 |       # test if user has a defined quota
132 |       if [[ -f /tmp/docker-mailserver/dovecot-quotas.cf ]]
133 |       then
134 |         IFS=':' read -r -a USER_QUOTA < <(grep "${REAL_FQUN}:" -i /tmp/docker-mailserver/dovecot-quotas.cf)
135 |         if [[ ${#USER_QUOTA[@]} -eq 2 ]]
136 |         then
137 |           REAL_ACC[2]="${REAL_ACC[2]:+${REAL_ACC[2]} }userdb_quota_rule=*:bytes=${USER_QUOTA[1]}"
138 |         fi
139 |       fi
140 | 
141 |       echo \
142 |         "${ALIAS}:${REAL_ACC[1]}:5000:5000::/var/mail/${REAL_DOMAINNAME}/${REAL_USERNAME}::${REAL_ACC[2]:-}" \
143 |         >> /etc/dovecot/userdb
144 |     done < /tmp/docker-mailserver/postfix-virtual.cf
145 |   fi
146 | }
147 | 


--------------------------------------------------------------------------------
/mail/target/scripts/helpers/aliases.sh:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | # Support for Postfix aliases
 3 | 
 4 | # NOTE: LDAP doesn't appear to use this, but the docs page: "Use Cases | Forward-Only Mail-Server with LDAP"
 5 | # does have an example where /etc/postfix/virtual is referenced in addition to ldap config for Postfix `main.cf:virtual_alias_maps`.
 6 | # `setup-stack.sh:_setup_ldap` does not seem to configure for `/etc/postfix/virtual however.`
 7 | 
 8 | # NOTE: `accounts.sh` and `relay.sh:_populate_relayhost_map` also process on `postfix-virtual.cf`.
 9 | function _handle_postfix_virtual_config
10 | {
11 |   : >/etc/postfix/virtual
12 |   : >/etc/postfix/regexp
13 | 
14 |   if [[ -f /tmp/docker-mailserver/postfix-virtual.cf ]]
15 |   then
16 |     # fixing old virtual user file
17 |     if grep -q ",$" /tmp/docker-mailserver/postfix-virtual.cf
18 |     then
19 |       sed -i -e "s|, |,|g" -e "s|,$||g" /tmp/docker-mailserver/postfix-virtual.cf
20 |     fi
21 | 
22 |     cp -f /tmp/docker-mailserver/postfix-virtual.cf /etc/postfix/virtual
23 | 
24 |     # the `to` is important, don't delete it
25 |     # shellcheck disable=SC2034
26 |     while read -r FROM TO
27 |     do
28 |       UNAME=$(echo "${FROM}" | cut -d @ -f1)
29 |       DOMAIN=$(echo "${FROM}" | cut -d @ -f2)
30 | 
31 |       # if they are equal it means the line looks like: "user1     other@domain.tld"
32 |       [[ ${UNAME} != "${DOMAIN}" ]] && echo "${DOMAIN}" >>/tmp/vhost.tmp
33 |     done < <(grep -v "^\s*$\|^\s*\#" /tmp/docker-mailserver/postfix-virtual.cf || true)
34 |   else
35 |     _notify 'inf' "Warning '/tmp/docker-mailserver/postfix-virtual.cf' is not provided. No mail alias/forward created."
36 |   fi
37 | }
38 | 
39 | function _handle_postfix_regexp_config
40 | {
41 |   if [[ -f /tmp/docker-mailserver/postfix-regexp.cf ]]
42 |   then
43 |     _notify 'inf' "Adding regexp alias file postfix-regexp.cf"
44 | 
45 |     cp -f /tmp/docker-mailserver/postfix-regexp.cf /etc/postfix/regexp
46 |     sed -i -E \
47 |       's|virtual_alias_maps(.*)|virtual_alias_maps\1 pcre:/etc/postfix/regexp|g' \
48 |       /etc/postfix/main.cf
49 |   fi
50 | }
51 | 
52 | function _handle_postfix_aliases_config
53 | {
54 |   _notify 'inf' 'Configuring root alias'
55 | 
56 |   echo "root: ${POSTMASTER_ADDRESS}" > /etc/aliases
57 | 
58 |   if [[ -f /tmp/docker-mailserver/postfix-aliases.cf ]]
59 |   then
60 |     cat /tmp/docker-mailserver/postfix-aliases.cf >>/etc/aliases
61 |   else
62 |     _notify 'inf' "'/tmp/docker-mailserver/postfix-aliases.cf' is not provided, it will be auto created."
63 |     : >/tmp/docker-mailserver/postfix-aliases.cf
64 |   fi
65 | 
66 |   postalias /etc/aliases
67 | }
68 | 
69 | # Other scripts should call this method, rather than the ones above:
70 | function _create_aliases
71 | {
72 |   _handle_postfix_virtual_config
73 |   _handle_postfix_regexp_config
74 |   _handle_postfix_aliases_config
75 | }
76 | 


--------------------------------------------------------------------------------
/mail/target/scripts/helpers/index.sh:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | # shellcheck source-path=target/scripts/helpers
 3 | # This file serves as a single import for all helpers
 4 | 
 5 | function _import_scripts
 6 | {
 7 |   local PATH_TO_SCRIPTS='/usr/local/bin/helpers'
 8 | 
 9 |   . "${PATH_TO_SCRIPTS}/postfix.sh"
10 |   . "${PATH_TO_SCRIPTS}/accounts.sh"
11 |   . "${PATH_TO_SCRIPTS}/aliases.sh"
12 |   . "${PATH_TO_SCRIPTS}/relay.sh"
13 |   . "${PATH_TO_SCRIPTS}/sasl.sh"
14 | }
15 | _import_scripts
16 | 


--------------------------------------------------------------------------------
/mail/target/scripts/helpers/postfix.sh:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | # Support for Postfix features
 3 | 
 4 | # Docs - virtual_mailbox_domains (Used in /etc/postfix/main.cf):
 5 | # http://www.postfix.org/ADDRESS_CLASS_README.html#virtual_mailbox_class
 6 | # http://www.postfix.org/VIRTUAL_README.html
 7 | # > If you omit this setting then Postfix will reject mail (relay access denied) or will not be able to deliver it.
 8 | # > NEVER list a virtual MAILBOX domain name as a `mydestination` domain!
 9 | # > NEVER list a virtual MAILBOX domain name as a virtual ALIAS domain!
10 | #
11 | # > Execute the command "postmap /etc/postfix/virtual" after changing the virtual file,
12 | # > execute "postmap /etc/postfix/vmailbox" after changing the vmailbox file,
13 | # > and execute the command "postfix reload" after changing the main.cf file.
14 | #
15 | # - virtual_alias_domains is not used by docker-mailserver at present, although LDAP docs reference it.
16 | # - `postmap` only seems relevant when the lookup type is one of these `file_type` values: http://www.postfix.org/postmap.1.html
17 | #   Should not be a concern for most types used by `docker-mailserver`: texthash, ldap, pcre, tcp, unionmap, unix.
18 | #   The only other type in use by `docker-mailserver` is the hash type for /etc/aliases, which `postalias` handles.
19 | function _create_postfix_vhost
20 | {
21 |   # `main.cf` configures `virtual_mailbox_domains = /etc/postfix/vhost`
22 |   # NOTE: Amavis also consumes this file.
23 |   : >/etc/postfix/vhost
24 | 
25 |   # Account and Alias generation will store values in `/tmp/vhost.tmp`.
26 |   # Filter unique values to the proper config.
27 |   # NOTE: LDAP stores the domain value set by `docker-mailserver`,
28 |   # and correctly removes it from `mydestination` in `main.cf` in `setup-stack.sh`.
29 |   if [[ -f /tmp/vhost.tmp ]]
30 |   then
31 |     sort < /tmp/vhost.tmp | uniq >> /etc/postfix/vhost
32 |     rm /tmp/vhost.tmp
33 |   fi
34 | }
35 | 
36 | # Docs - Postfix lookup table files:
37 | # http://www.postfix.org/DATABASE_README.html
38 | #
39 | # Types used in scripts or config: ldap, texthash, hash, pcre, tcp, unionmap, unix
40 | # ldap type changes are network based, no `postfix reload` required.
41 | # texthash type is read into memory when Postfix process starts, requires `postfix reload` to apply changes.
42 | # texthash type does not require running `postmap` after changes are made, other types might.
43 | #
44 | # Examples of different types actively used:
45 | # setup-stack.sh:_setup_spoof_protection uses texthash + hash + pcre, and conditionally unionmap
46 | # main.cf:
47 | # - alias_maps and alias_database both use hash:/etc/aliases
48 | # - virtual_mailbox_maps and virtual_alias_maps use texthash
49 | # - `alias.sh` may append pcre:/etc/postfix/regexp to virtual_alias_maps in `main.cf`
50 | #
51 | # /etc/aliases is handled by `alias.sh` and uses `postalias` to update the Postfix alias database. No need for `postmap`.
52 | # http://www.postfix.org/postalias.1.html
53 | 


--------------------------------------------------------------------------------
/mail/target/scripts/helpers/relay.sh:
--------------------------------------------------------------------------------
  1 | #! /bin/bash
  2 | # Support for Relay Hosts
  3 | 
  4 | function _relayhost_default_port_fallback
  5 | {
  6 |   RELAY_PORT=${RELAY_PORT:-25}
  7 | }
  8 | 
  9 | # setup /etc/postfix/sasl_passwd
 10 | # --
 11 | # @domain1.com        postmaster@domain1.com:your-password-1
 12 | # @domain2.com        postmaster@domain2.com:your-password-2
 13 | # @domain3.com        postmaster@domain3.com:your-password-3
 14 | #
 15 | # [smtp.mailgun.org]:587  postmaster@domain2.com:your-password-2
 16 | function _relayhost_sasl
 17 | {
 18 |   if [[ ! -f /tmp/docker-mailserver/postfix-sasl-password.cf ]] && [[ -z ${RELAY_USER} || -z ${RELAY_PASSWORD} ]]
 19 |   then
 20 |     _notify 'warn' "No relay auth file found and no default set"
 21 |     return 1
 22 |   fi
 23 | 
 24 |   if [[ -f /tmp/docker-mailserver/postfix-sasl-password.cf ]]
 25 |   then
 26 |     _notify 'inf' "Adding relay authentication from postfix-sasl-password.cf"
 27 | 
 28 |     # add domain-specific auth from config file:
 29 |     while read -r LINE
 30 |     do
 31 |       if ! _is_comment "${LINE}"
 32 |       then
 33 |         echo "${LINE}" >> /etc/postfix/sasl_passwd
 34 |       fi
 35 |     done < /tmp/docker-mailserver/postfix-sasl-password.cf
 36 |   fi
 37 | 
 38 |   # add default relay
 39 |   if [[ -n ${RELAY_USER} ]] && [[ -n ${RELAY_PASSWORD} ]]
 40 |   then
 41 |     # white-space separates value pairs (any length is valid)
 42 |     echo "[${RELAY_HOST}]:${RELAY_PORT} ${RELAY_USER}:${RELAY_PASSWORD}" >> /etc/postfix/sasl_passwd
 43 |   fi
 44 | 
 45 |   _sasl_set_passwd_permissions
 46 | }
 47 | 
 48 | # Introduced by: https://github.com/docker-mailserver/docker-mailserver/pull/1596
 49 | # setup /etc/postfix/relayhost_map
 50 | # --
 51 | # @domain1.com        [smtp.mailgun.org]:587
 52 | # @domain2.com        [smtp.mailgun.org]:587
 53 | # @domain3.com        [smtp.mailgun.org]:587
 54 | function _populate_relayhost_map
 55 | {
 56 |   # Create the relayhost_map config file:
 57 |   : >/etc/postfix/relayhost_map
 58 |   chown root:root /etc/postfix/relayhost_map
 59 |   chmod 0600 /etc/postfix/relayhost_map
 60 | 
 61 |   if [[ -f /tmp/docker-mailserver/postfix-relaymap.cf ]]
 62 |   then
 63 |     _notify 'inf' "Adding relay mappings from postfix-relaymap.cf"
 64 |     # keep lines which are not a comment *and* have a destination.
 65 |     sed -n '/^\s*[^#[:space:]]\S*\s\+\S/p' /tmp/docker-mailserver/postfix-relaymap.cf >> /etc/postfix/relayhost_map
 66 |   fi
 67 | 
 68 |   {
 69 |     # note: won't detect domains when lhs has spaces (but who does that?!)
 70 |     sed -n '/^\s*[^#[:space:]]/ s/^[^@|]*@\([^|]\+\)|.*$/\1/p' /tmp/docker-mailserver/postfix-accounts.cf
 71 | 
 72 |     [[ -f /tmp/docker-mailserver/postfix-virtual.cf ]] && sed -n '/^\s*[^#[:space:]]/ s/^\s*[^@[:space:]]*@\(\S\+\)\s.*/\1/p' /tmp/docker-mailserver/postfix-virtual.cf
 73 |   } | while read -r DOMAIN
 74 |   do
 75 |     # DOMAIN not already present *and* not ignored
 76 |     if ! grep -q -e "^@${DOMAIN}\b" /etc/postfix/relayhost_map && ! grep -qs -e "^\s*@${DOMAIN}\s*$" /tmp/docker-mailserver/postfix-relaymap.cf
 77 |     then
 78 |       _notify 'inf' "Adding relay mapping for ${DOMAIN}"
 79 |       echo "@${DOMAIN}    [${RELAY_HOST}]:${RELAY_PORT}" >> /etc/postfix/relayhost_map
 80 |     fi
 81 |   done
 82 | }
 83 | 
 84 | function _relayhost_configure_postfix
 85 | {
 86 |   postconf -e \
 87 |     "smtp_sasl_auth_enable = yes" \
 88 |     "smtp_sasl_security_options = noanonymous" \
 89 |     "smtp_sasl_password_maps = texthash:/etc/postfix/sasl_passwd" \
 90 |     "smtp_tls_security_level = encrypt" \
 91 |     "smtp_tls_note_starttls_offer = yes" \
 92 |     "smtp_tls_CAfile = /etc/ssl/certs/ca-certificates.crt" \
 93 |     "sender_dependent_relayhost_maps = texthash:/etc/postfix/relayhost_map" \
 94 |     "smtp_sender_dependent_authentication = yes"
 95 | }
 96 | 
 97 | # ? --------------------------------------------- Callers
 98 | 
 99 | # setup-stack.sh:
100 | function _setup_relayhost
101 | {
102 |   _notify 'task' 'Setting up Postfix Relay Hosts'
103 | 
104 |   if [[ -n ${DEFAULT_RELAY_HOST} ]]
105 |   then
106 |     _notify 'inf' "Setting default relay host ${DEFAULT_RELAY_HOST} to /etc/postfix/main.cf"
107 |     postconf -e "relayhost = ${DEFAULT_RELAY_HOST}"
108 |   fi
109 | 
110 |   if [[ -n ${RELAY_HOST} ]]
111 |   then
112 |     _relayhost_default_port_fallback
113 |     _notify 'inf' "Setting up outgoing email relaying via ${RELAY_HOST}:${RELAY_PORT}"
114 | 
115 |     # Expects `_sasl_passwd_create` was called prior in `setup-stack.sh`
116 |     _relayhost_sasl
117 |     _populate_relayhost_map
118 | 
119 |     _relayhost_configure_postfix
120 |   fi
121 | }
122 | 
123 | # check-for-changes.sh:
124 | function _rebuild_relayhost
125 | {
126 |   if [[ -n ${RELAY_HOST} ]]
127 |   then
128 |     _relayhost_default_port_fallback
129 | 
130 |     # Start from a new `/etc/postfix/sasl_passwd` state:
131 |     _sasl_passwd_create
132 | 
133 |     _relayhost_sasl
134 |     _populate_relayhost_map
135 |   fi
136 | }
137 | 


--------------------------------------------------------------------------------
/mail/target/scripts/helpers/sasl.sh:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | # Support for SASL
 3 | 
 4 | function _sasl_passwd_create
 5 | {
 6 |   if [[ -n ${SASL_PASSWD} ]]
 7 |   then
 8 |     # create SASL password
 9 |     echo "${SASL_PASSWD}" > /etc/postfix/sasl_passwd
10 |     _sasl_set_passwd_permissions
11 |   else
12 |     rm -f /etc/postfix/sasl_passwd
13 |   fi
14 | }
15 | 
16 | function _sasl_set_passwd_permissions
17 | {
18 |   if [[ -f /etc/postfix/sasl_passwd ]]
19 |   then
20 |     chown root:root /etc/postfix/sasl_passwd
21 |     chmod 0600 /etc/postfix/sasl_passwd
22 |   fi
23 | }
24 | 


--------------------------------------------------------------------------------
/mail/target/scripts/postfix-wrapper.sh:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # You cannot start postfix in some foreground mode and
 4 | # it's more or less important that docker doesn't kill
 5 | # postfix and its chilren if you stop the container.
 6 | #
 7 | # Use this script with supervisord and it will take
 8 | # care about starting and stopping postfix correctly.
 9 | #
10 | # supervisord config snippet for postfix-wrapper:
11 | #
12 | # [program:postfix]
13 | # process_name = postfix
14 | # command = /path/to/postfix-wrapper.sh
15 | # startsecs = 0
16 | # autorestart = false
17 | #
18 | 
19 | trap "service postfix stop" SIGINT
20 | trap "service postfix stop" SIGTERM
21 | trap "service postfix reload" SIGHUP
22 | 
23 | service postfix start
24 | 
25 | # wait until postfix is dead (triggered by trap)
26 | while kill -0 "$(< /var/spool/postfix/pid/master.pid)"
27 | do
28 |   sleep 5
29 | done
30 | 


--------------------------------------------------------------------------------
/mail/target/scripts/postsrsd-wrapper.sh:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # shellcheck source=./helper-functions.sh
 4 | . /usr/local/bin/helper-functions.sh
 5 | 
 6 | function _generate_secret { ( umask 0077 ; dd if=/dev/urandom bs=24 count=1 2>/dev/null | base64 -w0 > "${1}" ; ) ; }
 7 | 
 8 | _obtain_hostname_and_domainname
 9 | 
10 | if [[ -n "${SRS_DOMAINNAME}" ]]
11 | then
12 |   NEW_DOMAIN_NAME="${SRS_DOMAINNAME}"
13 | else
14 |   NEW_DOMAIN_NAME="${DOMAINNAME}"
15 | fi
16 | 
17 | sed -i -e "s/localdomain/${NEW_DOMAIN_NAME}/g" /etc/default/postsrsd
18 | 
19 | POSTSRSD_SECRET_FILE='/etc/postsrsd.secret'
20 | POSTSRSD_STATE_DIR='/var/mail-state/etc-postsrsd'
21 | POSTSRSD_STATE_SECRET_FILE="${POSTSRSD_STATE_DIR}/postsrsd.secret"
22 | 
23 | if [[ -n ${SRS_SECRET} ]]
24 | then
25 |   ( umask 0077 ; echo "${SRS_SECRET}" | tr ',' '\n' > "${POSTSRSD_SECRET_FILE}" ; )
26 | else
27 |   if [[ ${ONE_DIR} -eq 1 ]]
28 |   then
29 |     if [[ ! -f ${POSTSRSD_STATE_SECRET_FILE} ]]
30 |     then
31 |       install -d -m 0775 "${POSTSRSD_STATE_DIR}"
32 |       _generate_secret "${POSTSRSD_STATE_SECRET_FILE}"
33 |     fi
34 | 
35 |     install -m 0400 "${POSTSRSD_STATE_SECRET_FILE}" "${POSTSRSD_SECRET_FILE}"
36 |   elif [[ ! -f ${POSTSRSD_SECRET_FILE} ]]
37 |   then
38 |     _generate_secret "${POSTSRSD_SECRET_FILE}"
39 |   fi
40 | fi
41 | 
42 | if [[ -n ${SRS_EXCLUDE_DOMAINS} ]]
43 | then
44 |   sed -i -e "s/^#\?SRS_EXCLUDE_DOMAINS=.*$/SRS_EXCLUDE_DOMAINS=${SRS_EXCLUDE_DOMAINS}/g" /etc/default/postsrsd
45 | fi
46 | 
47 | /etc/init.d/postsrsd start
48 | 


--------------------------------------------------------------------------------
/mail/target/scripts/quota-warning.sh:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | # Report a quota usage warning to an user
 4 | 
 5 | PERCENT="${1}"
 6 | USER="${2}"
 7 | DOMAIN="${3}"
 8 | 
 9 | cat << EOF | /usr/lib/dovecot/dovecot-lda -d "${USER}" -o "plugin/quota=maildir:User quota:noenforcing"
10 | From: postmaster@${DOMAIN}
11 | Subject: quota warning
12 | 
13 | Your mailbox is now ${PERCENT}% full.
14 | EOF
15 | 


--------------------------------------------------------------------------------
/mail/target/scripts/start-mailserver.sh:
--------------------------------------------------------------------------------
  1 | #! /bin/bash
  2 | 
  3 | # shellcheck source=./helper-functions.sh
  4 | . /usr/local/bin/helper-functions.sh
  5 | 
  6 | unset FUNCS_SETUP FUNCS_FIX FUNCS_CHECK FUNCS_MISC
  7 | unset DAEMONS_START HOSTNAME DOMAINNAME CHKSUM_FILE
  8 | 
  9 | #shellcheck disable=SC2034
 10 | declare -A VARS
 11 | declare -a FUNCS_SETUP FUNCS_FIX FUNCS_CHECK FUNCS_MISC DAEMONS_START
 12 | 
 13 | # ------------------------------------------------------------
 14 | # ? <<
 15 | # --
 16 | # ? >> Setup of default and global values / variables
 17 | # ------------------------------------------------------------
 18 | 
 19 | VARS[AMAVIS_LOGLEVEL]="${AMAVIS_LOGLEVEL:=0}"
 20 | VARS[DEFAULT_RELAY_HOST]="${DEFAULT_RELAY_HOST:=}"
 21 | VARS[DMS_DEBUG]="${DMS_DEBUG:=0}"
 22 | VARS[DOVECOT_MAILBOX_FORMAT]="${DOVECOT_MAILBOX_FORMAT:=maildir}"
 23 | VARS[DOVECOT_TLS]="${DOVECOT_TLS:=no}"
 24 | VARS[ENABLE_AMAVIS]="${ENABLE_AMAVIS:=1}"
 25 | VARS[ENABLE_CLAMAV]="${ENABLE_CLAMAV:=0}"
 26 | VARS[ENABLE_FAIL2BAN]="${ENABLE_FAIL2BAN:=0}"
 27 | VARS[ENABLE_FETCHMAIL]="${ENABLE_FETCHMAIL:=0}"
 28 | VARS[ENABLE_LDAP]="${ENABLE_LDAP:=0}"
 29 | VARS[ENABLE_SQL]="${ENABLE_SQL:=0}"
 30 | VARS[SQL_DRIVER]="${SQL_DRIVER:=mysql}"
 31 | VARS[ENABLE_MANAGESIEVE]="${ENABLE_MANAGESIEVE:=0}"
 32 | VARS[ENABLE_POP3]="${ENABLE_POP3:=0}"
 33 | VARS[ENABLE_POSTGREY]="${ENABLE_POSTGREY:=0}"
 34 | VARS[ENABLE_QUOTAS]="${ENABLE_QUOTAS:=1}"
 35 | VARS[ENABLE_SASLAUTHD]="${ENABLE_SASLAUTHD:=0}"
 36 | VARS[ENABLE_SPAMASSASSIN]="${ENABLE_SPAMASSASSIN:=0}"
 37 | VARS[ENABLE_SRS]="${ENABLE_SRS:=0}"
 38 | VARS[ENABLE_UPDATE_CHECK]="${ENABLE_UPDATE_CHECK:=1}"
 39 | VARS[FAIL2BAN_BLOCKTYPE]="${FAIL2BAN_BLOCKTYPE:=drop}"
 40 | VARS[FETCHMAIL_PARALLEL]="${FETCHMAIL_PARALLEL:=0}"
 41 | VARS[FETCHMAIL_POLL]="${FETCHMAIL_POLL:=300}"
 42 | VARS[LDAP_START_TLS]="${LDAP_START_TLS:=no}"
 43 | VARS[SQL_PASS_SCHEME]="${SQL_PASS_SCHEME:=MD5-CRYPT}"
 44 | VARS[LOGROTATE_INTERVAL]="${LOGROTATE_INTERVAL:=${REPORT_INTERVAL:-daily}}"
 45 | VARS[LOGWATCH_INTERVAL]="${LOGWATCH_INTERVAL:=none}"
 46 | VARS[MOVE_SPAM_TO_JUNK]="${MOVE_SPAM_TO_JUNK:=1}"
 47 | VARS[NETWORK_INTERFACE]="${NETWORK_INTERFACE:=eth0}"
 48 | VARS[ONE_DIR]="${ONE_DIR:=1}"
 49 | VARS[OVERRIDE_HOSTNAME]="${OVERRIDE_HOSTNAME}"
 50 | VARS[POSTFIX_INET_PROTOCOLS]="${POSTFIX_INET_PROTOCOLS:=all}"
 51 | VARS[POSTFIX_MAILBOX_SIZE_LIMIT]="${POSTFIX_MAILBOX_SIZE_LIMIT:=0}"
 52 | VARS[POSTFIX_MESSAGE_SIZE_LIMIT]="${POSTFIX_MESSAGE_SIZE_LIMIT:=10240000}" # ~10MB
 53 | VARS[POSTGREY_AUTO_WHITELIST_CLIENTS]="${POSTGREY_AUTO_WHITELIST_CLIENTS:=5}"
 54 | VARS[POSTGREY_DELAY]="${POSTGREY_DELAY:=300}"
 55 | VARS[POSTGREY_MAX_AGE]="${POSTGREY_MAX_AGE:=35}"
 56 | VARS[POSTGREY_TEXT]="${POSTGREY_TEXT:=Delayed by Postgrey}"
 57 | VARS[POSTSCREEN_ACTION]="${POSTSCREEN_ACTION:=enforce}"
 58 | VARS[RELAY_HOST]="${RELAY_HOST:=}"
 59 | VARS[REPORT_RECIPIENT]="${REPORT_RECIPIENT:="0"}"
 60 | VARS[SA_KILL]=${SA_KILL:="6.31"}
 61 | VARS[SA_SPAM_SUBJECT]=${SA_SPAM_SUBJECT:="***SPAM*** "}
 62 | VARS[SA_TAG]=${SA_TAG:="2.0"}
 63 | VARS[SA_TAG2]=${SA_TAG2:="6.31"}
 64 | VARS[SMTP_ONLY]="${SMTP_ONLY:=0}"
 65 | VARS[SPAMASSASSIN_SPAM_TO_INBOX_SET]="${SPAMASSASSIN_SPAM_TO_INBOX:-not set}"
 66 | VARS[SPAMASSASSIN_SPAM_TO_INBOX]="${SPAMASSASSIN_SPAM_TO_INBOX:=0}"
 67 | VARS[SPOOF_PROTECTION]="${SPOOF_PROTECTION:=0}"
 68 | VARS[SRS_SENDER_CLASSES]="${SRS_SENDER_CLASSES:=envelope_sender}"
 69 | VARS[SSL_TYPE]="${SSL_TYPE:=}"
 70 | VARS[SUPERVISOR_LOGLEVEL]="${SUPERVISOR_LOGLEVEL:=warn}"
 71 | VARS[TLS_LEVEL]="${TLS_LEVEL:=modern}"
 72 | VARS[UPDATE_CHECK_INTERVAL]="${UPDATE_CHECK_INTERVAL:=1d}"
 73 | VARS[VIRUSMAILS_DELETE_DELAY]="${VIRUSMAILS_DELETE_DELAY:=7}"
 74 | 
 75 | export HOSTNAME DOMAINNAME CHKSUM_FILE
 76 | 
 77 | _obtain_hostname_and_domainname
 78 | 
 79 | CHKSUM_FILE=/tmp/docker-mailserver-config-chksum
 80 | 
 81 | # ------------------------------------------------------------
 82 | # ? << Setup of default and global values / variables
 83 | # --
 84 | # ? >> Registering functions
 85 | # ------------------------------------------------------------
 86 | 
 87 | function register_functions
 88 | {
 89 |   _notify 'tasklog' 'Initializing setup'
 90 |   _notify 'task' 'Registering functions'
 91 | 
 92 |   # ? >> Checks
 93 | 
 94 |   _register_check_function '_check_hostname'
 95 | 
 96 |   # ? >> Setup
 97 | 
 98 |   _register_setup_function '_setup_supervisor'
 99 |   _register_setup_function '_setup_default_vars'
100 |   _register_setup_function '_setup_file_permissions'
101 | 
102 |   if [[ ${SMTP_ONLY} -ne 1 ]]
103 |   then
104 |     _register_setup_function '_setup_dovecot'
105 |     _register_setup_function '_setup_dovecot_dhparam'
106 |     _register_setup_function '_setup_dovecot_quota'
107 |     _register_setup_function '_setup_dovecot_local_user'
108 |   fi
109 | 
110 |   [[ ${ENABLE_LDAP} -eq 1 ]] && _register_setup_function '_setup_ldap'
111 |   [[ ${ENABLE_SQL} -eq 1 ]] && _register_setup_function '_setup_sql'
112 |   [[ ${ENABLE_POSTGREY} -eq 1 ]] && _register_setup_function '_setup_postgrey'
113 |   [[ ${ENABLE_SASLAUTHD} -eq 1 ]] && _register_setup_function '_setup_saslauthd'
114 |   [[ ${POSTFIX_INET_PROTOCOLS} != 'all' ]] && _register_setup_function '_setup_inet_protocols'
115 |   [[ ${ENABLE_FAIL2BAN} -eq 1 ]] && _register_setup_function '_setup_fail2ban'
116 | 
117 |   _register_setup_function '_setup_dkim'
118 |   _register_setup_function '_setup_ssl'
119 |   _register_setup_function '_setup_docker_permit'
120 |   _register_setup_function '_setup_mailname'
121 |   _register_setup_function '_setup_amavis'
122 |   _register_setup_function '_setup_dmarc_hostname'
123 |   _register_setup_function '_setup_postfix_hostname'
124 |   _register_setup_function '_setup_dovecot_hostname'
125 |   _register_setup_function '_setup_postfix_smtputf8'
126 |   _register_setup_function '_setup_postfix_sasl'
127 |   _register_setup_function '_setup_postfix_sasl_password'
128 |   _register_setup_function '_setup_security_stack'
129 |   _register_setup_function '_setup_postfix_aliases'
130 |   _register_setup_function '_setup_postfix_vhost'
131 |   _register_setup_function '_setup_postfix_dhparam'
132 |   _register_setup_function '_setup_postfix_postscreen'
133 |   _register_setup_function '_setup_postfix_sizelimits'
134 | 
135 |   # needs to come after _setup_postfix_aliases
136 |   [[ ${SPOOF_PROTECTION} -eq 1 ]] && _register_setup_function '_setup_spoof_protection'
137 | 
138 |   if [[ ${ENABLE_SRS} -eq 1  ]]
139 |   then
140 |     _register_setup_function '_setup_SRS'
141 |     _register_start_daemon '_start_daemons_postsrsd'
142 |   fi
143 | 
144 |   _register_setup_function '_setup_postfix_access_control'
145 |   _register_setup_function '_setup_postfix_relay_hosts'
146 | 
147 |   [[ ${ENABLE_POSTFIX_VIRTUAL_TRANSPORT:-0} -eq 1 ]] && _register_setup_function '_setup_postfix_virtual_transport'
148 | 
149 |   _register_setup_function '_setup_postfix_override_configuration'
150 |   _register_setup_function '_setup_logrotate'
151 |   _register_setup_function '_setup_mail_summary'
152 |   _register_setup_function '_setup_logwatch'
153 |   _register_setup_function '_setup_user_patches'
154 | 
155 |   # needs to come last as configuration files are modified in-place
156 |   _register_setup_function '_setup_chksum_file'
157 | 
158 |   # ? >> Fixes
159 | 
160 |   _register_fix_function '_fix_var_mail_permissions'
161 |   [[ ${ENABLE_AMAVIS} -eq 1 ]] && _register_fix_function '_fix_var_amavis_permissions'
162 | 
163 |   [[ ${ENABLE_CLAMAV} -eq 0 ]] && _register_fix_function '_fix_cleanup_clamav'
164 |   [[ ${ENABLE_SPAMASSASSIN} -eq 0 ]] &&	_register_fix_function '_fix_cleanup_spamassassin'
165 | 
166 |   # ? >> Miscellaneous
167 | 
168 |   _register_misc_function '_misc_save_states'
169 | 
170 |   # ? >> Daemons
171 | 
172 |   _register_start_daemon '_start_daemons_cron'
173 |   _register_start_daemon '_start_daemons_rsyslog'
174 | 
175 |   [[ ${SMTP_ONLY} -ne 1 ]] && _register_start_daemon '_start_daemons_dovecot'
176 |   [[ ${ENABLE_UPDATE_CHECK} -eq 1 ]] && _register_start_daemon '_start_daemons_update_check'
177 | 
178 |   # needs to be started before SASLauthd
179 |   _register_start_daemon '_start_daemons_opendkim'
180 |   _register_start_daemon '_start_daemons_opendmarc'
181 | 
182 |   # needs to be started before postfix
183 |   [[ ${ENABLE_POSTGREY} -eq 1 ]] &&	_register_start_daemon '_start_daemons_postgrey'
184 | 
185 |   _register_start_daemon '_start_daemons_postfix'
186 | 
187 |   # needs to be started after postfix
188 |   [[ ${ENABLE_SASLAUTHD} -eq 1 ]] && _register_start_daemon '_start_daemons_saslauthd'
189 |   [[ ${ENABLE_FAIL2BAN} -eq 1 ]] &&	_register_start_daemon '_start_daemons_fail2ban'
190 |   [[ ${ENABLE_FETCHMAIL} -eq 1 ]] && _register_start_daemon '_start_daemons_fetchmail'
191 |   [[ ${ENABLE_CLAMAV} -eq 1 ]] &&	_register_start_daemon '_start_daemons_clamav'
192 |   [[ ${ENABLE_LDAP} -eq 0 ]] && _register_start_daemon '_start_changedetector'
193 |   [[ ${ENABLE_SQL} -eq 0 ]] && _register_start_daemon '_start_changedetector'
194 |   [[ ${ENABLE_AMAVIS} -eq 1 ]] && _register_start_daemon '_start_daemons_amavis'
195 | }
196 | 
197 | function _register_start_daemon
198 | {
199 |   DAEMONS_START+=("${1}")
200 |   _notify 'inf' "${1}() registered"
201 | }
202 | 
203 | function _register_setup_function
204 | {
205 |   FUNCS_SETUP+=("${1}")
206 |   _notify 'inf' "${1}() registered"
207 | }
208 | 
209 | function _register_fix_function
210 | {
211 |   FUNCS_FIX+=("${1}")
212 |   _notify 'inf' "${1}() registered"
213 | }
214 | 
215 | function _register_check_function
216 | {
217 |   FUNCS_CHECK+=("${1}")
218 |   _notify 'inf' "${1}() registered"
219 | }
220 | 
221 | function _register_misc_function
222 | {
223 |   FUNCS_MISC+=("${1}")
224 |   _notify 'inf' "${1}() registered"
225 | }
226 | 
227 | # ------------------------------------------------------------
228 | # ? << Registering functions
229 | # --
230 | # ? >> Sourcing all stacks
231 | #      1. Checks
232 | #      2. Setup
233 | #      3. Fixes
234 | #      4. Miscellaneous
235 | #      5. Daemons
236 | # ------------------------------------------------------------
237 | 
238 | # shellcheck source=./startup/check-stack.sh
239 | . /usr/local/bin/check-stack.sh
240 | 
241 | # shellcheck source=./startup/setup-stack.sh
242 | . /usr/local/bin/setup-stack.sh
243 | 
244 | # shellcheck source=./startup/fixes-stack.sh
245 | . /usr/local/bin/fixes-stack.sh
246 | 
247 | # shellcheck source=./startup/misc-stack.sh
248 | . /usr/local/bin/misc-stack.sh
249 | 
250 | # shellcheck source=./startup/daemons-stack.sh
251 | . /usr/local/bin/daemons-stack.sh
252 | 
253 | # ------------------------------------------------------------
254 | # ? << Sourcing all stacks
255 | # --
256 | # ? >> Executing all stacks
257 | # ------------------------------------------------------------
258 | 
259 | _notify 'tasklog' "Welcome to docker-mailserver $(</VERSION)"
260 | 
261 | register_functions
262 | check
263 | setup
264 | [[ ${DMS_DEBUG} -eq 1 ]] && print-environment
265 | fix
266 | start_misc
267 | start_daemons
268 | 
269 | _notify 'tasklog' "${HOSTNAME} is up and running"
270 | 
271 | touch /var/log/mail/mail.log
272 | tail -Fn 0 /var/log/mail/mail.log
273 | 
274 | exit 0
275 | 


--------------------------------------------------------------------------------
/mail/target/scripts/startup/check-stack.sh:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | function check
 4 | {
 5 |   _notify 'tasklog' 'Checking configuration'
 6 |   for FUNC in "${FUNCS_CHECK[@]}"
 7 |   do
 8 |     ${FUNC}
 9 |   done
10 | }
11 | 
12 | function _check_hostname
13 | {
14 |   _notify 'task' 'Checking that hostname/domainname is provided or overridden'
15 | 
16 |   _notify 'inf' "Domain has been set to ${DOMAINNAME}"
17 |   _notify 'inf' "Hostname has been set to ${HOSTNAME}"
18 | 
19 |   # HOSTNAME should be an FQDN (eg: hostname.domain)
20 |   if ! grep -q -E '^(\S+[.]\S+)$' <<< "${HOSTNAME}"
21 |   then
22 |     _shutdown 'Setting hostname/domainname is required'
23 |   fi
24 | }
25 | 


--------------------------------------------------------------------------------
/mail/target/scripts/startup/daemons-stack.sh:
--------------------------------------------------------------------------------
  1 | #! /bin/bash
  2 | 
  3 | function start_daemons
  4 | {
  5 |   _notify 'tasklog' 'Starting daemons & mail server'
  6 |   for FUNC in "${DAEMONS_START[@]}"
  7 |   do
  8 |     ${FUNC}
  9 |   done
 10 | }
 11 | 
 12 | function _start_daemons_cron
 13 | {
 14 |   _notify 'task' 'Starting cron'
 15 |   supervisorctl start cron || dms_panic__fail_init 'cron'
 16 | }
 17 | 
 18 | function _start_daemons_rsyslog
 19 | {
 20 |   _notify 'task' 'Starting rsyslog'
 21 |   supervisorctl start rsyslog || dms_panic__fail_init 'rsyslog'
 22 | }
 23 | 
 24 | function _start_daemons_saslauthd
 25 | {
 26 |   _notify 'task' 'Starting saslauthd'
 27 |   supervisorctl start "saslauthd_${SASLAUTHD_MECHANISMS}" || dms_panic__fail_init 'saslauthd'
 28 | }
 29 | 
 30 | function _start_daemons_fail2ban
 31 | {
 32 |   _notify 'task' 'Starting Fail2ban'
 33 |   touch /var/log/auth.log
 34 | 
 35 |   # delete fail2ban.sock that probably was left here after container restart
 36 |   if [[ -e /var/run/fail2ban/fail2ban.sock ]]
 37 |   then
 38 |     rm /var/run/fail2ban/fail2ban.sock
 39 |   fi
 40 | 
 41 |   supervisorctl start fail2ban || dms_panic__fail_init 'Fail2ban'
 42 | }
 43 | 
 44 | function _start_daemons_opendkim
 45 | {
 46 |   _notify 'task' 'Starting opendkim'
 47 |   supervisorctl start opendkim || dms_panic__fail_init 'opendkim'
 48 | }
 49 | 
 50 | function _start_daemons_opendmarc
 51 | {
 52 |   _notify 'task' 'Starting opendmarc'
 53 |   supervisorctl start opendmarc || dms_panic__fail_init 'opendmarc'
 54 | }
 55 | 
 56 | function _start_daemons_postsrsd
 57 | {
 58 |   _notify 'task' 'Starting postsrsd'
 59 |   supervisorctl start postsrsd || dms_panic__fail_init 'postsrsd'
 60 | }
 61 | 
 62 | function _start_daemons_postfix
 63 | {
 64 |   _notify 'task' 'Starting postfix'
 65 |   supervisorctl start postfix || dms_panic__fail_init 'postfix'
 66 | }
 67 | 
 68 | function _start_daemons_dovecot
 69 | {
 70 |   _notify 'task' 'Starting dovecot services'
 71 | 
 72 |   if [[ ${ENABLE_POP3} -eq 1 ]]
 73 |   then
 74 |     _notify 'task' 'Starting pop3 services'
 75 |     mv /etc/dovecot/protocols.d/pop3d.protocol.disab \
 76 |       /etc/dovecot/protocols.d/pop3d.protocol
 77 |   fi
 78 | 
 79 |   if [[ -f /tmp/docker-mailserver/dovecot.cf ]]
 80 |   then
 81 |     cp /tmp/docker-mailserver/dovecot.cf /etc/dovecot/local.conf
 82 |   fi
 83 | 
 84 |   supervisorctl start dovecot || dms_panic__fail_init 'dovecot'
 85 | }
 86 | 
 87 | function _start_daemons_fetchmail
 88 | {
 89 |   _notify 'task' 'Preparing fetchmail config'
 90 |   /usr/local/bin/setup-fetchmail
 91 | 
 92 |   if [[ ${FETCHMAIL_PARALLEL} -eq 1 ]]
 93 |   then
 94 |     mkdir /etc/fetchmailrc.d/
 95 |     /usr/local/bin/fetchmailrc_split
 96 | 
 97 |     local COUNTER=0
 98 |     for RC in /etc/fetchmailrc.d/fetchmail-*.rc
 99 |     do
100 |       COUNTER=$(( COUNTER + 1 ))
101 |       cat >"/etc/supervisor/conf.d/fetchmail-${COUNTER}.conf" << EOF
102 | [program:fetchmail-${COUNTER}]
103 | startsecs=0
104 | autostart=false
105 | autorestart=true
106 | stdout_logfile=/var/log/supervisor/%(program_name)s.log
107 | stderr_logfile=/var/log/supervisor/%(program_name)s.log
108 | user=fetchmail
109 | command=/usr/bin/fetchmail -f ${RC} -v --nodetach --daemon %(ENV_FETCHMAIL_POLL)s -i /var/lib/fetchmail/.fetchmail-UIDL-cache --pidfile /var/run/fetchmail/%(program_name)s.pid
110 | EOF
111 |       chmod 700 "${RC}"
112 |       chown fetchmail:root "${RC}"
113 |     done
114 | 
115 |     supervisorctl reread
116 |     supervisorctl update
117 | 
118 |     COUNTER=0
119 |     for _ in /etc/fetchmailrc.d/fetchmail-*.rc
120 |     do
121 |       COUNTER=$(( COUNTER + 1 ))
122 |       _notify 'task' "Starting fetchmail instance ${COUNTER}"
123 |       supervisorctl start "fetchmail-${COUNTER}" || _panic__fail_init "fetchmail-${COUNTER}"
124 |     done
125 |   else
126 |     _notify 'task' 'Starting fetchmail'
127 |     supervisorctl start fetchmail || dms_panic__fail_init 'fetchmail'
128 |   fi
129 | }
130 | 
131 | function _start_daemons_clamav
132 | {
133 |   _notify 'task' 'Starting clamav'
134 |   supervisorctl start clamav || dms_panic__fail_init 'ClamAV'
135 | }
136 | 
137 | function _start_daemons_postgrey
138 | {
139 |   _notify 'task' 'Starting postgrey'
140 |   rm -f /var/run/postgrey/postgrey.pid
141 |   supervisorctl start postgrey || dms_panic__fail_init 'postgrey'
142 | }
143 | 
144 | function _start_daemons_amavis
145 | {
146 |   _notify 'task' 'Starting amavis'
147 |   supervisorctl start amavis || dms_panic__fail_init 'amavis'
148 | }
149 | 
150 | function _start_changedetector
151 | {
152 |   _notify 'task' 'Starting changedetector'
153 |   supervisorctl start changedetector || dms_panic__fail_init 'changedetector'
154 | }
155 | 
156 | function _start_daemons_update_check
157 | {
158 |   _notify 'task' 'Starting update-check'
159 |   supervisorctl start update-check || dms_panic__fail_init 'update-check'
160 | }
161 | 


--------------------------------------------------------------------------------
/mail/target/scripts/startup/fixes-stack.sh:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | function fix
 4 | {
 5 |   _notify 'tasklog' 'Post-configuration checks'
 6 |   for FUNC in "${FUNCS_FIX[@]}"
 7 |   do
 8 |     ${FUNC}
 9 |   done
10 | 
11 |   _notify 'inf' 'Removing leftover PID files from a stop/start'
12 |   find /var/run/ -not -name 'supervisord.pid' -name '*.pid' -delete
13 |   touch /dev/shm/supervisor.sock
14 | }
15 | 
16 | function _fix_var_mail_permissions
17 | {
18 |   _notify 'task' 'Checking /var/mail permissions'
19 | 
20 |   # fix permissions, but skip this if 3 levels deep the user id is already set
21 |   if find /var/mail -maxdepth 3 -a \( \! -user 5000 -o \! -group 5000 \) | read -r
22 |   then
23 |     _notify 'inf' 'Fixing /var/mail permissions'
24 |     chown -R 5000:5000 /var/mail || _shutdown 'Failed to fix /var/mail permissions'
25 |   else
26 |     _notify 'inf' 'Permissions in /var/mail look OK'
27 |   fi
28 | }
29 | 
30 | function _fix_var_amavis_permissions
31 | {
32 |   local AMAVIS_STATE_DIR='/var/mail-state/lib-amavis'
33 |   [[ ${ONE_DIR} -eq 0 ]] && AMAVIS_STATE_DIR="/var/lib/amavis"
34 |   [[ ! -e ${AMAVIS_STATE_DIR} ]] && return 0
35 | 
36 |   _notify 'inf' 'Fixing Amavis permissions'
37 |   chown -hR amavis:amavis "${AMAVIS_STATE_DIR}" || _shutdown 'Failed to fix Amavis permissions'
38 | }
39 | 
40 | function _fix_cleanup_clamav
41 | {
42 |   _notify 'task' 'Cleaning up disabled ClamAV'
43 |   rm /etc/logrotate.d/clamav-* /etc/cron.d/clamav-freshclam || _notify 'err' 'Failed to remove ClamAV configuration'
44 | }
45 | 
46 | function _fix_cleanup_spamassassin
47 | {
48 |   _notify 'task' 'Cleaning up disabled SpamAssassin'
49 |   rm /etc/cron.daily/spamassassin || _notify 'err' 'Failed to remove SpamAssassin configuration'
50 | }
51 | 


--------------------------------------------------------------------------------
/mail/target/scripts/startup/misc-stack.sh:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | function start_misc
 4 | {
 5 |   _notify 'inf' 'Starting miscellaneous tasks'
 6 |   for FUNC in "${FUNCS_MISC[@]}"
 7 |   do
 8 |     ${FUNC}
 9 |   done
10 | }
11 | 
12 | # consolidate all states into a single directory
13 | # (/var/mail-state) to allow persistence using docker volumes
14 | function _misc_save_states
15 | {
16 |   local STATEDIR FILE FILES
17 | 
18 |   STATEDIR='/var/mail-state'
19 | 
20 |   if [[ ${ONE_DIR} -eq 1 ]] && [[ -d ${STATEDIR} ]]
21 |   then
22 |     _notify 'inf' "Consolidating all state onto ${STATEDIR}"
23 | 
24 |     FILES=(
25 |       spool/postfix
26 |       lib/postfix
27 |       lib/amavis
28 |       lib/clamav
29 |       lib/spamassassin
30 |       lib/fail2ban
31 |       lib/postgrey
32 |       lib/dovecot
33 |     )
34 | 
35 |     for FILE in "${FILES[@]}"
36 |     do
37 |       DEST="${STATEDIR}/${FILE//\//-}"
38 |       FILE="/var/${FILE}"
39 | 
40 |       if [[ -d ${DEST} ]]
41 |       then
42 |         _notify 'inf' "Destination ${DEST} exists, linking ${FILE} to it"
43 |         rm -rf "${FILE}"
44 |         ln -s "${DEST}" "${FILE}"
45 |       elif [[ -d ${FILE} ]]
46 |       then
47 |         _notify 'inf' "Moving contents of ${FILE} to ${DEST}"
48 |         mv "${FILE}" "${DEST}"
49 |         ln -s "${DEST}" "${FILE}"
50 |       else
51 |         _notify 'inf' "Linking ${FILE} to ${DEST}"
52 |         mkdir -p "${DEST}"
53 |         ln -s "${DEST}" "${FILE}"
54 |       fi
55 |     done
56 | 
57 |     _notify 'inf' 'Fixing /var/mail-state/* permissions'
58 |     chown -R clamav /var/mail-state/lib-clamav
59 |     chown -R postfix /var/mail-state/lib-postfix
60 |     chown -R postgrey /var/mail-state/lib-postgrey
61 |     chown -R debian-spamd /var/mail-state/lib-spamassassin
62 | 
63 |     # UID = postfix(101): active, bounce, corrupt, defer, deferred, flush, hold, incoming, maildrop, private, public, saved, trace
64 |     # UID = root(0): dev, etc, lib, pid, usr
65 |     # GID = postdrop(103): maildrop, public
66 |     # GID for all other directories is root(0)
67 |     # Set most common ownership:
68 |     chown -R postfix:root /var/mail-state/spool-postfix
69 |     # These two require the postdrop(103) group:
70 |     chgrp -R postdrop /var/mail-state/spool-postfix/maildrop
71 |     chgrp -R postdrop /var/mail-state/spool-postfix/public
72 |     # These all have root ownership at the src location:
73 |     chown -R root /var/mail-state/spool-postfix/dev
74 |     chown -R root /var/mail-state/spool-postfix/etc
75 |     chown -R root /var/mail-state/spool-postfix/lib
76 |     chown -R root /var/mail-state/spool-postfix/pid
77 |     chown -R root /var/mail-state/spool-postfix/usr
78 |   fi
79 | }
80 | 


--------------------------------------------------------------------------------
/mail/target/scripts/update-check.sh:
--------------------------------------------------------------------------------
 1 | #! /bin/bash
 2 | 
 3 | VERSION=$(</VERSION)
 4 | VERSION_URL="https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master/VERSION"
 5 | CHANGELOG="https://github.com/docker-mailserver/docker-mailserver/blob/master/CHANGELOG.md"
 6 | 
 7 | function _log
 8 | {
 9 |   DATE=$(date '+%F %T')
10 |   echo "${DATE} ${1}"
11 | }
12 | 
13 | # check for correct syntax
14 | # number + suffix. suffix must be 's' for seconds, 'm' for minutes, 'h' for hours or 'd' for days.
15 | if [[ ! ${UPDATE_CHECK_INTERVAL} =~ ^[0-9]+[smhd]{1}$ ]]
16 | then
17 |   _log "Error: Invalid UPDATE_CHECK_INTERVAL value: ${UPDATE_CHECK_INTERVAL}"
18 |   _log "Info: Fallback to daily update checks"
19 |   UPDATE_CHECK_INTERVAL="1d"
20 | fi
21 | 
22 | while true
23 | do
24 |   # get remote version information
25 |   LATEST=$(curl -Lsf "${VERSION_URL}")
26 | 
27 |   # did we get a valid response?
28 |   if [[ ${LATEST} =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]
29 |   then
30 |     _log "Info: Remote version information fetched"
31 | 
32 |     # compare versions
33 |     if dpkg --compare-versions "${VERSION}" lt "${LATEST}"
34 |     then
35 |       # send mail notification to postmaster
36 |       read -r -d '' MAIL << EOM
37 | Hello ${POSTMASTER_ADDRESS}!
38 | 
39 | There is a docker-mailserver update available on your host: $(hostname -f)
40 | 
41 | Current version: ${VERSION}
42 | Latest  version: ${LATEST}
43 | 
44 | Changelog: ${CHANGELOG}
45 | EOM
46 |       echo "${MAIL}" | mail -s "Mailserver update available! [ ${VERSION} --> ${LATEST} ]" "${POSTMASTER_ADDRESS}" && \
47 | 
48 |       _log "Info: Update available [ ${VERSION} --> ${LATEST} ]" && \
49 | 
50 |       # only notify once
51 |       exit 0
52 |     else
53 |       _log "Info: No update available"
54 |     fi
55 |   else
56 |     _log "Error: Update check failed."
57 |   fi
58 |   # check again in one day
59 |   sleep "${UPDATE_CHECK_INTERVAL}"
60 | done
61 | 


--------------------------------------------------------------------------------