Developer installation guide

These instructions outline how to install Opencast on a Linux system.

1.Getting the Source Code

You can get the Opencast source code by cloning the Git repository.

Cloning the Git repository:

git clone https://github.com/opencast/opencast.git

2.Install Dependencies

Please make sure to install the following dependencies.

Required:

java-1.8.0-openjdk-devel.x86_64 / openjdk-8-jdk (other jdk versions untested / Oracle JDK strongly not recommended)
ffmpeg >= 3.2.4
maven >= 3.1
python >= 2.6, < 3.0
unzip
gcc-c++
tar
bzip2

Required as a service for running Opencast:

ActiveMQ >= 5.10 (older versions untested)

Required for some services. Some tests may be skipped and some features may not be usable if they are not installed. Hence, it's generally a good idea to install them.

tesseract >= 3
hunspell >= 1.2.8
sox >= 14.4
synfig

Dependency Download

Pre-built versions of most dependencies that are not in the repositories can be downloaded from the respective project websites:

3.ActiveMQ Configuration

Opencast comes with a basic configuration for ActiveMQ. Please follow the first configuration step to copy the XML file. Message Broker Configuration.

4.Build and Start Opencast

The -Pdev argument decreases the build time and skips the creation of multiple tarballs and turning on the developer tarball.

cd opencast-dir
mvn clean install -Pdev
cd build/opencast-*
./bin/start-opencast

Useful Commands for Testing Purposes

For a quick build, you can use the following command to skip Opencast's tests.

cd opencast-dir
mvn clean install -DskipTests=true

To see the whole stacktrace of the installation you can use the following command to disable the trimming.

cd opencast-dir
mvn clean install -DtrimStackTrace=false

5.Modify Code and Build Changes

After you modified your code you can go back to step 4 to rebuild Opencast.