Wez Furlong
14bfa1be78
docs: format generate-toc.py
2024-02-06 13:49:12 -07:00
Mike Hillyer
1f9e8e51d2
Added a couple of FAQ entries on migrations.
2024-01-24 16:58:33 -05:00
Mike Hillyer
e22f256ee3
Couple more FAQ entries.
2024-01-24 16:48:48 -05:00
Mike Hillyer
5b8768bae5
Adding three more FAQ entries.
2024-01-24 15:39:19 -05:00
Mike Hillyer
c19712f040
Typo in gen doc.
2024-01-22 14:04:01 -05:00
Mike Hillyer
b2978deba2
Add an index page to the FAQ.
2024-01-22 14:00:59 -05:00
Mike Hillyer
1eeb53f629
Typo fix, new entry for non-relay-hosts.
2024-01-22 13:40:23 -05:00
Mike Hillyer
9994961fc9
Add FAQ regarding POP3/IMAP.
2024-01-22 13:22:57 -05:00
Mike Hillyer
596c96cdc7
Adding Multiple DKIM signatures and TLS testing to FAQ.
2024-01-22 13:13:32 -05:00
Mike Hillyer
dab1d03d1e
Add first FAQ entry to index.
2024-01-22 10:16:05 -05:00
Mike Hillyer
107eccafc1
Adding FAQ to the documentation tree and first FAQ entry for Permission Denied.
2024-01-22 10:03:51 -05:00
Mike Hillyer
72492df381
Create new master metadata index page, update existing metadata pages to reflect the change.
2024-01-05 13:54:12 -05:00
Wez Furlong
91f56f99d9
docs: fix some build and syntax errors
2023-12-08 11:56:36 -07:00
Mike Hillyer
95c3e3b444
Build out new page on inbound SMTP AUTH, update related documents and TOC, rename smtpauth page outbound_auth to differentiate from inbound_auth.md. Update smtp listener page to point to it, update refman auth plain page to reflect latest fields.
2023-12-07 17:00:58 -05:00
Wez Furlong
acaa095b45
docs: format
2023-11-23 08:36:40 -07:00
Mike Hillyer
1d8969e4a9
Update TOC with get help changes.
2023-11-23 10:13:51 -05:00
Wez Furlong
0b87c020b4
add openapi.json metadata for http api
...
Adds `/api-docs/openapi.json` and `/rapidoc` endpoints to both
kumod and tsa-daemon.
The former exposes the subset of the API that is expressable
in the openapi schema as a json file that can be imported into
other tools.
The latter is a single-page web app that consumes the former
to provide an interactive API explorer.
We're using rapidoc for this, because I happen to think it looks
nicest and easiest to use, and we can integrate it into the docs
fairly nicely.
Which leads in nicely to say: I've integrated a read-only version
of rapidoc into the docs, and it even detects and adjusts to the
selected light/dark mode.
The `docs/update-openapi.sh` extracts the openapi.json data from
kumod and tsa-daemon and outputs to the correct place in the docs
directory structure to enable this.
refs: https://github.com/KumoCorp/kumomta/issues/96
2023-11-21 15:30:13 -07:00
Mike Hillyer
2ebf49d23b
Re-organize TOC to move some operations pages to Policy section where they fit better. Removed page on tenant mapping now that we have the queues helper.
2023-11-21 16:48:41 -05:00
Mike Hillyer
667b3265ad
Adding documentation page on Policy Helpers
2023-11-21 16:27:43 -05:00
Mike Hillyer
eead8d568f
Split out the install/config/start sections of the tutorial.
2023-11-16 17:12:02 -05:00
Wez Furlong
8942ef7f86
Add regex_set_map type
...
This is useful for efficiently matching a string simultaneously against
multiple regular expressions.
The motivating use case is to use it together with the
smtp_client_rewrite_delivery_status event.
2023-11-01 12:52:39 -07:00
Wez Furlong
bec4bc1445
generate-toc.py: format
2023-10-24 11:19:55 -07:00
Mike Hillyer
13fb1b5f0c
Typo
2023-10-19 22:33:51 -04:00
Mike Hillyer
d433bea3f1
Add troubleshooting page, add cross-reference from Tutorial, remove orphaned integration pages from Tutorial directory.
2023-10-19 22:22:33 -04:00
Tom Mairs
5909da616a
update TOS
2023-10-18 22:29:33 +00:00
Tom Mairs
2e453b8714
fix typo in yaml file
2023-10-18 22:26:38 +00:00
Wez Furlong
44b14f4087
docs: format generate-toc.py
2023-10-18 06:32:11 -07:00
Tom Mairs
b1b2ae0c4a
fix numbering
2023-10-17 19:37:19 +00:00
Tom Mairs
d2614fd274
Update TOC
2023-10-17 19:27:41 +00:00
Wez Furlong
7fd1b75f55
docs: format generate-toc.py
2023-10-04 10:52:10 -07:00
Mike Hillyer
4253485a9e
Typo fix.
2023-09-28 17:46:45 -04:00
Mike Hillyer
233966ab67
Add next steps heading to the tutorial, update hashicorp vault page to better match userguide tone.
2023-09-28 17:16:52 -04:00
Mike Hillyer
03b0d12b56
Finish initial edits of tutorial, move hasicorp content to user guide policy section, merge performance content into performance page in userguide operations section, pull lua page and add to userguide general section. Pull how it works, redundant to config concepts in user guide.
2023-09-28 16:56:23 -04:00
Mike Hillyer
bffdec5ed1
Update the install, test, and logs pages of the tutorial.
2023-09-28 14:05:26 -04:00
Mike Hillyer
0d6993bcf2
Update more of the tutorial for formatting, wording, and information.
2023-09-28 12:05:54 -04:00
Mike Hillyer
50124576e3
Renaming the initial tutorial page.
2023-09-27 17:45:52 -04:00
Wez Furlong
3b10d637f9
docs: show how to use dkim verification
...
refs: https://github.com/KumoCorp/kumomta/issues/82
2023-09-14 13:03:41 -07:00
Wez Furlong
cb1f64fe9d
docs: add internal rust API docs to reference section
2023-09-14 10:18:22 -07:00
Wez Furlong
55770052a5
add kumo.encode module
...
This provides a variety of encode/decode functions for things
like base64 and base32 encoding
2023-08-12 08:42:44 -07:00
Wez Furlong
d8a6bceef0
add kumo.digest lua module
...
Compute hashes
2023-08-11 21:44:40 -07:00
Wez Furlong
8205682202
docs: fix typo in toc
2023-08-11 06:47:46 -07:00
Wez Furlong
7d450fdb41
add kumo.cidr module and kumo.cidr.make_map
2023-08-10 17:21:20 -07:00
Mike Hillyer
fece8edb28
Initial version of TSA documentation.
2023-08-08 14:44:53 -04:00
Tom Mairs
3ced8144b7
add flow description page
2023-08-04 20:47:13 +00:00
Wez Furlong
b08c865bdb
docs: include new tsa related info to the reference section
2023-08-04 11:05:08 -07:00
Cloud User
c9a3a7a81c
updates to using vault
2023-08-03 19:05:50 +00:00
Wez Furlong
f65e985e64
docs: add since macro. document connection metadata object
2023-06-28 13:52:15 -07:00
Mike Hillyer
b4fe119fdc
Automated doc formatting fix
2023-06-22 18:23:39 +00:00
Mike Hillyer
02ac065ae5
Update TOC
2023-06-22 14:16:04 -04:00
Wez Furlong
ce7dece927
move domains out of listener, replace with get_listener_domain event
...
This commit also includes a policy helper
`policy_extras.listener_domains` to make it convenient to define
listener domains in toml and/or json files.
To facilitate this, the DomainMap rust structure has been exposed
to lua code via the new `kumo.domain_map.new` function.
2023-05-31 12:29:44 -07:00
Wez Furlong
Mike Hillyer
Tom Mairs
Tom Mairs
Cloud User