-
Notifications
You must be signed in to change notification settings - Fork 63
Installationsanleitung für Kitodo.Production 3.0
Die folgende Anleitung beschreibt exemplarisch die Installation von Kitodo.Production auf einem Debian-System mit lokaler Datenbank. Für andere Distributionen sind insbesondere die Pfadangaben entsprechend anzupassen. Soll ein separater Datenbankserver verwendet werden, ist dies beim Anlegen des Datenbanknutzers für Kitodo bei der Rechtevergabe zu beachten.
Kitodo.Production benötigt mindestens 1 leistungsstarke CPU und 3 GB RAM sowie ca. 10 GB Festplattenspeicher. Darin ist der Speicherplatzbedarf der Digitalisierungsdaten nicht enthalten!
We will install the Kitodo.Production 3.0.1 release on a Debian 9.x operating system with Tomcat 8, MySQL 5.7 and Elasticsearch 5.x Please follow the instructions.
Download and install Debian 9.x.
Debian recommends to use sudo instead of opening a session as root.
su -c "apt install -y sudo && adduser $USER sudo && echo \"Defaults timestamp_timeout=300\" >> /etc/sudoers.d/timeout && reboot"
We will add official repositories of Oracle and elastic to get the newest versions of MySQL 5.7 and Elasticsearch 5.x
sudo apt install -y apt-transport-https dirmngr
sudo apt-key adv --keyserver pgp.mit.edu --recv-keys 5072E1F5 && echo "deb http://repo.mysql.com/apt/debian/ stretch mysql-5.7" | sudo tee -a /etc/apt/sources.list.d/mysql-5.7.list
wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add - && echo "deb https://artifacts.elastic.co/packages/5.x/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elastic-5.x.list
You will be asked to set a root password for mysql. You may leave it blank (not recommended for production mode).
sudo apt update && sudo apt install -y openjdk-8-jdk tomcat8 mysql-community-server elasticsearch curl
We recommend to provide at least 1920m JAVA heap space to Tomcat.
sudo sed -i 's/JAVA_OPTS="-Djava.awt.headless=true/JAVA_OPTS="-Djava.awt.headless=true -Xmx1920m/' /etc/default/tomcat8
The following commands will preconfigure MySQL, create a database and a database user. You will be asked for the MySQL root password that you set before.
sudo sh -c "echo '[mysqld] innodb_file_per_table' >> /etc/mysql/my.cnf"
sudo service mysql restart
sudo mysql -e "create database kitodo;grant all privileges on kitodo.* to kitodo@localhost identified by 'kitodo';flush privileges;"
Now we will ingest a SQL file from the Kitodo GitHub Repository to set up the database schema and provide some example data.
curl -L https://github.com/kitodo/kitodo-production/releases/download/kitodo-production-3.0.1/kitodo-production-3.0.1.sql | mysql -u kitodo -D kitodo --password=kitodo
The following commands will set configs in /etc/elasticsearch/elasticsearch.yml.
sudo sed -i 's/#path.data: \/path\/to\/data/path.data: \/var\/lib\/elasticsearch/' /etc/elasticsearch/elasticsearch.yml
sudo sed -i 's/#path.logs: \/path\/to\/logs/path.logs: \/var\/log\/elasticsearch/' /etc/elasticsearch/elasticsearch.yml
sudo sed -i 's/#cluster.name: my-application/cluster.name: kitodo/' /etc/elasticsearch/elasticsearch.yml
sudo sed -i 's/#node.name: node-1/node.name: kitodo-1/' /etc/elasticsearch/elasticsearch.yml
sudo /bin/systemctl daemon-reload
sudo /bin/systemctl enable elasticsearch.service
sudo systemctl start elasticsearch.service
Other ElasticSearch settings can be adjusted in kitodo_config.properties file:
elasticsearch.host=localhost
elasticsearch.port=9200
elasticsearch.protocol=http
elasticsearch.index=kitodo
elasticsearch.batch=1000
elasticsearch.useAuthentication=true
elasticsearch.user=kitodo
elasticsearch.password=kitodo
We will download a zip file from the Kitodo GitHub Repository that contains all needed directories and additional config files. We will extract the zip archive into the default folder /usr/local/kitodo. If you want to use another folder please update paths in /var/lib/tomcat8/webapps/kitodo/WEB-INF/classes/kitodo_config.properties (will be generated in the deployment of war file below) also.
List of the directories:
directory.config=/usr/local/kitodo/config/directory.rulesets=/usr/local/kitodo/rulesets/directory.xslt=/usr/local/kitodo/xslt/directory.metadata=/usr/local/kitodo/metadata/directory.users=/usr/local/kitodo/users/directory.temp=/usr/local/kitodo/temp/script_createDirUserHome=/usr/local/kitodo/scripts/script_createDirUserHome.shscript_createDirMeta=/usr/local/kitodo/scripts/script_createDirMeta.shscript_createSymLink=/usr/local/kitodo/scripts/script_createSymLink.shscript_deleteSymLink=/usr/local/kitodo/scripts/script_deleteSymLink.shdirectory.messages=/usr/local/kitodo/messages/directory.debug=/usr/local/kitodo/debug/directory.modules=/usr/local/kitodo/modules/
sudo mkdir /usr/local/kitodo
wget https://github.com/kitodo/kitodo-production/releases/download/kitodo-production-3.0.1/kitodo-production-3.0.1-config.zip
sudo unzip kitodo-production-3.0.1-config.zip -d /usr/local/kitodo
sudo chown -R tomcat8:tomcat8 /usr/local/kitodo
sudo chmod u+x /usr/local/kitodo/scripts/*.sh
Note: Create and change path to messages directory only in the case when you want to add / edit your own translations. Only those translation files will be used, not the one from class path. It demands that those translation files contain all keys, not only added / updated.
Modules need to be downloaded and copied into the modules folder, e.g. /usr/local/kitodo/modules/
sudo mkdir /usr/local/kitodo/modules
wget https://github.com/kitodo/kitodo-production/releases/download/kitodo-production-3.0.1/kitodo-production-3.0.1-modules.zip
sudo unzip kitodo-production-3.0.1-modules.zip -d /usr/local/kitodo/modules
sudo chown -R tomcat8:tomcat8 /usr/local/kitodo/modules
Moving the prepared war file from the Kitodo GitHub Repository into the webapps directory triggers Tomcat to deploy the application automatically.
wget https://github.com/kitodo/kitodo-production/releases/download/kitodo-production-3.0.1/kitodo-3.0.1.war
sudo chown tomcat8:tomcat8 kitodo-3.0.1.war
sudo mv kitodo-3.0.1.war /var/lib/tomcat8/webapps/kitodo.war
until curl -s GET "localhost:8080/kitodo/pages/login.jsf" | grep -q -o "KITODO.PRODUCTION" ; do sleep 1; done
The Kitodo Webapp should be available at http://localhost:8080/kitodo/ now. Give it a try before you continue to configure the system.
- user: testAdmin
- pass: test
After logging in you can access the indexing page (via menu "System" or directly at http://localhost:8080/kitodo/pages/system.jsf). First create mapping by clicking button "Create mapping". Next, start indexing the provided example data by clicking on the button "Start indexing" (at whole index).
Further settings may be made in the following config files:
/usr/local/kitodo/config/kitodo_opac.xml-
/var/lib/tomcat8/webapps/kitodo/WEB-INF/classes/kitodo_config.properties(general settings, e.g. filename prefix for images) -
/var/lib/tomcat8/webapps/kitodo/WEB-INF/classes/hibernate.cfg.xml(connection url, username and password to mysql database) -
/var/lib/tomcat8/webapps/kitodo/WEB-INF/classes/log4j2.xml(logging)
To apply changes we need to reload the Kitodo webapp. Assuming there are no other webapps deployed on this server, we could just restart the Tomcat server.
sudo systemctl restart tomcat8
until curl -s GET "localhost:8080/kitodo/pages/login.jsf" | grep -q -o "KITODO.PRODUCTION" ; do sleep 1; done