From 88fe39e7e7ddda983034a934e554bf54802131ba Mon Sep 17 00:00:00 2001 From: Tom Kralidis Date: Thu, 19 Oct 2023 18:21:42 -0400 Subject: [PATCH] various doc updates --- docs/source/user/public-services-setup.rst | 38 +++++++++++----------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/source/user/public-services-setup.rst b/docs/source/user/public-services-setup.rst index a31d7224e..019455c7a 100644 --- a/docs/source/user/public-services-setup.rst +++ b/docs/source/user/public-services-setup.rst @@ -3,19 +3,19 @@ Public services setup ===================== -To share your data with the WIS2 network, you need to expose some of your wis2box services to the Global Services: +To share your data with the WIS2 network, you need to expose some of the wis2box services to the Global Services: -* The Global Cache needs to be able to access to your HTTP endpoint at port 80 to download data published by your wis2box instance -* The Global Broker needs to be able to subscribe to your MQTT endpoint at port 1883 to receive WIS2 notifications published by your wis2box instance +* The Global Cache needs to be able to access to your HTTP endpoint at port 80 to download data published by the wis2box instance +* The Global Broker needs to be able to subscribe to your MQTT endpoint at port 1883 to receive WIS2 notifications published by the wis2box instance SSL ^^^ -It is recommended to use a reverse proxy to route HTTP and MQTT traffic from/to your wis2box, and to enable TLS (HTTPS/MQTTS) on your wis2box. +It is recommended to use a reverse proxy to route HTTP and MQTT traffic from/to wis2box, and to enable TLS (HTTPS/MQTTS) on wis2box. -Please remember to update the ``WIS2BOX_URL`` and ``WIS2BOX_API_URL``environment variable after enabling SSL, ensuring your URL starts with ``https://``. +Please remember to update the ``WIS2BOX_URL`` and ``WIS2BOX_API_URL`` environment variable after enabling SSL, ensuring your URL starts with ``https://``. -Please note that after changing the ``WIS2BOX_URL`` and ``WIS2BOX_API_URL`` environment variables, you will need to restart your wis2box: +Please note that after changing the ``WIS2BOX_URL`` and ``WIS2BOX_API_URL`` environment variables, you will need to restart wis2box: .. code-block:: bash @@ -49,12 +49,12 @@ You can edit ``nginx/nginx.conf`` to control which services are exposed through You can edit ``docker-compose.override.yml`` to change the port on which the ``web-proxy`` service exposes HTTP on the localhost. .. note:: - The WIS2 notifications published by the wis2box includes the path ``/data/``. + The WIS2 notifications published by wis2box includes the path ``/data/``. This path has to be publicly accessible by the client receiving the WIS2 notification over MQTT, or the data referenced cannot be downloaded To share your data with the WIS2 network, ensure that ``WIS2BOX_URL`` as defined in ``wis2box.env`` points to the externally accessible URL for your HTTP services. -After updating ``WIS2BOX_URL``, please stop and start your wis2box using ``wis2box-ctl.py`` and republish your data using the command ``wis2box metadata discovery publish``. +After updating ``WIS2BOX_URL``, please stop and start wis2box using ``wis2box-ctl.py`` and republish your data using the command ``wis2box metadata discovery publish``. .. note:: @@ -64,7 +64,7 @@ After updating ``WIS2BOX_URL``, please stop and start your wis2box using ``wis2b wis2box API ----------- -The wis2box API uses `pygeoapi`_, which implements the `OGC API`_ suite of standards, to provide programmatic access to the data collections hosted in your wis2box. +The wis2box API uses `pygeoapi`_, which implements the `OGC API`_ suite of standards, to provide programmatic access to the data collections hosted in wis2box. .. image:: ../_static/wis2box-api.png :width: 800 @@ -72,16 +72,16 @@ The wis2box API uses `pygeoapi`_, which implements the `OGC API`_ suite of stan .. note:: - Currently, the default API backend in the wis2box stack uses `Elasticsearch`_. - A dedicated Docker-volume ``es-data`` is created on your host when you start your wis2box. - As long as this volume is not deleted you can remove/update the containers in the wis2box stack without losing data. + Currently, the default API backend in wis2box uses `Elasticsearch`_. + A dedicated Docker volume ``es-data`` is created on your host when you start wis2box. + As long as this volume is not deleted you can remove/update the containers in wis2box without losing data. wis2box user interface ---------------------- -The wis2box user interface uses the wis2box API to visualize the data configured and shared through your wis2box. +The wis2box user interface uses the wis2box API to visualize the data configured and shared through wis2box. -The 'map' or 'explore' option of each dataset allows you to visualize Weather Observations per station. +The 'MAP' or 'EXPLORE' option of each dataset allows you to visualize Weather Observations per station. .. image:: ../_static/wis2box-map-view.png :width: 800 @@ -96,10 +96,10 @@ Mosquitto (MQTT) By default, wis2box uses its own internal `Mosquitto`_ container to publish WIS2 notifications. -To allow the WIS2 Global Broker to subscribe to WIS2 notifications from your wis2box you have 2 options: +To allow the WIS2 Global Broker to subscribe to WIS2 notifications from wis2box you have 2 options: - * enable access to internal broker running in the MQTT container on your wis2box host - * configure your wis2box to use an external broker + * enable access to internal broker running in the MQTT container on wis2box host + * configure wis2box to use an external broker Internal broker --------------- @@ -108,7 +108,7 @@ The internal MQTT broker is accessible on the host ``mosquitto`` within the Dock By default port 1883 of the mosquitto container is mapped to port 1883 of the host running wis2box. -By exposing port 1883 on your host, the Global Broker will be able to subscribe directly to the internal MQTT broker on the wis2box. +By exposing port 1883 on your host, the Global Broker will be able to subscribe directly to the internal MQTT broker on wis2box. .. note:: @@ -117,7 +117,7 @@ By exposing port 1883 on your host, the Global Broker will be able to subscribe External broker --------------- -If you do not wish to expose the internal MQTT broker on your wis2box, you can configure your wis2box to publish WIS2 notifications to an external broker by setting the environment variable ``WIS2BOX_BROKER_PUBLIC``. +If you do not wish to expose the internal MQTT broker on wis2box, you can configure wis2box to publish WIS2 notifications to an external broker by setting the environment variable ``WIS2BOX_BROKER_PUBLIC``. .. code-block:: bash