Commit graph

25 commits

Author SHA1 Message Date
Pouriya Jahanbakhsh
46dcef4110 doc: replace maddyctl with maddy 2022-11-06 11:32:23 +03:30
fox.cpp
d6a317e32a
docs: Update Arch repository and Docker instructions links
See #513.
2022-07-01 23:40:59 +03:00
fox.cpp
df40dce128
docs: Link to maddy.email/builds in setup tutorial
Also add link in the side-bar.
See #407.
2021-10-05 17:20:33 +03:00
Giorgi Lekveishvili
31265e3371 Add missing . (dot) in default domain key record 2021-09-22 17:48:15 +03:00
Gusted
6f54015daa
docs: Fix typo in DNS record example in setting-up.md (#377)
`STS1` -> `STSv1`
2021-07-30 08:17:50 +03:00
Max Mazurov
20c9991244
docs: Improve setting up tutorial
Add more recommended best practice and fix a few mistakes.

1. SPF record should also be available via MX hostname (more precisely, HELO hostname we identify as)
2. MTA-STS requires an TXT record
3. TLSRPT can be used to get information about MTA-STS breakage.
4. Use p=quarantine in DMARC
5. Recommend deploying DANE in addition to MTA-STS
2021-07-08 18:44:29 +00:00
Arisu Desu
3fbd1e271f Add missing mailto: to DMARC ruf parameter in tutorial 2021-07-03 07:00:44 +00:00
fox.cpp
9f9377b92e
docs: Fix a few typos in setting-up.md 2021-04-12 10:35:33 +03:00
fox.cpp
43d494e70a
docs: Improve setting-up tutorial 2021-04-12 10:32:49 +03:00
fox.cpp
5eec45ec0d
docs: Replace foxcpp.dev/maddy with maddy.email 2021-03-07 22:15:24 +03:00
schrodinger
2344c9f87f
docs: Improve setting-up.md (#261)
* Update setting-up.md

replacing hostname mx.example.org by example.org accordingly to the rest of the tutorial which doesn't refer to it (i.e. DNS configuration).

* readding MX1, with more detail

* adding A entry for mx1

* fixing ========
2020-08-09 08:44:39 +03:00
fox.cpp
18494cfff7
docs: Remove fail2ban from initial configuration
maddy runs just fine without such filtering and time values
used in shipped configs are rather questionable.
2020-08-03 16:43:18 +03:00
fox.cpp
27487b1db2
docs: Clarify configuration for multiple domains 2020-08-03 16:43:18 +03:00
fox.cpp
d194b2e2a4
docs: Update to use Make for source builds, recommend built tarballs as a primary way 2020-08-03 16:43:18 +03:00
fox.cpp
bd9a3026b1
docs: Fix formatting and fix possibly confusing MTA-STS example 2020-06-10 23:11:42 +03:00
fox.cpp
e19d21dfcb
Fully separate authentication from IMAP access
Now imapsql module does not handle authentication. (it was not doing it so well
anyway)

sql_table module was introduced and used in the default configuration as
a replacement for functionality that was implemented by imapsql before.

Parts of maddyctl code were rewritten to make it work transparently with
any IMAP backend or credentials store.

Closes #212.
2020-04-14 00:06:47 +03:00
bn4t
609a8fd235 Add missing packages for compilation and fail2ban setup 2020-04-13 18:54:29 +00:00
fox.cpp
8f1d57293c
docs: Several minor edits
Remove examples/ dir reference from REDME. It no longer exists.
Mention scdoc in installation tutorial.
Fix vim joke formatting.
Mention systemctl daemon-reload in intallation tutorial.
2020-02-23 17:42:45 +03:00
fox.cpp
494fd2ac72
build.sh: Remove wget dependency
It is rather silly to use curl to fetch the script itself (in tutorial)
and use wget internally.
2020-02-23 17:33:51 +03:00
fox.cpp
d2a68adf74
docs: Be more specific about build.sh dependencies
It uses Git to clone the repo and wget to download toolchain if it is
missing.
2020-02-23 04:27:57 +03:00
fox.cpp
a288d2e144
docs: Mention prebuilt binaries in the setup tutorial 2020-02-23 02:15:31 +03:00
fox.cpp
f931cbfe45
Rewrite build scripts
New script build.sh is much more suitable for downstream packaging
(e.g. ./build.sh package) than hacked together package.sh wrapper for
get.sh while still being usable for "effort-less" installation.

Additionally, hostname setting in get.sh is flawed in many ways and is
not reimplemented in build.sh.

build.sh has proper command line options that allow to customize build
configuration and installation prefixes.
Documentation page get.sh is removed since all applicable environment
variables and flags are documented in ./build.sh --help.

build.sh can be called from the source directory to build maddy from
*this* source instead of forced 'go get' that was used in get.sh.
However, if build.sh is called not from the source directory, it clones
the repo and (optionally) uses the specified commit. This keeps build.sh
usable in curl|bash commands.

Due to the way source code is fetched, build.sh uses Git tags instead of
Go module versions as get.sh did.
2020-02-07 20:33:58 +03:00
fox.cpp
14505f4de1
config: Reload TLS server certificates once in a minute
Use of inotify and possibly other mechanisms poses portability risks.
Notably, "cross-platform" abstractions such as fsnotify library remove
access to certain features that are important to use it correctly in
some cases e.g. it is preferable to listen only for IN_CLOSE_WRITE on
Linux instead of IN_MODIFY to prevent races and unexpected failures.

Pooling approach avoids such problems by either running reload code at a
different time than actual renewal or retrying later if parse fails.
With certificates being renewed before expiry (e.g. 1 week before) delay
is not a signficiant problem.

Closes #160.
2020-01-02 19:12:10 +03:00
fox.cpp
a88a1a96b5
docs: Mention MTA-STS in the Setting up tutorial
DANE is complex and requires its own (potentially lengthy) tutorial on
how to configure it properly. MTA-STS, on the other hand, is designed to
be simple to deploy so recommend to configure it in the Setting up
tutorial.
2020-01-02 19:12:10 +03:00
fox.cpp
d886ddd297
docs: Move the project documentation from GitHub Wiki
Having it in the same directory as the source code makes it simplier to
keep in sync with the source code itself.
2019-12-06 22:56:47 +03:00