config_main.py

# =================================================================
#
# Authors: Tom Kralidis <tomkralidis@gmail.com>
#
# Copyright (c) 2014 Tom Kralidis
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# =================================================================

DEBUG = False
SQLALCHEMY_ECHO = False
SQLALCHEMY_TRACK_MODIFICATIONS = False
SQLALCHEMY_ENGINE_OPTION_PRE_PING = False
SQLALCHEMY_DATABASE_URI = 'sqlite:///data.db'
# Alternative configuration for PostgreSQL database
# SQLALCHEMY_DATABASE_URI = 'postgresql://user:password@host:port/database'

# Replace None with 'your secret key string' in quotes
SECRET_KEY = None

GHC_RETENTION_DAYS = 30
GHC_PROBE_HTTP_TIMEOUT_SECS = 30
GHC_MINIMAL_RUN_FREQUENCY_MINS = 10
GHC_SELF_REGISTER = False
GHC_NOTIFICATIONS = False
GHC_NOTIFICATIONS_VERBOSITY = True
GHC_WWW_LINK_EXCEPTION_CHECK = False
GHC_LARGE_XML = False
GHC_ADMIN_EMAIL = 'you@example.com'
GHC_NOTIFICATIONS_EMAIL = ['you2@example.com']
GHC_SITE_TITLE = 'GeoHealthCheck Demonstration'
GHC_SITE_URL = 'http://host'
GHC_RUNNER_IN_WEBAPP = True
GHC_REQUIRE_WEBAPP_AUTH = False
GHC_BASIC_AUTH_DISABLED = False
GHC_VERIFY_SSL = True
# 10=DEBUG 20=INFO 30=WARN(ING) 40=ERROR 50=FATAL/CRITICAL
GHC_LOG_LEVEL = 30
GHC_LOG_FORMAT = '%(asctime)s - %(name)s - %(levelname)s - %(message)s'

# Some GetCaps docs are huge. This allows
# caching them for N seconds. Set to -1 to
# disable caching.
GHC_METADATA_CACHE_SECS = 900

GHC_SMTP = {
    'server': None,
    'port': None,
    'tls': False,
    'ssl': False,
    'username': None,
    'password': None
}

GHC_RELIABILITY_MATRIX = {
    'red': {
        'min': 0,
        'max': 49
    },
    'orange': {
        'min': 50,
        'max': 79
    },
    'green': {
        'min': 80,
        'max': 100
    }
}

GHC_MAP = {
    'url': 'https://tile.osm.org/{z}/{x}/{y}.png',
    'centre_lat': 42.3626,
    'centre_long': -71.0843,
    'maxzoom': 18,
    'subdomains': 1234,
}

# GHC Core Plugins
# Each GHC Plugin should derive from GeoHealthCheck.plugin.Plugin,
# and should be findable in sys/PYTHONPATH.
# An entry may be a Python classname or module.
# The latter will include all classes derived from GeoHealthCheck.plugin.Plugin
# in the module file.
GHC_PLUGINS = [
    # Probes
    'GeoHealthCheck.plugins.probe.owsgetcaps',
    'GeoHealthCheck.plugins.probe.wcs',
    'GeoHealthCheck.plugins.probe.wms',
    'GeoHealthCheck.plugins.probe.wmts',
    'GeoHealthCheck.plugins.probe.wfs',
    'GeoHealthCheck.plugins.probe.tms',
    'GeoHealthCheck.plugins.probe.http',
    'GeoHealthCheck.plugins.probe.sta',
    'GeoHealthCheck.plugins.probe.wmsdrilldown',
    'GeoHealthCheck.plugins.probe.ogcfeat',
    'GeoHealthCheck.plugins.probe.ogc3dtiles',
    'GeoHealthCheck.plugins.probe.esrifs',
    'GeoHealthCheck.plugins.probe.esrims',
    'GeoHealthCheck.plugins.probe.oracle',
    'GeoHealthCheck.plugins.probe.postgres',
    'GeoHealthCheck.plugins.probe.ghcreport',
    'GeoHealthCheck.plugins.probe.mapbox',

    # Checkers
    'GeoHealthCheck.plugins.check.checks',

    # Resource Auth Plugins
    'GeoHealthCheck.plugins.resourceauth.resourceauths',
]

