Running the workflow requires a number of tools to be configured: JRuby, SBT, Java 8 (JDK), Make. When using a CI server (such as Jenkins), a number of plugins are recommended to be installed. This is mentioned at the bottom of this section.
Install the latest version of the Java 8 JDK from Oracle's website. It is recommended not to use OpenJDK.
Java 8 JDK may already be pre-installed on your system. To check if this is the case, run java -version
in a terminal window.
Install the latest version of SBT 0.13.x from the Scala SBT website. Note: do NOT use SBT 1.x (currently a pre-release / beta) - there are known differences in syntax that will break part of the workflow.
Ensure that "make" is installed on the system. This is typically already the case for most Unix-based systems. Make is part of the GNU Utils. On MacOSX, this may require installing Xcode.
When running in a CI system (such as Jenkins), the agent may need to be configured appropriately. For Jenkins:
- Install the SBT plugin (simply called "sbt plugin"), and configure an installation of SBT 0.13.x .
The above assumes a recommended standard installation of Jenkins 2.4.x, with the recommended plugins installed (e.g., GitHub plugin, JUnit plugin)
To run, execute the following commands in a terminal, starting at the project root:
sbt setupFuseki
cd workflow
. env.sh
make start-fuseki
To stop the server:
cd workflow
make stop-fuseki
For Jenkins, a pipeline script can be found in the root directory. This file is called Jenkinsfile
.