Skip to content

Commit fc3a131

Browse files
seanthegeekseanthegeek
committed
Update docs
1 parent 4098dfe commit fc3a131

35 files changed

+2323
-1762
lines changed

‎_modules/index.html

+11-17
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
1+
2+
13
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en">
4+
<html class="writer-html5" lang="en" data-content_root="../">
35
<head>
46
<meta charset="utf-8" />
57
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>Overview: module code &mdash; parsedmarc 8.15.0 documentation</title>
7-
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
8-
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
8+
<title>Overview: module code &mdash; parsedmarc 8.15.1 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
10+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
911

1012

11-
<!--[if lt IE 9]>
12-
<script src="../_static/js/html5shiv.min.js"></script>
13-
<![endif]-->
14-
15-
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
16-
<script src="../_static/jquery.js"></script>
17-
<script src="../_static/underscore.js"></script>
18-
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
19-
<script src="../_static/doctools.js"></script>
20-
<script src="../_static/sphinx_highlight.js"></script>
13+
<script src="../_static/jquery.js?v=5d32c60e"></script>
14+
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15+
<script src="../_static/documentation_options.js?v=6add7570"></script>
16+
<script src="../_static/doctools.js?v=9bcbadda"></script>
17+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
2118
<script src="../_static/js/theme.js"></script>
2219
<link rel="index" title="Index" href="../genindex.html" />
2320
<link rel="search" title="Search" href="../search.html" />
@@ -34,9 +31,6 @@
3431
<a href="../index.html" class="icon icon-home">
3532
parsedmarc
3633
</a>
37-
<div class="version">
38-
8.15.0
39-
</div>
4034
<div role="search">
4135
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
4236
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />

‎_modules/parsedmarc.html

+632-401
Large diffs are not rendered by default.

‎_modules/parsedmarc/elastic.html

+257-213
Large diffs are not rendered by default.

‎_modules/parsedmarc/opensearch.html

+256-208
Large diffs are not rendered by default.

‎_modules/parsedmarc/splunk.html

+54-59
Large diffs are not rendered by default.

‎_modules/parsedmarc/utils.html

+186-112
Large diffs are not rendered by default.

‎_sources/usage.md.txt

