Commit Graph
1561 Commits
Author SHA1 Message Date
Wez Furlong dfc635dada docs: fix broken link 2023-11-28 10:40:44 -07:00
Mike Hillyer 5d40c6a469 Update README.md 2023-11-28 10:58:40 -05:00
Mike Hillyer 545536f1ca Update README.md 2023-11-28 09:39:49 -05:00
Mike Hillyer 83c14e0674 Fixing one more. 2023-11-27 11:49:01 -05:00
Mike Hillyer 6339869f4a Lua preformatted block on one of the entries was causing the following entries to not register as separate bullets because of missing linebreak. 2023-11-27 11:37:51 -05:00
Mike Hillyer 3c7aa802c8 update troubleshooting and get help pages 2023-11-26 09:22:07 -05:00
Wez Furlong 837f9e5c0e automate updating the openapi spec files
I definitely forgot to do this on the very first change after
adding them, so I want to make it less likely in the future.

This causes the specs to get updated in the docs if they have
changed (other than the version field) since the last time they
were updated.

We check this during test and doc building.  That should be
sufficient to catch this during my dev loop.

refs: https://github.com/KumoCorp/kumomta/issues/96
2023-11-23 09:02:00 -07:00
Wez Furlong acaa095b45 docs: format 2023-11-23 08:36:40 -07:00
Wez Furlong c40f86e039 Add suppress-logging option to admin bounces
closes: https://github.com/KumoCorp/kumomta/issues/75
2023-11-23 08:36:07 -07:00
Mike Hillyer 1d8969e4a9 Update TOC with get help changes. 2023-11-23 10:13:51 -05:00
Mike Hillyer 90149c7309 Split out the get help page. 2023-11-23 10:11:51 -05:00
Wez Furlong c814b960f1 deps: libunbound to 1.19.0 2023-11-22 17:53:44 -07:00
Wez Furlong 9282110479 docs: update openapi snapshots
Meant to include this in the previous commit!

refs: https://github.com/KumoCorp/kumomta/issues/96
2023-11-22 12:54:17 -07:00
Wez Furlong 0fc1108308 openapi: tidy up server URL and auth bits for rapidoc
refs: https://github.com/KumoCorp/kumomta/issues/96
2023-11-22 12:51:10 -07: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
Wez Furlong 8b8f53129f docs: changelog for the dkim h= wrapping fix 2023-11-18 12:07:35 -07:00
Wez Furlong f979bdc6b0 explicitly wrap dkim h value on colons
My reading of the spec says that we can swap `:` for `:FWS` when
wrapping, so let's try that.

Previously, we'd wrap on the hyphens in header names and that
seems to cause some problems for some verifiers.
2023-11-17 11:30:57 -07:00
Mike Hillyer eead8d568f Split out the install/config/start sections of the tutorial. 2023-11-16 17:12:02 -05:00
Mike Hillyer 10b1a1b2b4 Add Youtube content to Config concepts page 2023-11-15 16:42:44 -05:00
Tom Mairs 5808ed4f46 reword trace-smtp-server title 2023-11-15 20:04:11 +00:00
Tom Mairs d4258cd0a2 reword trace-smtp-server title 2023-11-15 17:01:25 +00:00
Tom Mairs 16051af60f add trace-smtp-server to kcls functions 2023-11-15 16:53:25 +00:00
Mike Hillyer b4a149a5f3 Add samples for webhooks to the example config, update webhooks docs page with helper info. 2023-11-14 18:18:47 -05:00
Wez Furlong fa51666051 add log_hooks:new_json shortcut
Basic usage is as simple as:

