Merge branch 'master' of https://github.com/52North/sensor-web-tutorial

52North · Sep 22, 2021 · d52dec1 · d52dec1
2 parents 20f3f19 + fae622f
commit d52dec1
Show file tree

Hide file tree

Showing 22 changed files with 2,661 additions and 0 deletions.
diff --git a/docs/10_sos_installation_war_file.md b/docs/10_sos_installation_war_file.md
@@ -0,0 +1,78 @@
+---
+title: 10. SOS Installation WAR-File
+layout: page
+---
+
+## Introduction
+
+This tutorial shows you how to install a Sensor Observation Service (SOS). To be able to install the
+__52°North SOS__ the following software has to be downloaded and installed:
+
+- __Java Runtime Enviroment__ (JRE) 8.0 or higher
+- __Application server__ compatible to Java Servlet-API 2.5 or higher
+- Running __database managment system__
+
+For Windows systems we provide a tutorial, how to setup the system for the installation of the SOS.
+In the tutorial we use __Apache Tomcat__ as the application server
+and __PostgreSQL/ PostGIS__ as the database management system: [Tutorial](89_installation_requirments_for_windows.md)
+
+If you want to use different software, have an other operating system
+or want to build the SOS from source you can find more information here:
+[52°North SOS 5.x Documentation](https://wiki.52north.org/SensorWeb/SensorObservationServiceVDocumentation)
+
+## Installing the Webapp
+
+When your system matches the requirments above, download the package including the __war-file__: [52°North SOS latest version](https://github.com/52North/SOS/releases)
+
+Unzip the package and browse to the folder `UNZIPPED_PACKAGE/bin/target` where the file `52n-sos-webapp.war`
+is located. Copy the file `52n-sos-webapp.war` into the folder `TOMCAT_BASE/webapps`. Make sure your Tomcat
+and PostgreSQL are running. After a moment the __war-file__ gets converted and in the folder should be a new
+folder `52n-sos-webapp`. If this is the case than you can reach the webapp with this URL:
+[http://localhost:8080/52n-sos-webapp/](http://localhost:8080/52n-sos-webapp/)
+
+When you succesfully reach the service it should look like this:
+
+![webappStartpage.PNG](images/webappStartpage.PNG "52°North SOS Startpage")
+
+You can start the installation process by clicking on the link in the red banner.
+
+![SetupSOS_1.PNG](images/SetupSOS_1.PNG "52°North SOS Installation Wizard Welcome-Page")
+
+The installation process starts with the Welcome-page. If you have an exported configuration file of
+a previous SOS installation you can upload this file here, else you can start the installation without
+a configuration file.
+
+![SetupSOS_2.png](images/SetupSOS_2.png "52°North SOS Installation Wizard Datasource Configuration")
+
+In the next steps you configure your datasource. First you need to select the database managment system
+which you are using as the datasource.
+
+![SetupSOS_3.png](images/SetupSOS_3.png "52°North SOS Installation Wizard Datasource Configuration")
+
+Next you need to set the parameters of your database, so the SOS can reach the database.
+
+![SetupSOS_4.png](images/SetupSOS_4.png "52°North SOS Installation Wizard Datasource Configuration")
+
+You can also configure advanced database settings.
+
+![SetupSOS_5.png](images/SetupSOS_5.png "52°North SOS Installation Wizard Datasource Configuration")
+
+Under Actions you can chose if you want to create new table, delete all extings tables or update all extings tables in your database. If you use the database for the first time you do not want to chance
+the settings and leave only `Create tables` marked.
+
+![SetupSOS_6.png](images/SetupSOS_6.png "52°North SOS Installation Wizard Optional Settings")
+
+Next you can add information about the service provider. All these settings can be changed later
+in the administrative backend.
+
+![SetupSOS_7.png](images/SetupSOS_7.png "52°North SOS Installation Wizard Optional Settings")
+
+You can also upload a service provider file which overrides the above settings.
+
+![SetupSOS_8.png](images/SetupSOS_8.png "52°North SOS Installation Wizard Optional Settings")
+
+You finish your installation by setting a username and a password for the SOS.
+
+![webappInstallCompleted.PNG](images/webappInstallCompleted.PNG "52°North SOS Startpage")
+
+You now have succesfully installed the __52°North SOS__.
diff --git a/docs/11_sos_example_request.md b/docs/11_sos_example_request.md
diff --git a/docs/12_advanced_sos_example_request.md b/docs/12_advanced_sos_example_request.md
diff --git a/docs/13_sta_installation_war_file.md b/docs/13_sta_installation_war_file.md
@@ -0,0 +1,122 @@
+---
+title: 13. STA Installation WAR-File
+layout: page
+---
+
+## Introduction
+
+This tutorial shows you how to install a Sensor Things API (STA). To be able to install the
+__52°North STA__ the following software has to be downloaded and installed:
+
+- __Java Runtime Enviroment__ (JRE) 8.0 or higher
+- __Application server__ compatible to Java Servlet-API 2.5 or higher
+- Running __database managment system__
+
+For Windows systems we provide a tutorial, how to setup the system for the installation of the STA.
+In the tutorial we use __Apache Tomcat__ as the application server
+and __PostgreSQL/ PostGIS__ as the database management system: [Tutorial](89_installation_requirments_for_windows.md)
+
+## Installing the Webapp
+
+When your system matches the requirments above, download the package including the __war-file__: [52°North STA latest version](https://github.com/52North/sensorweb-server-sta/releases/tag/v3.0.0)
+
+Unzip the package and browse to the folder `UNZIPPED_PACKAGE/bin/target` where the file `52n-sensorthings-webapp.war`
+is located. Copy the file `52n-sensorthings-webapp.war` into the folder `TOMCAT_BASE/webapps`. Make sure your Tomcat
+and PostgreSQL are running. After a moment the __war-file__ gets converted and in the folder should be a new
+folder `52n-sensorthings-webapp`. Next navigate in this new folder to the `application.yml` and open it with
+an editor (`TOMCAT_BASE\webapps\52n-sensorthings-webapp\WEB-INF\classes`). You need to adjust the following
+settings manually:
+
+- __server__ -> __rootURL__: Used for response serialization + url parsing, external URL Must be set correctly!
+- __server__ -> __servlet__ -> __context-path__: The path of the running STA (name of the applet in the
+Apache Tomcat).
+- __spring__ -> __datasource__: Connection information to the database
+	- __username__: Database user name
+	- __password__: Database user password
+	- __url__: URL to the database (last value is the database name)
+	- __jpa__ -> __properties__ -> __hibernate__ -> __hbm2ddl___ -> __auto__: If you use the STA together
+	with the SOS, set the setting to `none`!
+
+
+If this is the case than you can reach the webapp with this URL:
+[http://localhost:8080/52n-sensorthings-webapp/](http://localhost:8080/52n-sensorthings-webapp/)
+
+When you successfully reach the service the response should be a json document looking like this:
+
+~~~json
+{
+    "value": [
+        {
+            "name": "Datastreams",
+            "url": "http://localhost:8080/52n-sensorthings-webapp/Datastreams"
+        },
+        {
+            "name": "Observations",
+            "url": "http://localhost:8080/52n-sensorthings-webapp/Observations"
+        },
+        {
+            "name": "Things",
+            "url": "http://localhost:8080/52n-sensorthings-webapp/Things"
+        },
+        {
+            "name": "Locations",
+            "url": "http://localhost:8080/52n-sensorthings-webapp/Locations"
+        },
+        {
+            "name": "HistoricalLocations",
+            "url": "http://localhost:8080/52n-sensorthings-webapp/HistoricalLocations"
+        },
+        {
+            "name": "Sensors",
+            "url": "http://localhost:8080/52n-sensorthings-webapp/Sensors"
+        },
+        {
+            "name": "ObservedProperties",
+            "url": "http://localhost:8080/52n-sensorthings-webapp/ObservedProperties"
+        },
+        {
+            "name": "FeaturesOfInterest",
+            "url": "http://localhost:8080/52n-sensorthings-webapp/FeaturesOfInterest"
+        }
+    ],
+    "serverSettings": {
+        "conformance": [
+            "http://www.opengis.net/spec/iot_sensing/1.1/req/datamodel",
+            "http://www.opengis.net/spec/iot_sensing/1.1/req/resource-path/resource-path-to-entities",
+            "http://www.opengis.net/spec/iot_sensing/1.1/req/request-data",
+            "http://www.opengis.net/spec/iot_sensing/1.1/req/create-update-delete",
+            "https://github.com/52North/sensorweb-server-sta/extension/server-properties.md",
+            "https://github.com/52North/sensorweb-server-sta/extension/server-version.md"
+        ],
+        "https://github.com/52North/sensorweb-server-sta/extension/server-properties.md": {
+            "escapeId": true,
+            "implicitExpand": false,
+            "updateFOI": false,
+            "variableEncodingType": false,
+            "isMobile": false,
+            "mqttReadOnly": false,
+            "httpReadOnly": false,
+            "mqttPublishTopics": "Observations",
+            "observation": {
+                "samplingGeometry": "http://www.opengis.net/def/param-name/OGC-OM/2.0/samplingGeometry",
+                "verticalFrom": "verticalFrom",
+                "verticalTo": "verticalTo",
+                "verticalFromTo": "vertical"
+            }
+        },
+        "https://github.com/52North/sensorweb-server-sta/extension/server-version.md": {
+            "git.repository": "https://github.com/52North/sensorweb-server-sta",
+            "git.lastCommitDate": "2020-12-16 12:55:46+0100",
+            "git.path": "d23185a8b80110405841d7a230345d2ebf26a53a",
+            "git.lastCommitMessage": "[maven-release-plugin] prepare release v3.0.0",
+            "git.revision": "d23185a8b80110405841d7a230345d2ebf26a53a",
+            "project.name": "52North SensorThingsAPI",
+            "project.version": "3.0.0",
+            "project.time": "2020-12-16T12:04:42.179Z",
+            "git.builddate": "2020-12-16 13:04:46+0100"
+        }
+    }
+}
+~~~
+
+Now you successfully installed your STA.