Commit 7c55647e authored by Bram Daams's avatar Bram Daams
Browse files

Resolve "fix the README"

parent d370ab48
......@@ -6,20 +6,34 @@ A cron shell wrapper for registering and updating cron jobs automatically in
## Installation
Install the `sch` shell and it's dependencies by running pip in the cloned
repository:
Install sch system wide with pip
``` console
$ pip install sch
$ sudo pip3 install sch
```
Create a configuration file:
A `sch` cli should now be availble:
``` console
sudo cp sch.conf.example /etc/sch.conf
$ which sch
/usr/local/bin/sch
```
`sch --version` should return something like:
``` console
sch, version 0.2.1
```
## Configuration
Create a configuration file `/etc/sch.conf` that looks like:
``` ini
[hc]
healthchecks_api_url = https://hc.example.com/api/v1/
healthchecks_api_key = xxmysecretkeyxx
```
And fill in the API URL and the key obtained from the Healthchecks project
settings block labeled "API Access".
### Monitoring cron jobs
## Monitoring cron jobs
Just decorate your existing cron tabs by specifying the alternative `sch`:
```
SHELL=/usr/local/bin/sch
......@@ -154,4 +168,4 @@ like this:
```
Afterwards, `hostname --fqdn` should return the FQDN. Beware that `sch` will
create new checks when the FQDN changes.
\ No newline at end of file
create new checks when the FQDN changes.
......@@ -2,4 +2,4 @@
__author__ = """Bram Daams"""
__email__ = 'b.daams@science.ru.nl'
__version__ = '0.2.1'
__version__ = '0.2.2'
[bumpversion]
current_version = 0.2.1
current_version = 0.2.2
commit = True
tag = True
......
......@@ -59,6 +59,6 @@ setup(
test_suite='tests',
tests_require=test_requirements,
url='https://gitlab.science.ru.nl/bram/sch',
version='0.2.1',
version='0.2.2',
zip_safe=False,
)
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