Service Status and QoS Checker for OGC Web Services
Python HTML Shell Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
GeoHealthCheck
docker
docs
tests
.flake8
.gitignore
.travis.yml
Dockerfile
LICENSE
README.md
VERSION
babel.cfg
jobs.cron
pavement.py
requirements-dev.txt
requirements.txt

README.md

Build Status Join the chat at https://gitter.im/geopython/GeoHealthCheck Docker Build Full Documentation

GeoHealthCheck

GeoHealthCheck (GHC) is a Service Status Checker for OGC Web Services and web APIs in general. See also the full GHC documentation.

Easiest is to run GHC using Docker. Below a quick overview of a manual install on Unix-based systems.

virtualenv GeoHealthCheck && cd $_
. bin/activate
git clone https://github.com/geopython/GeoHealthCheck.git
cd GeoHealthCheck
pip install Paver
# setup installation
paver setup
# generate secret key
paver create_secret_key
# setup local configuration
vi instance/config_site.py
# edit:
# - SQLALCHEMY_DATABASE_URI
# - SECRET_KEY  # from paver create_secret_key
# - GHC_RETENTION_DAYS
# - GHC_RUN_FREQUENCY
# - GHC_SELF_REGISTER
# - GHC_ADMIN_EMAIL
# - GHC_SITE_TITLE
# - GHC_MAP (or use default settings)

# setup database and superuser account
paver create

# setup cronjobs
vi jobs.cron
# edit paths to scripts
# enable cron
crontab jobs.cron

# start server (default is 0.0.0.0:8000)
python GeoHealthCheck/app.py  
# start server on another port
python GeoHealthCheck/app.py 0.0.0.0:8881
# start server on another IP
python GeoHealthCheck/app.py 192.168.0.105:8001

# other commands
#
# drop database
python GeoHealthCheck/models.py drop

# load data in database (WARN: deletes existing data!)
# See example data .json files in tests/data
python GeoHealthCheck/models.py load <.json data file> [y/n]

users

  • view all services
  • view service

admin

  • drop db
  • create db
  • upgrade db
  • add service
  • delete service
  • run health check (cron or interactive)