+18
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,12 @@ port = 514
103103
host = logger
104104
port = 12201
105105
mode = tcp
106+
107+
[webhook]
108+
aggregate_url = https://aggregate_url.example.com
109+
forensic_url = https://forensic_url.example.com
110+
smtp_tls_url = https://smtp_tls_url.example.com
111+
timeout = 60
106112
```
107113

108114
The full set of configuration options are:
@@ -130,6 +136,8 @@ The full set of configuration options are:
130136
- `reverse_dns_map_url` - Overrides the default download URL for the reverse DNS map
131137
- `nameservers` - str: A comma separated list of
132138
DNS resolvers (Default: `[Cloudflare's public resolvers]`)
139+
- `dns_test_address` - str: a dummy address used for DNS pre-flight checks
140+
(Default: 1.1.1.1)
133141
- `dns_timeout` - float: DNS timeout period
134142
- `debug` - bool: Print debugging messages
135143
- `silent` - bool: Only print errors (Default: `True`)
@@ -355,6 +363,16 @@ The full set of configuration options are:
355363
- `port` - int: The port to use
356364
- `mode` - str: The GELF transport type to use. Valid modes: `tcp`, `udp`, `tls`
357365

366+
- `maildir`
367+
- `reports_folder` - str: Full path for mailbox maidir location (Default: `INBOX`)
368+
- `maildir_create` - bool: Create maildir if not present (Default: False)
369+
370+
- `webhook` - Post the individual reports to a webhook url with the report as the JSON body
371+
- `aggregate_url` - str: URL of the webhook which should receive the aggregate reports
372+
- `forensic_url` - str: URL of the webhook which should receive the forensic reports
373+
- `smtp_tls_url` - str: URL of the webhook which should receive the smtp_tls reports
374+
- `timeout` - int: Interval in which the webhook call should timeout
375+
358376
:::{warning}
359377
It is **strongly recommended** to **not** use the `nameservers`
360378
setting. By default, `parsedmarc` uses

‎_static/_sphinx_javascript_frameworks_compat.js

+3-14
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,9 @@
1-
/*
2-
* _sphinx_javascript_frameworks_compat.js
3-
* ~~~~~~~~~~
4-
*
5-
* Compatability shim for jQuery and underscores.js.
6-
*
7-
* WILL BE REMOVED IN Sphinx 6.0
8-
* xref RemovedInSphinx60Warning
1+
/* Compatability shim for jQuery and underscores.js.
92
*
3+
* Copyright Sphinx contributors
4+
* Released under the two clause BSD licence
105
*/
116

12-
/**
13-
* select a different prefix for underscore
14-
*/
15-
$u = _.noConflict();
16-
17-
187
/**
198
* small helper function to urldecode strings
209
*

‎_static/basic.css

+49-34
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
/*
2-
* basic.css
3-
* ~~~~~~~~~
4-
*
52
* Sphinx stylesheet -- basic theme.
6-
*
7-
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
8-
* :license: BSD, see LICENSE for details.
9-
*
103
*/
114

125
/* -- main layout ----------------------------------------------------------- */
@@ -115,15 +108,11 @@ img {
115108
/* -- search page ----------------------------------------------------------- */
116109

117110
ul.search {
118-
margin: 10px 0 0 20px;
119-
padding: 0;
111+
margin-top: 10px;
120112
}
121113

122114
ul.search li {
123-
padding: 5px 0 5px 20px;
124-
background-image: url(file.png);
125-
background-repeat: no-repeat;
126-
background-position: 0 7px;
115+
padding: 5px 0;
127116
}
128117

129118
ul.search li a {
@@ -236,17 +225,11 @@ div.body p, div.body dd, div.body li, div.body blockquote {
236225
a.headerlink {
237226
visibility: hidden;
238227
}
239-
a.brackets:before,
240-
span.brackets > a:before{
241-
content: "[";
242-
}
243228

244-
a.brackets:after,
245-
span.brackets > a:after {
246-
content: "]";
229+
a:visited {
230+
color: #551A8B;
247231
}
248232

249-
250233
h1:hover > a.headerlink,
251234
h2:hover > a.headerlink,
252235
h3:hover > a.headerlink,
@@ -334,11 +317,17 @@ aside.sidebar {
334317
p.sidebar-title {
335318
font-weight: bold;
336319
}
320+
321+
nav.contents,
322+
aside.topic,
337323
div.admonition, div.topic, blockquote {
338324
clear: left;
339325
}
340326

341327
/* -- topics ---------------------------------------------------------------- */
328+
329+
nav.contents,
330+
aside.topic,
342331
div.topic {
343332
border: 1px solid #ccc;
344333
padding: 7px;
@@ -377,13 +366,17 @@ div.body p.centered {
377366

378367
div.sidebar > :last-child,
379368
aside.sidebar > :last-child,
369+
nav.contents > :last-child,
370+
aside.topic > :last-child,
380371
div.topic > :last-child,
381372
div.admonition > :last-child {
382373
margin-bottom: 0;
383374
}
384375

385376
div.sidebar::after,
386377
aside.sidebar::after,
378+
nav.contents::after,
379+
aside.topic::after,
387380
div.topic::after,
388381
div.admonition::after,
389382
blockquote::after {
@@ -608,19 +601,27 @@ ol.simple p,
608601
ul.simple p {
609602
margin-bottom: 0;
610603
}
611-
dl.footnote > dt,
612-
dl.citation > dt {
604+
605+
aside.footnote > span,
606+
div.citation > span {
613607
float: left;
614-
margin-right: 0.5em;
615608
}
616-
617-
dl.footnote > dd,
618-
dl.citation > dd {
609+
aside.footnote > span:last-of-type,
610+
div.citation > span:last-of-type {
611+
padding-right: 0.5em;
612+
}
613+
aside.footnote > p {
614+
margin-left: 2em;
615+
}
616+
div.citation > p {
617+
margin-left: 4em;
618+
}
619+
aside.footnote > p:last-of-type,
620+
div.citation > p:last-of-type {
619621
margin-bottom: 0em;
620622
}
621-
622-
dl.footnote > dd:after,
623-
dl.citation > dd:after {
623+
aside.footnote > p:last-of-type:after,
624+
div.citation > p:last-of-type:after {
624625
content: "";
625626
clear: both;
626627
}
@@ -636,10 +637,6 @@ dl.field-list > dt {
636637
padding-left: 0.5em;
637638
padding-right: 5px;
638639
}
639-
dl.field-list > dt:after {
640-
content: ":";
641-
}
642-
643640

644641
dl.field-list > dd {
645642
padding-left: 0.5em;
@@ -666,6 +663,16 @@ dd {
666663
margin-left: 30px;
667664
}
668665

666+
.sig dd {
667+
margin-top: 0px;
668+
margin-bottom: 0px;
669+
}
670+
671+
.sig dl {
672+
margin-top: 0px;
673+
margin-bottom: 0px;
674+
}
675+
669676
dl > dd:last-child,
670677
dl > dd:last-child > :last-child {
671678
margin-bottom: 0;
@@ -734,6 +741,14 @@ abbr, acronym {
734741
cursor: help;
735742
}
736743

744+
.translated {
745+
background-color: rgba(207, 255, 207, 0.2)
746+
}
747+
748+
.untranslated {
749+
background-color: rgba(255, 207, 207, 0.2)
750+
}
751+
737752
/* -- code displays --------------------------------------------------------- */
738753

739754
pre {

‎_static/css/badge_only.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎_static/css/theme.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎_static/doctools.js

-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
/*
2-
* doctools.js
3-
* ~~~~~~~~~~~
4-
*
52
* Base JavaScript utilities for all Sphinx HTML documentation.
6-
*
7-
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
8-
* :license: BSD, see LICENSE for details.
9-
*
103
*/
114
"use strict";
125

‎_static/documentation_options.js

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
var DOCUMENTATION_OPTIONS = {
2-
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '8.15.0',
1+
const DOCUMENTATION_OPTIONS = {
2+
VERSION: '8.15.1',
43
LANGUAGE: 'en',
54
COLLAPSE_INDEX: false,
65
BUILDER: 'html',

0 commit comments

Comments
 (0)