Skip to content
This repository was archived by the owner on Apr 22, 2022. It is now read-only.

Commit 39ecfbd

Browse files
committed
update Readme and add screenshots
1 parent d28dfda commit 39ecfbd

File tree

8 files changed

+24
-83
lines changed

8 files changed

+24
-83
lines changed

README.md

Lines changed: 24 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,35 @@
11
# GeoKnow Generator UI
22

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-
5-
### Requirements
6-
7-
The Workbench absolutely requires the following software:
8-
9-
* Tomcat 7
10-
* [Virtuoso 7.1](https://github.com/openlink/virtuoso-opensource) triple store is required for most of the GeoKnow software tools integrated in this Workbench.
11-
* [Spring-batch-admin-generatror](https://github.com/GeoKnow/spring-batch-admin). It is used by some components in order to perform batch jobs, such as Limes-Service, ImportRDF and Deer-Service.
12-
13-
Since the workbench integrates several Linked Data tools, it is upto the user to insall and enable these components. The integrated tools are:
14-
15-
* [Limes-Service](https://github.com/GeoKnow/LIMES-Service)
16-
* [Facete](https://github.com/GeoKnow/Facete2)
17-
* [Sparqlify](https://github.com/AKSW/Sparqlify)
18-
* [Deer-Service](https://github.com/GeoKnow/DEER-Service)
19-
* [TripleGeo-Service](https://github.com/GeoKnow/TripleGeo-Service)
20-
* [FAGI-gis](https://github.com/GeoKnow/FAGI-gis)
21-
* [Mappify](https://github.com/GeoKnow/Mappify)
22-
* [OntoWiki](https://github.com/AKSW/OntoWiki)
23-
* [Coevolution](https://github.com/GeoKnow/Coevolution)
24-
25-
## Install
26-
27-
* __From Debian package__: The GeoKnow Generator UI is available as a debuian package, to install follow [these](http://stack.linkeddata.org/getting-started/geoknow-generator/) instructions.
28-
* __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.
29-
30-
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, or following instructions from each developer's component installation guides.
31-
32-
## Configuration
33-
34-
If you install the Workbench from sources you need to create the configuration files. If you installed from the Debian package, these files are already provided to work in the local host, and you can skip this configuration.
35-
36-
1. Create a directory for the application data e.g. /var/generator
37-
2. This directory have to be writable by the tomcat user, so you have to do something like:
38-
39-
chown -R tomcat:tomcat /var/generator
40-
41-
3. Adapt the framework configuration files located at src/main/resources. You need to remove the '-template' word from the file name.
42-
* **framework-configuration-template.ttl**: contains workbech required directories and variabled configuration and the configuration of services offered by the workbench. In this file you have to provide:
43-
* ontos:frameworkDataDir, provide the path of the directory created in step 1.
44-
* GeoKnowGenerator foaf:homepage URL if the application is going to be accessed from a different place than the localhost.
45-
* Provide in the :EmailService the corresponding configuration of an email account that will be used to notify newly registered users.
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. Integrated tools are:
4+
5+
* [Virtuoso-opensource](https://github.com/openlink/virtuoso-opensource) as the main RDF triple store and security grapm management.
6+
* [Limes-Service](https://github.com/GeoKnow/LIMES-Service) for iterlinking data.
7+
* [Facete](https://github.com/GeoKnow/Facete2), a faceted browser.
8+
* [Sparqlify](https://github.com/AKSW/Sparqlify), a SPARQL-SQL rewriter.
9+
* [Deer-Service](https://github.com/GeoKnow/DEER-Service), a Linked Data enrichment tool.
10+
* [TripleGeo-Service](https://github.com/GeoKnow/TripleGeo) for extracting geospatial features into RDF triples.
11+
* [FAGI-gis](https://github.com/GeoKnow/FAGI-gis), a geospatioal data fusing tool.
12+
* [Mappify](https://github.com/GeoKnow/Mappify), a widget generator tool of geospatial data
13+
* [OntoWiki](https://github.com/AKSW/OntoWiki), an authoring tool.
14+
* [Coevolution](https://github.com/GeoKnow/Coevolution) for data versioning and repair.
15+
16+
Therefore, the GeoKnow Generator Workbench provides a unified interface and common backend for above mentioned tools, it also provides enterpirse ready functionalities such as:
17+
18+
* User authentication and management
19+
* Data control access
20+
* Batch processing
21+
* Provenance tracking
22+
23+
[TODO]: add articles
4624

47-
* **framework-components-template.ttl**: contains configuration of external tools that are integrated in the workbench. In this file you have to provide:
48-
* VirtuosoConductor lds:serviceUrl, lds:user, lds:password and lds:connectionString,
49-
* VirtuosoAuthSPARQLEndpoint void:sparqlEndpoint, lds:serviceUrl, and desired user/password for the workbench user, wich will be created at setup.
50-
* VirtuosoEndpoint : void:sparqlEndpoint and lds:serviceUrl,
51-
52-
* **framework-roles-template.ttl**: contains an initial specifications of roles. You can leave this file as is.
53-
* **framework-users-template.ttl**: contais the users that will be created at setup, and that can be used to login into the application. You can change the username and paswords and add more users.
54-
* **framework-datasources-template.ttl**: contains an inital configuration of datasources.
55-
56-
57-
## Setup and Reset
5825

59-
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.
60-
61-
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.
62-
63-
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.
64-
65-
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.
66-
67-
### Virtuoso Endpoint
68-
69-
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.
70-
71-
## Extra Configutation
72-
73-
Depending on the components you use in the Generator some extra configurations may be required.
74-
75-
## Issues
76-
77-
### Tomcat
78-
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.
79-
80-
# The original options look something like this:
81-
# JAVA_OPTS="-Djava.awt.headless=true -Xmx128m -XX:+UseConcMarkSweepGC"
82-
83-
JAVA_OPTS="-Djava.awt.headless=true -Xmx1g -XX:+UseConcMarkSweepGC"
84-
85-
### Using OntoWiki-Virtuoso
26+
## Install
8627

87-
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).
28+
Refer to our [wiki](https://github.com/GeoKnow/GeoKnowGeneratorUI/wiki) to install the application.
8829

8930
## Licence
9031

91-
The source code of this repo is published under the Apache License Version 2.0
32+
The source code of this repo is published under the [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
9233

9334
## Contact
9435

screenshots/components.png

138 KB
Loading

screenshots/dashboard.png

57.7 KB
Loading

screenshots/datasources.png

147 KB
Loading

screenshots/graph-meta.png

57.8 KB
Loading

screenshots/graphs.png

137 KB
Loading

screenshots/roles.png

106 KB
Loading

screenshots/setup.png

32.7 KB
Loading

0 commit comments

Comments
 (0)