
                   ____   ___   ___                _       _
             __  _| ___| / _ \ / _ \__      ____ _| |_ ___| |__
             \ \/ /___ \| | | | (_) \ \ /\ / / _` | __/ __| '_ \
              >  < ___) | |_| |\__, |\ V  V / (_| | || (__| | | |
             /_/\_\____/ \___/   /_/  \_/\_/ \__,_|\__\___|_| |_|






Content
-------

1.0 What is x509watch?
2.0 Requirements
3.0 Installation and configuration
4.0 License and copyright
5.0 Bugs and reporting
6.0 Contact


1.0 What is x509watch?
----------------------

x509watch is a simple command line application, written in Perl, that can be
used to list soon expiring or already expired X.509 certificates, such as e.g.
SSL certificates. All certificates are searched by default in the standard PKI
directory, but any other directory can be specified as parameter. Only Base64
encoded DER and PEM X.509 certificates are supported.


2.0 Requirements
----------------

- perl >= 5.6.0
  - perl >= 5.8.0 is recommented to avoid possible problems
  - perl modules Getopt::Long, File::Find, Fcntl, IPC::Open3, POSIX and Config
- openssl >= 0.9.5
  - openssl >= 1.0.1e (current latest stable release) is recommented
- vixie-cron >= 3.0.1 (optional, if cron jobs are desired)
  - cronie >= 1.4.11 (current latest stable release) is recommented
- systemd >= 197 (optional, if systemd timers are desired)
  - systemd >= 219 (current latest stable release) is recommented


3.0 Installation and configuration
----------------------------------

Extract the x509watch-X.Y.Z.tar.gz using "tar xvfz <file>" or "gzip -d <file>
&& tar xvf <file>" for example. "X.Y.Z" simply stands for the current version
number of x509watch.

After that, change into the directory and type "make install" for installing.

To enable systemd timers (usually disabled by default) it might require then
running "systemctl enable x509watch.timer && systemctl start x509watch.timer".


4.0 License and copyright
-------------------------

x509watch is licensed under GNU General Public License, the complete license
can be read at: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html


5.0 Bugs and reporting
----------------------

For a bug report, a feature request, problems or suggestions, please send an
e-mail (written in German or English language) to: x509watch@robert-scheck.de


6.0 Contact
-----------

Name     : Robert Scheck
E-Mail   : x509watch@robert-scheck.de
GnuPG-Key: https://www.robert-scheck.de/kontakt/gpg/rsc.gpg
IRC chat : irc.linuxnetz.de, #robert-scheck
