Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Bram Daams
sch
Commits
7c55647e
Commit
7c55647e
authored
Apr 02, 2020
by
Bram Daams
Browse files
Resolve "fix the README"
parent
d370ab48
Changes
4
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
7c55647e
...
...
@@ -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
pip
3
install
sch
```
Create a configuration fi
le:
A
`sch`
cli should now be availb
le:
```
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.
sch/__init__.py
View file @
7c55647e
...
...
@@ -2,4 +2,4 @@
__author__
=
"""Bram Daams"""
__email__
=
'b.daams@science.ru.nl'
__version__
=
'0.2.
1
'
__version__
=
'0.2.
2
'
setup.cfg
View file @
7c55647e
[bumpversion]
current_version = 0.2.
1
current_version = 0.2.
2
commit = True
tag = True
...
...
setup.py
View file @
7c55647e
...
...
@@ -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
,
)
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment