Commit graph

103 commits

Author SHA1 Message Date
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
Georg Lauterbach 8313d9753b
Adjusted documentation for service name and Traefik certificate issuance (#1918)
Co-authored-by: Casper <casperklein@users.noreply.github.com>
2021-04-18 15:21:08 +02:00
Nathan Pierce 0fb5251c20
docs: add mail_crypt plugin documentation (#1913)
* mail_crypt plugin + quick improvement to dovecot override defaults doc

* quick change for <your-container-name> to use mailserver

Co-authored-by: Georg Lauterbach <44545919+aendeavor@users.noreply.github.com>
2021-04-18 00:31:09 +02:00
wernerfred 711b4c9d83 docs(refactor): Convert more content to use admonitions + improvements 2021-03-25 11:49:24 +13: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
polarathene 021e942c4c docs(refactor): Large refactor + additions + fixes
Consistency pass, formatting cleanup and fixes, introduce admonitions, add front-matter.

---

docs: Add front-matter

---

docs: Fix and format links

- Some links were invalid (eg files moved or renamed)
- Some were valid but had invalid section headers (content removed or migrated)
- Some use `http://` instead of `https://` when the website supports a secure connection.
- Some already used the `[name][reference]` convention but often with a number that wasn't as useful for maintenance.
- All referenced docs needed URLs replaced. Opted for the `[name][reference]` approach to group them all clearly at the bottom of the doc, especially with the relative URLs and in some cases many duplicate entries.
- All `tomav` references from the original repo prior to switch to an organization have been corrected.
- Minor cosmetic changes to the `name` part of the URL, such as for referencing issues to be consistent.
- Some small changes to text body, usually due to duplicate URL reference that was unnecessary (open relay, youtous)
- Switched other links to use the `[name][reference]` format when there was a large group of URLs such as wikipedia or kubernetes. Github repos that reference projects related to `docker-mailserver` also got placed here so they're noticed better by maintainers. This also helped quite a bit with `mermaid` external links that are very long.
- There was a Github Wiki supported syntax in use `[[name | link]]` for `fetchmail` page that isn't compatible by default with MkDocs (needs a plugin), converted to `[name][reference]` instead since it's a relative link.

---

docs: Update commit link for LDAP override script

Logic moved to another file, keeping the permalink commit reference so it's unaffected by any changes in the file referenced in future.

---

docs: Heading corrections

Consistency pass. Helps with the Table of Contents (top-right UI) aka Document Outline.
docs: codefence cleanup

---

docs: misc cleanup

---

docs: Add Admonitions

Switches `<details>` usage for collapsible admonitions (`???`) while other text content is switched to the visually more distinct admoniton (`!!!` or `???+`) style.

This does affect editor syntax highlighting a bit and markdown linting as it's custom non-standard markdown syntax.
2021-03-25 11:49:24 +13:00
Germain Masse ee557c9e3f Command-line to verify certificate dates 2020-11-29 20:23:43 +01:00
Germain Masse 77308d269d Moving Caddy pitfall to a dedicated section 2020-11-29 19:44:50 +01:00
Dorian Ayllón 28a5fb6436 Fix example YAML markdown code block 2020-10-21 17:08:34 +02:00
squash 4fc4fe97f7 Update for key_type global option with Caddy v2 for people sharing their LE certs between Caddy and docker-mailserver 2020-10-01 14:06:51 -04:00
Georg Lauterbach 4424495f63 Traefik2's wildcard certificates now work with :stable 2020-09-26 14:52:36 +02:00
Erik Wramner 6dce6c6cf7 Changed stable to latest for Traefik as the code has not been merged into stable yet 2020-08-07 09:54:31 +02:00
Michael 6f04051ffd traefik v2 section added 2020-07-16 21:12:50 +02:00
Brennan Kinney 4a53a2566a Add flowchart for SMTP, expand on inbound/outband SMTP traffic and ports 2020-06-13 20:44:34 +12:00
Brennan Kinney acf3d88d43 Initial more details page to redirect from README on the ports section 2020-06-12 20:19:52 +12:00
Jean-Denis Vauguet 943b4a9f71 Updated Configure SSL (markdown) 2020-05-29 10:25:02 +02:00
Jean-Denis Vauguet bbcc7e3038 better not to keep outdated example, upstream's doc is the way to go 2020-05-29 10:23:58 +02:00
rhyst 087a4ae750 Adding instructions for Caddy V2 2020-05-11 17:52:25 +01:00
Erik Wramner 2e0284ded3 Added note about caddy 2020-05-04 08:01:53 +02:00
youtous 404ac5a438 add ssl doc: traefik 2020-04-23 15:49:52 +02:00
Hans-Cees Speel 88e1d453f0 Updated Configure SSL (markdown) 2020-02-25 14:27:31 +01:00
Hans-Cees Speel 4ca57b8e9e Updated Configure SSL (markdown) 2020-02-25 14:24:36 +01:00
Vilius 2305c464bb Fixed a typo in docker repository name (certbot instead of cerbot) 2019-11-17 11:47:23 +02:00
Germain Masse 2ebea365e6 Replace deliveries/certbot docker image by official certbot/cerbot 2019-11-04 19:36:52 +01:00
Andreas Perhab 37966e425d path for generated certificates has changed 2019-10-11 12:10:23 +02:00
lukas 96524e30b4 Updated Configure SSL (markdown) 2019-08-23 12:35:00 -06:00
lukas eb9c857903 Updated Configure SSL (markdown) 2019-08-22 10:12:23 -06:00
MegaXLR 2df81a970b LetsEncrypt has a http challenge that runs http and https. 2019-04-19 14:15:44 +02:00
Anne 5d29e8e8c9 Updated Configure SSL (markdown) 2019-02-20 15:00:22 +01:00
Anne 225de9aadb Updated Configure SSL (markdown) 2019-02-20 14:50:48 +01:00
Anne 2500b0704c Updated Configure SSL (markdown) 2019-02-20 14:46:54 +01:00
Gabriel Landais 907afcfbce Updated Configure SSL (markdown) 2018-11-12 23:29:42 +01:00
Serge van den Boom cbe8cb9105 fix typo 2018-10-28 15:56:16 +01:00
andymel a67a8d8125 undo my last edit as I'm surprised it seems to really edit the original page 2018-03-28 00:24:49 +02:00
andymel b73a1cee2d wrong binding of host<->container directory (etc/<->etc/letsencrypt) 2018-03-27 23:26:30 +02:00
17Halbe 7fc0bf145f Updated Configure Fail2ban (markdown) 2018-02-08 08:28:41 +01:00
Marek Walczak 2be8757322 this an explaining PR #769 2017-11-30 22:55:27 +01:00
makloda b7259d2500 Added info on how to use Synology NAS generated letsencrypt certificates and how to find them 2017-11-11 18:38:37 +01:00
presocratics f7e153ed2b I added a sub-section describing how Let's Encrypt certificate generation and renewal for docker-mailserver can be done with nginx-proxy and letsencrypt-nginx-proxy-companion 2017-09-26 14:39:39 -05:00
Edmond Varga d513564d98 After running certbot successfully and mounted ~/docker/letsencrypt/etc/letsencrypt, the /etc/letsencrypt in the docker-mailserver was empty. Certificates are now located in ~/docker/letsencrypt/etc/live, reason I suggested the edit for mounting the right path of /home/ubuntu/docker/letsencrypt/etc/ 2017-08-25 09:15:39 +03:00
Leo Winter 453ee67f23 cd to right path for the next command with $PWD 2017-08-06 22:16:34 +02:00
Edward Knyshov 197318f1ab Updated Configure SSL (markdown) 2017-02-12 17:14:53 +07:00
Wim 597d642f8c Add docker letsencrypt example 2017-01-31 00:13:26 +01:00
Sebastian Straub bfe70de0c8 how to add your own certificates 2016-10-01 15:49:10 +02:00
Josef Friedrich f47bfb7edb Latest version of docker-mailserver uses dovecot instead of courier 2016-09-01 17:22:50 +02:00
Stig Otnes Kolstad 48c107a302 Fixed incorrect environment variable 2016-08-31 16:28:52 +02:00
GrupoCITEC d2a9e6c1ee Updated Configure SSL (markdown) 2016-08-17 09:38:35 -03:00
Dominik Winter 977cda00a0 Updated Configure Fail2ban (markdown) 2016-06-04 13:25:15 +02:00
Thomas VIAL 7c825641f0 Fixed repo URL 2016-06-01 12:43:13 +02:00
Thorsten von Eicken e45d58cac0 added Fail2ban config page 2016-05-31 19:22:15 -07:00
Josef Friedrich d113a5717f Add more informations how the fqdn is composed 2016-05-13 13:24:59 +02:00
Josef Friedrich 85d4f006b1 Add detailed 2016-05-13 13:21:35 +02:00
Thomas VIAL 5adbdcfb10 Updated SSL (markdown) 2016-04-24 17:16:23 +02:00