```lua
local log_hooks = require 'policy-extras.log_hooks'

log_hooks:new_json {
  name = "webhook",
  url = "http://10.0.0.1:4242/log",
}
```
2023-11-14 15:06:48 -07:00
Wez Furlong 4ac3b4e21b log_hooks: set retry_interval to 1m, with max 20m 2023-11-14 14:55:22 -07:00
Wez Furlong f4c6b7e81d cargo update 2023-11-14 14:52:59 -07:00
Mike Hillyer 4d86392add Update example config and page on queue management to reflect the queue helper. 2023-11-14 16:47:54 -05:00
Wez Furlong 10537080f3 docs: changelog for #94 2023-11-13 09:36:46 -07:00
Nathalie Caiandncai 12a317dba3 only add meta to log if not null (#94)
* only add meta to log if not null
* follow norm

Co-authored-by: ncai <ncai@chapsvision.com>
2023-11-13 09:35:10 -07:00
Wez Furlong a03fcb2bf1 docs: fix sqlite auth example 2023-11-10 07:01:58 -07:00
ncai 9d0105e51d use logRecord reception_protocol to avoid loop 2023-11-07 13:11:59 -07:00
Wez Furlong 48d5e26a70 pre_init: fix dispatch
I didn't register this correct for multi-event setup,
so no pre_init event was ever triggered, causing the log_hooks
stuff to not register the log hook.
2023-11-06 20:55:37 -07:00
Wez Furlong d969f87571 multi hooks: use bare return rather than return nil
The way we test whether logs should continue is by looking for
an empty return statement, so we shouldn't `return nil` for these
otherwise we'll indicate that we definitively can't resolve the
queue configuration.
2023-11-06 14:39:37 -07:00
Wez Furlong 0ffbcf7ed0 queue.lua: fix typo 2023-11-06 11:03:06 -07:00
Wez Furlong 68b7979783 queue.lua: allow removing tenant and/or campaign header 2023-11-06 10:59:49 -07:00
Wez Furlong ac7ef32cd3 log_hooks: fix returning the module 2023-11-06 09:50:25 -07:00
Wez Furlong 1c25c0a59b shaping.lua: add extra_files to the TSA inline example 2023-11-06 08:53:34 -07:00
Wez Furlong 951cad53e8 log_hooks: simplify logic and comments a little 2023-11-06 08:46:35 -07:00
Wez Furlong dd93465870 log_hooks: a couple of minor fixes/tweaks 2023-11-06 08:39:31 -07:00
Wez Furlong af92443f7e policy-extras: add log_hooks helper
This should simplify the process of adding log hooks.
2023-11-06 08:31:52 -07:00
Wez Furlong 38179d59c4 docs: fix some broken links 2023-11-06 08:14:11 -07:00
Wez Furlong c1c4ce723e add pre_init event 2023-11-06 08:10:53 -07:00
Wez Furlong 4cb3a4c4e5 cargo update
I had to force-push my dane branch of rust-openssl after a rebase,
which invalidated the commit ref that is included here in Cargo.lock.

Update the deps to allow folks without the stale commit ref to be able
to build.
2023-11-06 06:32:22 -07:00
Wez Furlong 546237d11c deps: trust-dns -> hickory
The project was rebranded relatively recently; switch
to the new version
2023-11-04 10:26:49 -07:00
Wez Furlong e9838cd1a9 new: queue helper
This helps to configure tenant and campaign assignment and scheduled
queue configuration.

refs: https://github.com/KumoCorp/kumomta/issues/90
2023-11-03 13:44:13 -07:00
Wez Furlong 1872dc71a0 shaping: calling shaper.should_enqueue_log_record is no longer required
Allow multiple should_enqueue_log_record hooks to be registered,
and take advantage of that inside the shaping helper.

`shaper.should_enqueue_log_record` no longer needs to be explicitly
plumbed from the config, but we allow calling it still for compatibility
reasons.

We will remove that compatibility after the next stable release.
2023-11-03 08:52:40 -07:00
Wez Furlong 7bb498040b tsa: add some more trace logging
This is helpful when debugging/tracing.
2023-11-03 08:46:36 -07:00
Wez Furlong 3d7007825a shaping: calling shaper.get_queue_config is no longer required
Take advantage of the ability to define multiple get_queue_config
callbacks by internalizing the TSA webhook queue configuration.

`shaper.get_queue_config` no longer needs to be called, and
that fragment of code will continue to "work" by simply not
having an effect so that we don't break folks on upgrade.

We'll remove this compatibility in the release following
the next stable release.
2023-11-02 18:11:17 -07:00