GitHub - geopython/GeoHealthCheck: Service Status and QoS Checker for OGC Web Services · GitHub
Skip to content

geopython/GeoHealthCheck

Repository files navigation

CI Build Docker Build Full Documentation Gitter

GeoHealthCheck

GeoHealthCheck (GHC) is a Service Status and QoS 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 like Apple MacOS and Linux.

virtualenv GeoHealthCheck && cd $_
. bin/activate
git clone https://github.com/geopython/GeoHealthCheck.git
cd GeoHealthCheck
pip3 install Invoke
# setup installation
invoke setup
# generate secret key
invoke create-secret-key
# setup local configuration (overrides GeoHealthCheck/config_main.py)
vi instance/config_site.py
# edit at least secret key:
# - SECRET_KEY  # copy/paste result string from `invoke create-secret-key`

# Optional: edit other settings or leave defaults
# - SQLALCHEMY_DATABASE_URI
# - GHC_RETENTION_DAYS
# - GHC_SELF_REGISTER
# - GHC_RUNNER_IN_WEBAPP
# - GHC_ADMIN_EMAIL
# - GHC_SITE_TITLE
# - GHC_MAP (or use default settings)

# setup database and superuser account interactively 
invoke create

# start webserver with healthcheck runner daemon inside 
# (default is 0.0.0.0:8000)
python3 GeoHealthCheck/app.py  
# or start webserver on another port
python3 GeoHealthCheck/app.py 0.0.0.0:8881
# or start webserver on another IP
python3 GeoHealthCheck/app.py 192.168.0.105:8001

# OR start webserver and separate runner daemon (scheduler) process
vi instance/config_site.py
# GHC_RUNNER_IN_WEBAPP = False
python3 GeoHealthCheck/scheduler.py & 
python3 GeoHealthCheck/app.py  

# next: use a real webserver or preferably Docker for production

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

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

More in the full GHC documentation.

About

Service Status and QoS Checker for OGC Web Services

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages

Contributors