This is an eGeoffrey service package.
Retrieve weather information from weatherchannel.
To install this package, run the following command from within your eGeoffrey installation directory:
egeoffrey-cli install egeoffrey-service-weatherchannel
After the installation, remember to run also egeoffrey-cli start to ensure the Docker image of the package is effectively downloaded and started.
To validate the installation, go and visit the 'eGeoffrey Admin' / 'Packages' page of your eGeoffrey instance. All the modules, default configuration files and out-of-the-box contents if any will be automatically deployed and made available.
The following modules are included in this package.
For each module, if requiring a configuration file to start, its settings will be listed under 'Module configuration'. Additionally, if the module is a service, the configuration expected to be provided by each registered sensor associated to the service is listed under 'Service configuration'.
To configure each module included in this package, once started, click on the 'Edit Configuration' button on the 'eGeoffrey Admin' / 'Modules' page of your eGeoffrey instance.
- service/weatherchannel: retrieve weather information from weatherchannel
- Module configuration:
- api_key*: your WeatherChannel API key
- Service configuration:
- Mode 'pull':
- request*: what to request
- latitude*: the latitude of the location (e.g. 12.33)
- longitude*: the longitude of the location (e.g. 70.11)
- Mode 'pull':
- Module configuration:
If you are the author of this package, simply clone the repository, apply any change you would need and run the following command from within this package's directory to commit your changes and automatically push them to Github:
egeoffrey-cli commit "<comment>"
After taking this action, remember you still need to build (see below) the package (e.g. the Docker image) to make it available for installation.
If you are a user willing to contribute to somebody's else package, submit your PR (Pull Request); the author will take care of validating your contributation, merging the new content and building a new version.
Building is required only if you are the author of the package. To build a Docker image and automatically push it to Docker Hub, run the following command from within this package's directory:
egeoffrey-cli build egeoffrey-service-weatherchannel
To uninstall this package, run the following command from within your eGeoffrey installation directory:
egeoffrey-cli uninstall egeoffrey-service-weatherchannel
Remember to run also egeoffrey-cli start to ensure the changes are correctly applied.
The following tags are associated to this package:
service weather alert
The version of this egeoffrey-service-weatherchannel is 1.1-1 on the master branch.