Commit Graph
166 Commits
Author SHA1 Message Date
Mike Hillyer 3c446748aa Forgot to add Scaling page to the TOC. 2024-10-03 10:52:25 -04:00
Mike Hillyer a0c4f17bef Inital Publish of Updated Traffic Shaping Section. 2024-09-07 18:25:40 -04:00
Wez Furlong 0c2a41290c docs: format generate-toc.py 2024-08-24 08:17:38 -07:00
Mike Hillyer dab23cde0c Fix change of deployment page. 2024-08-23 15:52:50 -04:00
Mike Hillyer 42ab54d1b3 Initial Clustering Chapter 2024-08-22 18:14:18 -04:00
Wez Furlong bf060ca171 docs: fixup links to implicit Gen child pages 2024-08-18 19:50:16 -07:00
Wez Furlong 4af9c7035f docs: move make_queue_config fields to their own pages
This makes them easier to search for, and find.
2024-08-18 19:14:34 -07:00
Wez Furlong 4369bd8355 docs: document rollup module
closes: https://github.com/KumoCorp/kumomta/issues/213
2024-07-10 10:35:00 -07:00
Wez Furlong c659fe6d4f new: add kumo.uuid lua module 2024-07-09 13:25:32 -07:00
Wez Furlong 5b0d936ef7 docs: improve markdown output for the kcli help 2024-06-27 15:40:39 -07:00
Wez Furlong fa2c6225e8 docs: add kcli reference docs
These are automatically extracted from `kcli --help`.
2024-06-27 15:18:07 -07:00
Wez Furlong e683fed556 docs: move Log Record to its own reference page
This makes it a bit easier to find and link to.
2024-06-27 08:28:45 -07:00
Wez Furlong f8c3429738 serde: move json/toml to new kumo.serde module. Added YAML.
This helps to avoid bloating kumo-server-common, and makes it
easier to group related functions together in the docs.

The original names are still usable; we'll remove them in a
future release.
2024-06-26 11:08:15 -07:00
Wez Furlong 10bb7f2717 Add some string and regex functions
closes: https://github.com/KumoCorp/kumomta/issues/220
2024-06-21 17:20:04 -07:00
Wez Furlong 7fc8dd97e6 docs: discuss creating an always-suspended queue
closes: https://github.com/KumoCorp/kumomta/issues/210
2024-06-20 08:35:17 -07:00
Mike Hillyer f957d812c1 Add the response rewrite page to the TOC. 2024-06-19 16:35:53 -04:00
Wez Furlong 015fad5e4f Revert "Add page on rewriting remote server responses to the User Guide."
This reverts commit 82a258a92e0e0eef6c7e483ab25f71146cdfeea3; that new
page is incomplete and has invalid syntax.

Let's take it out for now to unblock the doc build.
2024-06-19 08:37:11 -07:00
Mike Hillyer 82a258a92e Add page on rewriting remote server responses to the User Guide. 2024-06-19 10:13:40 -04:00
Wez Furlong 3207c45f3d expose inject_v1 API via lua
closes: https://github.com/KumoCorp/kumomta/issues/102
2024-03-29 09:06:54 -07:00
Wez Furlong 5063a4671b docs: format generate-toc.py 2024-03-17 07:24:34 -07:00
Tom Mairs c48f7f6183 Add sbin utilities 2024-03-15 12:42:59 -06:00
Wez Furlong 949f0a6625 code formatting 2024-02-24 09:18:23 -07:00
Mike Hillyer 1a1042c12f Fix the error. 2024-02-13 14:22:11 -05:00
Mike Hillyer c62ee2f8e2 First pass Kafka Docs 2024-02-13 13:47:08 -05:00
Wez Furlong 4bc099821b docs: fix broken faq links 2024-02-08 08:12:29 -07:00
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