Commit af1754e1 authored by Nogweii's avatar Nogweii
Browse files

make a manpage

parent c867d84d
......@@ -13,3 +13,4 @@ my-certificate-alert
*.out
.env
my-certificate-alert.1
% MY-CERTIFICATE-ALERT(1) Version 1.0
% Nogweii
NAME
====
**my-certificate-alert** — Generate alerts when certain domains get a certificate
SYNOPSIS
========
| **my-certificate-alert**
DESCRIPTION
===========
Connects to [CertStream](https://certstream.calidog.io/) and uses it's
feed to monitor the certificates being issued and logged in Certificate
Transparency logs. If any certificate is logged that has a matching
domain name, send a pushover notification.
ENVIRONMENT
===========
**MCA_DOMAINS_LIST_PATH**
: The file containing a newline separated list of globs. Any domain that
matches these globs generate a notification.
**MCA_PUSHOVER_APP_TOKEN**
: Pushover API token for the application that's generating the notification.
You must build one for yourself, at [Pushover's website](https://pushover.net/apps/build).
**MCA_PUSHOVER_USER_KEY**
: User key for whomever will receive the Pushover notification.
DOMAIN LIST FILE FORMAT
=======================
The path specified in `$MCA_DOMAINS_LIST_PATH` is a plain text file,
separated by newlines. Each line is a single glob pattern. If any
glob pattern matches, a notification will be sent.
The globs are fairly naive, and do not follow the same rules as
certificate matching behavior in TLS libraries. That is, a glob
pattern like `*.example.com` will match sub-sub-domains, like
"foo.bar.baz.example.com".
BUGS
====
See Gitlab: <https://code.aether.earth/nogweii/my-certificate-authority/-/issues>
#!/usr/bin/env bash
set -euo 'pipefail'
parent_git_dir=$(git rev-parse --show-toplevel)
cd "${parent_git_dir}"
pandoc --standalone --to man my-certificate-alert.1.md -o my-certificate-alert.1
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment