Goobi workflow
Documentation homeGoobi workflow PluginsGoobi workflow Digests
English
English
  • Overview
    • Goobi workflow Handbook
    • Overview of documentation
    • What is Goobi?
  • Users
    • Goobi for Users
    • The basics
      • Logging in
      • Menu
      • Logging out
      • Switch between available languages
      • Help function
      • Personal settings
      • Changing your password
      • My tasks
      • Processes
      • How to find a process
      • How to create a new process
      • Edit task details
    • How different user groups work with Goobi
      • Scanning
      • Quality control
      • Manual script steps and plugin steps
      • Automatic script-run steps
      • Metadata processing
      • Export to the DMS
    • Metadata Editor
      • User interface
        • Structure tree
        • Page display
        • Menu options
      • Metadata indexing
        • Pagination
        • Structuring
          • Create new structure element
          • Moving structure elements
          • Copying structure elements from other processes
      • Modifying and verifying data
        • Subsequent changes to pagination
        • Uploading files
        • Downloading files
        • Server-based exports
        • Server-based imports
      • Edit OCR results
      • Overview of the keyboard combinations
  • Management
    • Goobi Management
    • Structure of the extended user interface
    • Rulesets
    • LDAP groups
    • Users
    • User groups
    • Processes
      • Searching processes
      • Activity
      • Activities for hit lists
      • GoobiScript
    • Variables
    • Harvester
  • Administration
    • Goobi Administration
    • File system
      • Global directory structure
        • ‘config’ sub-directory
        • ‘import’ sub-directory
        • ‘metadata’ sub-directory
        • ‘plugins’ sub-directory
        • ‘rulesets’ sub-directory
        • ‘scripts’ sub-directory
        • ‘xslt’ sub-directory
      • Directory structure of the application
      • Integrating external storage
      • Integration of S3 as storage
    • Services
      • MySQL database
      • Apache Tomcat servlet container
      • User authentication using LDAP
      • File system access using Samba
    • Exporting to digital libraries
      • Technical data
      • Mets parameters
      • Mets file groups
      • Export configuration in the Goobi configuration file
    • Working with the intranda Task Manager
    • Automatic workflow steps
      • Example combination for an automatic script task
      • Migration of technical data to METS files
      • Automatic image deletion
    • Configuration files
      • goobi_activemq.xml
      • goobi_config.properties
      • goobi_digitalCollections.xml
      • goobi_exportXml.xml
      • goobi_mail.xml
      • goobi_metadataDisplayRules.xml
      • goobi_normdata.xml
      • goobi_opac.xml
      • goobi_opacUmlaut.txt
      • goobi_processProperties.xml
      • goobi_projects.xml
      • goobi_rest.xml
      • goobi_webapi.xml
      • messages_xx.properties
      • config_contentServer.xml
    • Installation guide
      • Installation guide - Ubuntu 20.04
    • Update guide
      • Preparation of an update
      • Update steps
        • 2020
        • 2021
        • 2022
        • 2023
        • 2024
        • 2025
    • Authentication options
      • Authentication via the database
      • Authentication via HTTP header
      • Authentication via OpenID Connect
    • Use cases
      • Create thumbnails for accelerated image display
      • Handling of 3D Objects
      • Export of 3D-Objects into the Goobi viewer
  • Developer
    • Setting up a development environment
      • Preparatory work
      • Setting up Eclipse
      • Resetting the data
      • Best practice for developing Goobi and working with Eclipse
    • Using the REST API
    • Snippets for the development on Goobi workflow
      • HTML
      • JavaScript
Bereitgestellt von GitBook
Auf dieser Seite
  • 1.1.1 Installing Java 11
  • Installation under Linux:
  • Installation under Mac:
  • Installation under Windows:
  • Checking the installation
  • 1.1.2 Installing MariaDB
  • Installation under Linux:
  • Installation under Mac:
  • Installation under Windows:
  • Creating an empty database for Goobi workflow
  • 1.1.3 Preparing a directory
  • 1.1.4 Download Eclipse
  • 1.1.5 Download Apache Tomcat
  • 1.1.6 Download demo data
