diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 29 insertions, 1 deletions
diff --git a/README.md b/README.md index 9c6fa29..3c0b0fe 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,28 @@ Scadere is a TLS certificate renewal reminder. It checks for certificates that are about to expire and provides an Atom feed for notification. +## Installation + +The recommended installtion method is through your distribution. +Installing from source should only be considered as a last resort; +if you are capable of doing so, please also package scadere +for your distribution. + +Scadere requires Python 3.11 or above, and uses [flit] +as the PEP 517 build backend. Installation can be done +with `flit install` or `pip install .`. + +With `scadere-check` and `scadere-listen` under `$prefix/bin`, +the manual pages can be built and installed using `make(1p)`, +GNU [help2man] and `install(1)`: + + cd doc + make PREFIX=$prefix + make install PREFIX=$prefix + +(FYI, GNU make has an extension that allows specifying `--directory=doc`, +which can save you from having to change the directory.) + ## Usage ### Expiration checking @@ -21,7 +43,8 @@ Options: output file (default to stdout) ``` -It is recommended to run `scadere-check` as a cron job. +It is recommended to schedule `scadere-check` chronically. +See `contrib/scadere-check.*` for an example systemd timer configuration. ### Expiration notification @@ -47,6 +70,9 @@ Options: title of Atom feeds ``` +A sample `scadere-listen.service` for systemd +is also availble under the `contrib` directory. + ## Hacking Unit testing is done with [pytest], [pytest-asyncio], @@ -82,6 +108,8 @@ Scadere is free software: you can redistribute and/or modify it under the terms of the GNU [Affero General Public License][agpl] version 3 or later. +[flit]: https://flit.pypa.io +[help2man]: https://www.gnu.org/software/help2man [pytest]: https://docs.pytest.org [pytest-asyncio]: https://pytest-asyncio.rtfd.io [Hypothesis]: https://hypothesis.rtfd.io |