This is an eGeoffrey gateway package.
Runs the eGeoffrey Gateway through which all the modules can exchange information.
To install this package, run the following command from within your eGeoffrey installation directory:
egeoffrey-cli install egeoffrey-gateway
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.
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-gateway
To function properly, when running in a Docker container, the following additional configuration settings has to be added to e.g. your docker-compose.yml file (when installing through egeoffrey-cli, this is not needed since done automatically upon installation):
ports:
- 443:443
- 1883:1883
- 8883:8883
volumes:
- ./data/gateway/data:/mosquitto/data
- ./data/gateway/logs:/mosquitto/logs
To uninstall this package, run the following command from within your eGeoffrey installation directory:
egeoffrey-cli uninstall egeoffrey-gateway
Remember to run also egeoffrey-cli start to ensure the changes are correctly applied.
The following tags are associated to this package:
gateway
The version of this egeoffrey-gateway is 1.2-2 on the master branch.