Als PDF exportieren
  1. Developer
  2. Setting up a development environment

Preparatory work

VorherigeSetting up a development environmentNächsteSetting up Eclipse

Zuletzt aktualisiert vor 5 Monaten

1.1.1 Installing Java 11

A prerequisite for the development of Goobi workflow and also for the development environment is a successfully installed Java 11. This can be installed differently depending on the operating system.

Installation under Linux:

The installation under Ubuntu Linux is done via command line as follows:

sudo apt install openjdk-11-jdk

Installation under Mac:

The installation under Mac is best done using from the terminal:

brew tap adoptopenjdk/openjdk
brew install --cask adoptopenjdk11

Installation under Windows:

For installation under Windows, you can download suitable installers from here: https://adoptopenjdk.net/releases.html

Checking the installation

After the successful installation, an output like the following should appear on the terminal with the command java -version:

$ java -version
openjdk version "11.0.11" 2021-04-20
OpenJDK Runtime Environment AdoptOpenJDK-11.0.11+9 (build 11.0.11+9)
OpenJDK 64-Bit Server VM AdoptOpenJDK-11.0.11+9 (build 11.0.11+9, mixed mode)

1.1.2 Installing MariaDB

Goobi workflow uses MariaDB to manage the data. This must be installed on the system accordingly.

Installation under Linux:

The installation under Ubuntu Linux is done via command line as follows:

sudo apt install mariadb-server

The database can be started and stopped in this way:

## starten
systemctl start mariadb

## stoppen
systemctl stop mariadb

Installation under Mac:

brew install mariadb

Der Start und Stop der Datenbank kann so erfolgen:

## starten
brew services start mariadb

## stoppen
brew services stop mariadb

Installation under Windows:

The installation under Windows is analogous.

Creating an empty database for Goobi workflow

In order for Goobi worklow to have data at its disposal, a database must be created. This can be done with the following commands:

sudo mysql -e "CREATE DATABASE goobi;
USE goobi;
CREATE USER 'goobi'@'localhost' IDENTIFIED BY 'goobi';
GRANT ALL PRIVILEGES ON goobi.* TO 'goobi'@'localhost' WITH GRANT OPTION;
FLUSH PRIVILEGES;"

1.1.3 Preparing a directory

We usually work in the directory /opt/digiverso/ for the development of Goobi and also for the operation on the servers. Therefore, the required folders must first be created if they do not already exist. This is done on Linux and Mac as follows:

sudo mkdir -p /opt/digiverso/dev/
sudo chown -R $(logname): /opt/digiverso

1.1.4 Download Eclipse

From there, select the current package of the 'Eclipse IDE for Enterprise Java and Web Developers' for your own operating system and download it. The package can then be unpacked and saved in the previously created directory /opt/digiverso/dev.

The directory looks like this:

1.1.5 Download Apache Tomcat

This downloaded zip file can then be unpacked and additionally saved in the same directory as Eclipse:

/opt/digiverso/dev

Accordingly, the directory now looks like this:

1.1.6 Download demo data

To start using Goobi workflow, you need configurations, data, a database dump and the required plugins in the right directories. A complete database dump can be found on GitHub. The easiest way is to copy the script calls provided there and run them locally:

The directory should now look like this:

The following command should then list the imported database tables:

mysql -u goobi -pgoobi goobi -e "show tables"

The installation under Mac is best done using from the terminal:

Eclipse must be downloaded and installed as a development environment. This is done from this website:

For the operation of Goobi workflow we use the Apache Tomcat version 9.x. This can be easily downloaded as a zip file from the following page by downloading the zip file from the Core section of the Binary Distributions of the current version:

Homebrew
Homebrew
https://www.eclipse.org/downloads/packages/
https://tomcat.apache.org/download-90.cgi
https://github.com/intranda/goobi-workflow-dev-data
Download Eclipse
Installation directory
Download Apache Tomcat
Installation directory
Demo-Daten