|
2 | 2 |
|
3 | 3 | The GeoKnow Generator provides workbench that integrates of tools developed within [GeoKnow project](http://geoknow.eu/), and are part of the [Linked Data Stack](http://stack.linkeddata.org/). These workbench aim to provide the required methods and tools to easly integrate and process geospatial data across a wide range of data sources on the web of data. |
4 | 4 |
|
| 5 | +### Requirements |
| 6 | + |
| 7 | +* [Virtuoso 7.1](https://github.com/openlink/virtuoso-opensource) triple store is required for most of the GeoKnow software tools integrated in this Workbench. |
| 8 | +* [Spring-batch-admin-generatror](https://github.com/GeoKnow/spring-batch-admin). For the moment this is required only for LIMES-Service in order to perform batch jobs, but it is planned to migrate some other coponents to be executed using this tool. |
| 9 | + |
| 10 | + |
5 | 11 | ## Install |
6 | 12 |
|
7 | 13 | * __From Debian package__: The GeoKnow Generator UI is available as a debuian package, to install follow [these](http://stack.linkeddata.org/documentation/installation-of-a-local-generator-demonstrator/) instructions. This is a preconfigured application that assumes that a triple store is installed in the localhost. |
8 | | -* __Form source__: Follow the configuration instructiobs below, and use `maven pacakge` to package the souces in a war file and deploy it on a servlet container. |
| 14 | +* __Form source__: Follow the configuration instructions below, and use `maven pacakge` to package the souces in a war file and deploy it on a servlet container. |
9 | 15 |
|
10 | | -These option will not install any integrated component from the stack and you require to install each one. You can choose to use again Debian packages following [these](http://stack.linkeddata.org/documentation/installation-of-a-local-generator-demonstrator/) instructions, or manually visiting each developer's component installation guides. |
| 16 | +The Generator Workbencg will not install any integrated component from the stack and you require to install each one. You can choose to use again Debian packages following [these](http://stack.linkeddata.org/documentation/installation-of-a-local-generator-demonstrator/) instructions, or following instructions from each developer's component installation guides. |
11 | 17 |
|
12 | 18 | ## Configuration |
13 | 19 |
|
14 | | -### Requirements |
15 | | - |
16 | | -* Virtuoso 7.1 triple store and make sure to have a superuser created. |
17 | | - |
18 | 20 | ### Application configuration |
19 | 21 |
|
20 | | -1. Open the `src/main/resources/framework-configuration.ttl` and provide endpoints, users and password information in the lds:StorageService element. The lds:SecuredSPARQLEndPointService user will be automatically created in the setup. |
| 22 | +1. Open the `src/main/resources/framework-configuration-template.ttl` and provide for: |
| 23 | + |
| 24 | + * GeoKnowGenerator foaf:homepage URL if the application is going to be accessed from a different place than the localhost, |
| 25 | + * VirtuosoConductor lds:serviceUrl, lds:user, lds:password and lds:connectionString, |
| 26 | + * VirtuosoAuthSPARQLEndpoint void:sparqlEndpoint, lds:serviceUrl, and desired user/password for the workbench user, wich will be created at setup. |
| 27 | + * VirtuosoEndpoint : void:sparqlEndpoint and lds:serviceUrl, |
| 28 | + * Admin foaf:mbox, which will belong to tha initial administrator user account. By default a admin user with password is created, and an email has to be provided in the configuration. |
21 | 29 |
|
22 | 30 | 2. Open the `src/main/resources/framework-components.ttl` and make sure URLs for alll stack components are accurate. |
23 | 31 |
|
24 | | -2. Edit `src/main/webapp/WEB-INF/web.xml` and provide the ***REMOVED*** data. |
| 32 | +3. In order to let other users to register into the system, you need to edit `src/main/webapp/WEB-INF/web.xml` and provide the ***REMOVED*** data that is required for email notifications. |
| 33 | + |
| 34 | +### Application Setup and Reset |
25 | 35 |
|
| 36 | +To initalize the application the user is only required to navigate to the URL where the application has being deployed and a setup page will be shown. |
26 | 37 |
|
27 | | -Note that the endpoint has to support [UPDATE](http://www.w3.org/TR/2013/REC-sparql11-update-20130321/) service and [Graph Store HTTP Protocol](http://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/) |
28 | | - |
29 | | -### Application setup |
| 38 | +The application requires a system file at `/etc/generator/` (configured in the web.xml file), with write privileges for creating a init file that will be used as a flag for setting the system up. |
| 39 | + |
| 40 | +The Setup process will create a system user in Virtuoso and the admininstrator user proviced in the configuration file. It will also create and add required information on the system graphs. |
30 | 41 |
|
31 | | -To initalize the application the user is only required to navigate to the URL where the application has being deployed and a setup page will be shown. The application requires a system file (e.g. `/etc/generator/`) with write privileges for creating a init file that will be used as a flag for setting the system up. |
| 42 | +To reset the application for taking into account a new configuration, you need to delete the file created in `/etc/generator/init.txt`, and navigate to the workbench url where the setup page will be shown. Make sure to select the reset checkbox in order to delete previous data. |
32 | 43 |
|
33 | 44 | ### Virtuoso Endpoint |
34 | 45 |
|
35 | 46 | Currently ontly Virtuoso store is supported and it has being tested in version 7.1. The Generator makes use of Virtuoso users management to allow the creation of private graphs and allow them to grant access to to specific users. |
36 | 47 |
|
37 | | -## Optional Extra Configutation |
| 48 | +## Extra Configutation |
38 | 49 |
|
39 | 50 | Depending on the components you use in the Generator some extra configurations may be required. |
40 | 51 |
|
41 | | - |
42 | | -### Using OntoWiki-Virtuoso |
43 | | - |
44 | | -In order that [OntoWiki](https://github.com/AKSW/OntoWiki) is able to access Virtuoso store, besides the installation of the OntoWiki-Virtuoso component you need to follow the instructions of OntoWiku using [Virtuoso Backend](https://github.com/AKSW/OntoWiki/wiki/VirtuosoBackend). |
45 | | - |
46 | | - |
47 | 52 | ## Issues |
48 | 53 |
|
| 54 | +### Tomcat |
49 | 55 | If some components are installed on the same tomcat server as the Generator, it is better to increase the Java Heap space. Edit the file /etc/default/tomcat7 and perform the following change. |
50 | 56 |
|
51 | 57 | # The original options look something like this: |
52 | 58 | # JAVA_OPTS="-Djava.awt.headless=true -Xmx128m -XX:+UseConcMarkSweepGC" |
53 | 59 |
|
54 | 60 | JAVA_OPTS="-Djava.awt.headless=true -Xmx1g -XX:+UseConcMarkSweepGC" |
55 | 61 |
|
| 62 | +### Using OntoWiki-Virtuoso |
| 63 | + |
| 64 | +In order that [OntoWiki](https://github.com/AKSW/OntoWiki) is able to access Virtuoso store, besides the installation of the OntoWiki-Virtuoso component you need to follow the instructions of OntoWiku using [Virtuoso Backend](https://github.com/AKSW/OntoWiki/wiki/VirtuosoBackend). |
| 65 | + |
56 | 66 | ## Licence |
57 | 67 |
|
58 | 68 | The source code of this repo is published under the Apache License Version 2.0 |
|
0 commit comments