Strabon
changeset 1022:b536de0c36b7
updated instructions for building/using Strabon from the command-line and mentioned its components in detail
author | Babis Nikolaou <charnik@di.uoa.gr> |
---|---|
date | Thu Apr 11 21:33:05 2013 +0300 (2013-04-11) |
parents | bc46378b62b3 |
children | 42e2528e44c4 |
files | README |
line diff
1.1 --- a/README Thu Apr 11 10:47:31 2013 +0300 1.2 +++ b/README Thu Apr 11 21:33:05 2013 +0300 1.3 @@ -54,6 +54,85 @@ 1.4 You can find a demo of the system Strabon at http://test.strabon.di.uoa.gr/NOA/. 1.5 1.6 1.7 +How to build and run Strabon from command line 1.8 +============================================== 1.9 +Assuming you have already downloaded Strabon and you are in the top-level 1.10 +directory of Strabon, issue the following command to build it from command line: 1.11 + 1.12 + $ mvn package 1.13 + 1.14 +The above command runs automatically the JUnit tests. To skip them pass option 1.15 +`-DskipTests=true' to the above command. The complete command is the following: 1.16 + 1.17 + $ mvn -DskipTests=true package 1.18 + 1.19 +In case of an error during building of Strabon and assuming that the error does 1.20 +not come from the JUnit tests, please have a look at the `Known Issues' section 1.21 +below. If none of the known issues of that section applies, please contact the 1.22 +developers through the Strabon mailing-list or submit a corresponding bug 1.23 +(see `Bugs' section below). 1.24 + 1.25 +After you have successfully built Strabon, you have access to the following 1.26 +components: 1.27 + 1.28 + * Strabon Endpoint 1.29 + 1.30 + This is a SPARQL endpoint for Strabon. It is distributed as a war file so 1.31 + you may deploy it in a Tomcat container. You may find the war file under 1.32 + directory `endpoint/target'. 1.33 + 1.34 + * Strabon Endpoint (standalone) 1.35 + 1.36 + This is a SPARQL endpoint for Strabon like the above one, but it differs 1.37 + only in that it does not require the user to have already set up a Tomcat 1.38 + container. The standalone Strabon Endpoint may be run by issuing the 1.39 + following command: 1.40 + 1.41 + $ java -jar endpoint-exec/target/strabon-endpoint-executable-${version}.jar 1.42 + 1.43 + After issuing the above command, you may access the Strabon Endpoint at 1.44 + the following URL: <http://localhost:8080/>. 1.45 + 1.46 + Please see the page at <http://hg.strabon.di.uoa.gr/Strabon/rev/674f8f91162b> 1.47 + to find out other options that you may pass to the Tomcat container that 1.48 + will run by the above command. 1.49 + 1.50 + SPECIAL NOTE: if you need to configure the connection details to the 1.51 + underlying database, you may do so in two ways: 1.52 + 1. By modifying file `endpoint/WebContent/WEB-INF/connection.properties' 1.53 + before building Strabon and executing the above command. 1.54 + 2. After executing the above command, by visiting the following page by a 1.55 + browser: <http://localhost:8080/ChangeConnection> 1.56 + 1.57 + * Strabon Endpoint Client 1.58 + 1.59 + This is a Java client for interacting with Strabon Endpoint or any other 1.60 + SPARQL endpoint. It is packaged as a jar file and may be found under 1.61 + directory `endpoint-client/target/' with name 1.62 + `strabon-endpoint-client-${version}.jar'. This jar contains any dependencies 1.63 + to other code, so may copy and paste it to your project and start playing 1.64 + with the code immediately. 1.65 + 1.66 + * Strabon script 1.67 + 1.68 + The `strabon' script is located under the `scripts/' directory and it is the 1.69 + main command-line tool for interacting with Strabon. You may use it to store 1.70 + RDF data with geospatial information or query/update it using one of 1.71 + stSPARQL or GeoSPARQL query languages. 1.72 + 1.73 + * Endpoint script 1.74 + 1.75 + The `endpoint' script is located under the `scripts' directory and it is the 1.76 + main command-line tool for interacting with a `Strabon Endpoint'. You may 1.77 + use it to do any operation you would like to do with the `strabon' script 1.78 + above, but in contrast to the `strabon' script you need to have access to a 1.79 + Strabon endpoint. Of course, the `Strabon Endpoint Client' component above 1.80 + can be used as well as a command-line tool. At the time of writing, the 1.81 + `Strabon Endpoint Client' component supports only querying of RDF data with 1.82 + geospatial information. 1.83 + 1.84 + 1.85 + 1.86 Getting Started 1.87 =============== 1.88 To get started with Strabon please have a look at the tutorial for the stRDF