Page Comparison

There are two ways to get up and running with the Giles Ecosystem: using Docker or installing it directly on your infrastructure. We recommend to use Docker for evaluation and testing purposes, but to install all components directly on your machines in production.

...

Unpack the war file (e.g. by changing its ending to ".zip" and unzipping it)
Find the file WEB-INF/classes/config.properties and edit the following properties:
- giles_files_tmp_dir: This should be an absolute path to the directory where you want Giles to stores its temporary files (files uploaded by users that haven't been processed yet).
- If your Kafka server is not running on the same machine as Giles, or if it is running on a different port than the default port (9092), you have to change the property
  kafka_hosts to reflect this.
- Status
  colour Blue
  title since v0.5
  db.driver: the driver appropriate for you database (e.g. com.mysql.jdbc.Driver for MySQL or org.postgresql.Driver for PostgreSQL, see this page for more drivers).
- Status
  colour Blue
  title since v0.5
  db.url: connection URL for the used database .
- Status
  colour Blue
  title since v0.5
  db.username: username to connect to database.
- Status
  colour Blue
  title since v0.5
  db.password: password to connect to database.
Find the file WEB-INF/classes/META-INF/persistence.xml and change it as follows:
- There are three lines that start with <property name="javax.persistence.jdbc.url". In each line, replace /path/to/giles/dbfiles/folder with the path to the folder that should store Giles' DB files. It should look something like this:
  Code Block
  language xml
  <property name="javax.persistence.jdbc.url" value="/path/to/giles/db/folder/users.odb"/>
  Make sure to keep the file name at the end of each line
  Status
  colour Blue
  title since v0.5
  hibernate.dialect: the dialect used for your database (see this page for a list of dialects).
- All other properties can later be changed through the webapp itself.
Find the file WEB-INF/classes/user.properties and edit admin password:
- admin=adminPasswordBCrypted,ROLE_ADMIN,enabled: the password is the first value after the equal sign (adminPasswordBCrypted).
- Status
  colour Blue
  title since v0.6
  zookeeper_host: host name where Zookeeper is running (e.g. localhost or my.server.org)
- Status
  colour Blue
  title since v0.6
  zookeeper_port: port on which Zookeeper is running (default is 2181)
- Status
  colour Blue
  title since v0.6
  email_enabled: enables or disables email notifications. Set to true if email notifications should be sent; otherwise false.
- Status
  colour Blue
  title since v0.6
  email_from: email address notifications should be sent from.
- All other properties can later be changed through the webapp itself.
Unpack the war file (e.g. by changing its ending to ".zip" and unzipping it)
Find the file WEB-INF/classes/config.properties and edit the following properties:
- app_base_url: The base URL of Nepomuk such as https://your.nepomuk.server/nepomuk.
- If your Kafka server is not running on the same machine as Nepomuk, or if it is running on a different port than the default port (9092), you have to change the property
  kafka_hosts to reflect this.
Find the file WEB-INF/spring/springemail-securityconfig.xml and change the following lines:edit it as follows:
- Set the host property to your email host name by editing the value attribute:
  Code Block
  language xml
<beans:bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"> <beans:property
- <property name="
driverClassName
- host" value="
com
- your.
mysql
- email.
jdbc.Driver
- host"
- />
<beans:property
- Set the port property to your email host port by editing the port attribute:
  Code Block
  language xml
  <property name="
url
- port" value="
jdbc:mysql://localhost:3306/giles" /> <beans:property name="username" value="" /> <beans:property
- email.server.port"/>
- Set the username property to the username to use to connect to your email server:
  Code Block
  language xml
  <property name="username" value="username.for.emailserver"/>
- Set the password property to the password to be used to connect to your email server:
  Code Block
  language xml
  <property name="password" value="password.for.emailserver"
- />
</beans:bean>
Change the values of username and password to the username of your DB user and its password. If you did not name the new DB giles, change the url property to reflect the database name (e.g. if you named the database gilesdb, then instead of jdbc:mysql://localhost:3306/giles, put jdbc:mysql://localhost:3306/gilesdb).
If you are using PostgreSQL instead of MySLQ, make sure to replace the driver class name with org.postgresql.Driver.
Now, generate a new war file from the unpacked and changed files and deploy it in your Tomcat.
Info
If you are on a Unix-based operating system, you can do this for example by running the command jar -cvf giles.war . from inside the unpacked Giles folder.
Once deployed, Tomcat should be accessible at http://your.server/giles.

Note
From version v0.5 onwards, Giles does no longer use ObjectDB as database backend. If you set up a new Giles installation (not an update with existing data), you probably still have to execute step 3, but your data will be stored in the relational database you specify (e.g. MySQL). Step 3 is still part of the set up process for backwards compatibility and data migration purposes.

Info

title	Upgrading to v0.5

If you are upgrading from an earlier version to version v0.5, you will have to migrate existing data as follows:

Make sure Giles is running without exceptions.
Reregister the other components with Giles (Nepomuk, Cassiopeia, Cepheus) under "Apps".
Go to http://your.giles.server/giles-root/admin/migrate
Enter the username of the user who's data you want to migrate. The username will be a combination of username and provider id. For example for GitHub: githubusername_github. Depending on how much data the user has uploaded, this might take a while.
Once the migration is done for a user, you will see some statistics about how many objects were migrated.

Nepomuk

Nepomuk needs the following software to be installed:

Tomcat 8

You can either build Nepomuk from source by downloading Nepomuk's source code or download the war files uploaded for a release. This page explains how to install Nepomuk using the provided war file. The download page is https://github.com/diging/giles-eco-nepomuk/releases. In most cases, you should choose the latest release.

Once downloaded follow these steps:

Find the file WEB-INF/classes/user.properties and edit admin password:
- admin=adminPasswordBCrypted,ROLE_ADMIN,enabled: the password is the first value after the equal sign (adminPasswordBCrypted). Password should be hashed using the bcrypt algorithm with strength 10.
Find the file WEB-INF/classes/META-INF/persistence.xml and change it as follows:
- There are three lines that start with <property name="javax.persistence.jdbc.url". In each line, replace /path/to/giles/dbfiles/folder with the path to the folder that should store Giles' DB files. It should look something like this:
  Code Block
  language xml
  <property name="javax.persistence.jdbc.url" value="/path/to/giles/db/folder/users.odb"/>
  Make sure to keep the file name at the end of each line.

Find the file WEB-INF/spring/spring-security.xml and change the following lines:

Code Block

language	xml

<beans:bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
	<beans:property name="driverClassName" value="com.mysql.jdbc.Driver" />
	<beans:property name="url" value="jdbc:mysql://localhost:3306/giles" />
	<beans:property name="username" value="" />
	<beans:property name="password" value="" />
</beans:bean>

Change the values of username and password to the username of your DB user and its password. If you did not name the new DB giles, change the url property to reflect the database name (e.g. if you named the database gilesdb, then instead of jdbc:mysql://localhost:3306/giles, put jdbc:mysql://localhost:3306/gilesdb).
If you are using PostgreSQL instead of MySLQ, make sure to replace the driver class name with org.postgresql.Driver.

Now, generate a new war file from the unpacked and changed files and deploy it in your Tomcat.
Info
If you are on a Unix-based operating system, you can do this for example by running the command jar -cvf giles.war . from inside the unpacked Giles folder.
Once deployed, Tomcat should be accessible at http://your.server/giles.

Note
From version v0.5 onwards, Giles does no longer use ObjectDB as database backend. If you set up a new Giles installation (not an update with existing data), you probably still have to execute step 3, but your data will be stored in the relational database you specify (e.g. MySQL). Step 3 is still part of the set up process for backwards compatibility and data migration purposes.

Info

title	Upgrading to v0.5

If you are upgrading from an earlier version to version v0.5, you will have to migrate existing data as follows:

Make sure Giles is running without exceptions.
Reregister the other components with Giles (Nepomuk, Cassiopeia, Cepheus) under "Apps".
Go to http://your.giles.server/giles-root/admin/migrate
Enter the username of the user who's data you want to migrate. The username will be a combination of username and provider id. For example for GitHub: githubusername_github. Depending on how much data the user has uploaded, this might take a while.
Once the migration is done for a user, you will see some statistics about how many objects were migrated.

Nepomuk

Nepomuk needs the following software to be installed:

Tomcat 8
Status
colour Blue
title since v0.6
Starting with version v0.6, Nepomuk uses a relational database as backend. Currently, Nepomuk ships with drivers for MySQL and PostgreSQL.

You can either build Nepomuk from source by downloading Nepomuk's source code or download the war files uploaded for a release. This page explains how to install Nepomuk using the provided war file. The download page is https://github.com/diging/giles-eco-nepomuk/releases. In most cases, you should choose the latest release.

Once downloaded follow these steps:

Unpack the war file (e.g. by changing its ending to ".zip" and unzipping it)
Find the file WEB-INF/classes/config.properties and edit the following properties:
- app_base_url: The base URL of Nepomuk such as https://your.nepomuk.server/nepomuk.
- If your Kafka server is not running on the same machine as Nepomuk, or if it is running on a different port than the default port (9092), you have to change the property
  kafka_hosts to reflect this.
- Status
  colour Blue
  title since v0.6
  db.driver: the driver appropriate for you database (e.g. com.mysql.jdbc.Driver for MySQL or org.postgresql.Driver for PostgreSQL, see this page for more drivers).
- Status
  colour Blue
  title since v0.5
  db.url: connection URL for the used database .
- Status
  colour Blue
  title since v0.6
  db.username: username to connect to database.
- Status
  colour Blue
  title since v0.6
  db.password: password to connect to database.
- Status
  colour Blue
  title since v0.6
  hibernate.dialect: the dialect used for your database (see this page for a list of dialects).
- Status
  colour Blue
  title since v0.6
  hibernate.show_sql: if you want hibernate to print the SQL statements it runs, set this to true; otherwise false.
- Status
  colour Blue
  title since v0.6
  zookeeper_host: host name where Zookeeper is running (e.g. localhost or my.server.org)
- Status
  colour Blue
  title since v0.6
  zookeeper_port: port on which Zookeeper is running (default is 2181)
Find the file WEB-INF/classes/user.properties and edit admin password:
- admin=adminPassword,ROLE_ADMIN,enabled: the password is the first value after the equal sign (adminPassword). Password should be hashed using the bcrypt algorithm with strength 10.

Find the file WEB-INF/spring/root-contextx.xml and change the property baseDirectory of following bean definitions:

Code Block

language	xml

<bean id="imageStorageManager"
	class="edu.asu.diging.gilesecosystem.nepomuk.core.files.impl.FileStorageManager">
	<property name="baseDirectory" value="/path/to/image/parent/folder/" />
	<property name="fileTypeFolder" value="images"></property>
</bean>

<bean id="pdfStorageManager"
	class="edu.asu.diging.gilesecosystem.nepomuk.core.files.impl.FileStorageManager">
	<property name="baseDirectory" value="/path/to/files/parent/folder/" />
	<property name="fileTypeFolder" value="pdfs"></property>
</bean>

<bean id="textStorageManager"
	class="edu.asu.diging.gilesecosystem.nepomuk.core.files.impl.FileStorageManager">
	<property name="baseDirectory" value="/path/to/files/parent/folder/" />
	<property name="fileTypeFolder" value="texts"></property>
</bean>

<bean id="otherStorageManager"
	class="edu.asu.diging.gilesecosystem.nepomuk.core.files.impl.FileStorageManager">
	<property name="baseDirectory" value="/path/to/files/parent/folder/" />
	<property name="fileTypeFolder" value="others"></property>
</bean>

Each base directory needs to point to a folder to store images, pdfs, texts, or other files.

Now, generate a new war file from the unpacked and changed files and deploy it in your Tomcat.
Info
If you are on a Unix-based operating system, you can do this for example by running the command jar -cvf nepomuk.war . from inside the unpacked Nepomuk folder.
Once deployed, Tomcat should be accessible at http://your.server/nepomuk.

...

Versions Compared

Old Version 7

New Version 8

Key

Nepomuk

Nepomuk