# Entry for User Plugins: will be added to default core GHC_PLUGINS
# This makes it easier for users to just configure their Plugins
# and always get the latest core GHC_PLUGINS without having to upgrade
# their config.
GHC_USER_PLUGINS = []

# Default Probe to assign on "add" per Resource-type
GHC_PROBE_DEFAULTS = {
    'OGC:WMS': {
        'probe_class': 'GeoHealthCheck.plugins.probe.owsgetcaps.WmsGetCaps'
    },
    'OGC:WMTS': {
        'probe_class': 'GeoHealthCheck.plugins.probe.owsgetcaps.WmtsGetCaps'
    },
    'OSGeo:TMS': {
        'probe_class': 'GeoHealthCheck.plugins.probe.tms.TmsCaps'
    },
    'OGC:WFS': {
        'probe_class': 'GeoHealthCheck.plugins.probe.owsgetcaps.WfsGetCaps'
    },
    'OGC:WCS': {
        'probe_class': 'GeoHealthCheck.plugins.probe.owsgetcaps.WcsGetCaps'
    },
    'OGC:WPS': {
        'probe_class': 'GeoHealthCheck.plugins.probe.owsgetcaps.WpsGetCaps'
    },
    'OGC:CSW': {
        'probe_class': 'GeoHealthCheck.plugins.probe.owsgetcaps.CswGetCaps'
    },
    'OGC:SOS': {
        'probe_class': 'GeoHealthCheck.plugins.probe.owsgetcaps.SosGetCaps'
    },
    'OGC:STA': {
        'probe_class': 'GeoHealthCheck.plugins.probe.sta.StaCaps'
    },
    'OGCFeat': {
        'probe_class': 'GeoHealthCheck.plugins.probe.ogcfeat.OGCFeatCaps'
    },
    'OGC:3DTiles': {
        'probe_class': 'GeoHealthCheck.plugins.probe.ogc3dtiles.OGC3DTiles'
    },
    'ORACLE': {
        'probe_class': 'GeoHealthCheck.plugins.probe.oracle.OracleDrilldown'
    },
    'POSTGRES': {
        'probe_class': 'GeoHealthCheck.plugins.probe.postgres.PostgresDrilldown'
    },
    'ESRI:FS': {
        'probe_class': 'GeoHealthCheck.plugins.probe.esrifs.ESRIFSDrilldown'
    },
    'ESRI:MS': {
        'probe_class': 'GeoHealthCheck.plugins.probe.esrims.ESRIMSDrilldown'
    },
    'Mapbox:TileJSON': {
        'probe_class': 'GeoHealthCheck.plugins.probe.mapbox.TileJSON'
    },
    'urn:geoss:waf': {
        'probe_class': 'GeoHealthCheck.plugins.probe.http.HttpGet'
    },
    'WWW:LINK': {
        'probe_class': 'GeoHealthCheck.plugins.probe.http.HttpGet'
    },
    'FTP': {
        'probe_class': None
    },
    'OSGeo:GeoNode': {
        'probe_class': None
    },
    'GHC:Report': {
        'probe_class':
            'GeoHealthCheck.plugins.probe.ghcreport.GHCEmailReporter'
    },
}

# Entry for Geocoder plugin
# Use this service to locate the configured servers on a map. In case you want
# to use fixed location (i.e. no geolocator service), use the `FixedLocation`:
# GEOIP = {
#     'plugin': 'GeoHealthCheck.plugins.geocode.fixedlocation.FixedLocation',
#     'parameters': {
#         'lat': 50,
#         'lon': 5
#     }
# }
GEOIP = {
    'plugin': 'GeoHealthCheck.plugins.geocode.webgeocoder.HttpGetGeocoder',
    'parameters': {
        'geocoder_url': 'http://ip-api.com/json/{hostname}',
        'lat_field': 'lat',
        'lon_field': 'lon'
    }
}