14 Commits

Author	SHA1	Message	Date
Georg Lauterbach	ab55343d8e	scripts: rework environment variables setup (#2716) ... * outsourcing env variable setup This commit contains major parts of the work of refactoring the setup and usage of environment variables. It outsources the setup into its own script and provides dedicated functions to be executed at a later point in time. A **new** env variable was added: `USER_PROVISIONG` which provides a better way of defining which method / protocol to use when it comes to setting up users. This way, the `ENABLE_LDAP` variable is deprecated, but all of this is backwards compatible due to a "compatibility layer", a function provided by the new variables script. This is not a breaking change. It mostly refators internal scripts. The only change facing the user-side is the deprecation of `ENABLE_LDAP`. We can prolong the period of deprecation for this variable as long as we want, because the new function that ensures backwards compatibility provides a clean interface for the future. Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com> Co-authored-by: Casper <casperklein@users.noreply.github.com>	2022-08-22 08:31:32 +02:00
Georg Lauterbach	21c218ac68	scripts: remove DMS_DEBUG (#2523) ... * remove DMS_DEBUG from tests * remove DMS_DEBUG from doc and scripts * updated issue template * re-add description about removal of DMS_DEBUG	2022-04-03 13:29:10 +02:00
Georg Lauterbach	24031ae365	scripts: new log (#2493) ... * added new `_log` function With `_log`, the `_notify` method wa rendered obsolete. `_notify` was not completely removed due to test failures in `check-for-changes.sh`. The new `_log` function properly uses log levels such as `trace`, `debug`, `info`, `warn` and `error`. It provides a cleaner solution and renders `DMS_DEBUG` obsolete too (as only `_notify` depends on it). * converted all helper script to new `_log` function * converted all startup stacks to new `log` function * `start-mailserver.sh` now uses new `_log` function * final test and misc small script adjustments * updated documentation	2022-03-21 07:07:52 +01:00
NorseGaud	54e41d04f7	removed Darwin specific code and modified the docs to indicate macOS is not supported	2022-03-06 11:59:53 -05:00
Casper	d46e094280	Remove quotes to meet style guidelines (#2330) ... Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>	2021-12-21 17:01:40 +01:00
Casper	054ee5bd09	Update "error tracing" doc (#2216)	2021-09-26 10:37:50 +02:00
Brennan Kinney	a0ee472501	docs(chore): Normalize for consistency (#2206) ... "Brief" summary/overview of changes. See the PR discussion or individual commits from the PR for more details. --- Only applies to the `docs/content/**` content (_and `setup` command_). `target/` and `test/` can be normalized at a later date. * Normalize to `example.com` - Domains normalized to `example.com`: `mywebserver.com`, `myserver.tld`, `domain.com`, `domain.tld`, `mydomain.net`, `my-domain.tld`, `my-domain.com`, `example.org`, `whoami.com`. - Alternative domains normalized to `not-example.com`: `otherdomain.com`, `otherdomain.tld`, `domain2.tld`, `mybackupmx.com`, `whoareyou.org`. - Email addresses normalized to `admin@example.com` (in `ssl.md`): `foo@bar.com`, `yourcurrentemail@gmail.com`, `email@email.com`, `admin@domain.tld`. - Email addresses normalized to `external-account@gmail.com`: `bill@gates321boom.com`, `external@gmail.com`, `myemail@gmail.com`, `real-email-address@external-domain.com`. - **`faq.md`:** A FAQ entry title with `sample.domain.com` changed to `subdomain.example.com`. - **`mail-fetchmail.md`:** Config examples with FQDNs for `imap`/`pop3` used `example.com` domain for a third-party, changed to `gmail.com` as more familiar third-party/external MTA. * Normalize config volume path - Normalizing local config path references to `./docker-data/dms/config/`: `./config/`, `config/`, \``config`\`, `/etc/` (_volume mount src path prefix_). - Normalize DMS volume paths to `docker-data/dms/mail-{data,state,log}`: `./mail`, `./mail-state` `./data/mail`, `./data/state`, `./data/logs`, `./data/maildata`, `./data/mailstate`, `./data/maillogs`, (_dropped/converted data volumes: `maildata`, `mailstate`_). - Other docker images also adopt the `docker-data/{service name}/` prefix. * `ssl.md` - Use `dms/custom-certs` where appropriate. * Apply normalizations to README and example `docker-compose.yml` --- Common terms, sometimes interchangeably used or now invalid depending on context: `mail`, `mail container`, `mail server`, `mail-server`, `mailserver`,`docker-mailserver`, `Docker Mailserver`. Rough transformations applied to most matches (_conditionally, depending on context_): - 'Docker Mailserver' => '`docker-mailserver`' - 'mail container' => '`docker-mailserver`' (_optionally retaining ' container'_) - 'mail server' => 'mail-server' / '`docker-mailserver`' - 'mail-server' => '`docker-mailserver`' - 'mailserver' => 'mail-server' / '`docker-mailserver`' Additionally I checked `docker run` (_plus `exec`, `logs`, etc, sub-commands_) and `docker-compose` commands. Often finding usage of `mail` instead of the expected `mailserver` Additionally changes `mailserver` hostname in k8s to `mail` to align with other non-k8s examples. --- * drive-by revisions Mostly minor revisions or improvements to docs that aren't related to normalization effort.	2021-09-23 11:29:37 +12:00
William Desportes	a1b6097152	docs: Add a contributing docs guide (#2129)	2021-08-14 00:14:26 +12:00
Georg Lauterbach	e7b88d865b	cleaned up >/dev/nulls in Dockerfile and replaced em dashes with normal dashes (#2024)	2021-06-08 13:20:20 +12:00
Nathan Pierce	543bd8b16b	MacOS linting & testing support + docs (#2001)	2021-06-07 14:58:34 +02:00
Georg Lauterbach	5449efd8d4	chore(docs): outsourcing environment vars to the documentation (#1948) ... Co-authored-by: Frederic Werner <20406381+wernerfred@users.noreply.github.com> Co-authored-by: Casper <casperklein@users.noreply.github.com> Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>	2021-05-11 22:15:34 +12:00
Semir Patel	0cd723208c	Fix spacing typo (#1872)	2021-03-29 15:41:41 +02:00
wernerfred	463bc967d2	docs(fix): Update wiki references to the new docs url ... Additionally replaces old references to `tvial` images with the new `mailserver` docker image name.	2021-03-25 11:49:24 +13:00
wernerfred	cc0706a6fa	docs: Add a contributing section	2021-03-25 11:49:24 +13:00