about summary refs log tree commit diff
path: root/README.md
blob: 8f89b5ed2e60343405bf080f4453bdc357fca270 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Scadere

Scadere is a TLS certificate renewal remider.  It checks for certificates
that are about to expire and provides an Atom feed for notification.

## Usage

```console
$ scadere check --help
Usage: scadere check [-h] [-d DAYS] [-o PATH] HOST[:PORT] [HOST[:PORT] ...]

Check TLS certificate expiration of HOST, where PORT defaults to 443.

Options:
  -h, --help            show this help message and exit
  -d DAYS, --days=DAYS  days before expiration (default to 7)
  -o PATH, --output=PATH
                        output file (default to stdout)
```

```console
$ scadere listen --help
Usage: scadere listen [-h] INPUT URL [[HOST][:PORT]]

Serve the TLS certificate expiration feed from INPUT file
for base URL at HOST:PORT, where HOST defaults to localhost
and PORT is selected randomly if not specified.

Options:
  -h, --help  show this help message and exit
```

## Contributing

Patches should be sent to [chung@loa.loang.net][loang mailing list]
using [`git send-email`][git send-email], with the following configuration:

    git config sendemail.to 'chung@loa.loang.net'
    git config format.subjectPrefix 'PATCH scadere'

## Copying

![AGPLv3](https://www.gnu.org/graphics/agplv3-155x51.png)

Scadere is free software: you can redistribute it and/or modify it
under the terms of the GNU [Affero General Public License][agplv3] as
published by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.

[loang mailing list]: https://loa.loang.net/chung
[git send-email]: https://git-send-email.io
[agplv3]: https://www.gnu.org/licenses/agpl-3.0.html