Difference between revisions of "Download and Installation"

From Transkribus Wiki
Jump to: navigation, search
(Created page with "Once you have registered for an account, you can download Transkribus for free from our [https://transkribus.eu/Transkribus/ website]. ===Supported Operating Systems=== * Tra...")
 
Line 1: Line 1:
Once you have registered for an account, you can download Transkribus for free from our [https://transkribus.eu/Transkribus/ website].
+
 
 +
==Download Transkribus===
 +
* Once you have registered for an account, you can download Transkribus for free from our [https://transkribus.eu/Transkribus/ website].
  
 
===Supported Operating Systems===
 
===Supported Operating Systems===

Revision as of 11:24, 24 October 2016

Download Transkribus=

  • Once you have registered for an account, you can download Transkribus for free from our website.

Supported Operating Systems

  • Transkribus is platform independent and will run on Windows, Mac and Linux.
  • Transkribus is written in JAVA. You need to have JAVA 8 or above installed on your computer for Transkribus to work. This should be the case for most computers. Check your Java version!
  • If you need to check your JAVA version: https://java.com/en/download/help/version_manual.xml

Unzip ZIP File

  • After download you will see a ZIP File in the download directory of your computer.
  • Unzip the file before you try to start an executable (.exe) file.

Run Transkribus via an executable file: .exe, .command, .sh

  • Open the Transkribus directory. There you will find the executable files for your operating system.
  • Start Transkribus from your user interface via doubleclick:
    • Windows: Transkribus.bat or use Transkribus.exe
    • Mac OS - Apple: Transkribus.command
    • Linux: Transkribus.sh

Notes for first launch on Windows

  • If you do not have "Administrator" rights, Windows will produce a warning message, such as: Your Computer is Protected by Windows", etc.
  • Do not confirm, but go to "More Information". There you can agree that this is not malware and that you want to run Transkribus on your computer.

Notes for first launch on MAC

  • If you run the program the first time, it may not start because it is a non-signed application ("... can't be opened because it is from an unidentified developer" message)
  • In this case, right-click (or control-click) the application and choose "Open". In the appearing dialog box, click "Open" again!

Run Transkribus via command line

  • Transkribus is contained in the main jar file Transkribus-<version>.jar
  • To run the program from command line type: java -jar Transkribus-<version>.jar
  • Note: Java 8 is needed to run the program. Make sure Java 8 is either installed system wide or copy a JRE into the program directory!
  • Note: To run the scripts in Mac (or Linux) you may have to make them executable from the command line: (any version before 0.6.8)
    • Mac console basics
    • change into the program folder using 'cd' commands
    • chmod +x Transkribus.command (or chmod +x Transkribus.sh for Linux!)
  • Furthermore you will find several files in the Transkribus package copied to your computer:
    • config.properties can be modified to adjust simple appearance properties
    • virtualKeyboards.xml can be used to specify a set of virtual keyboards
    • logback.xml can be modified to adjust logging properties (for expert users only)
  • The 'libs' subfolder contains the necessary libraries for all platforms. Currently supported are:
    • Windows 32/64 bit
    • Linux 32/64 bit
    • OSX 64 bit

Using a proxy server

  • When the program has started, click on the home menu button on the top left and select "Proxy settings...". In the following dialog you can set the proxy host, port, user name (optional) and password (optional). This is the recommended method for using a proxy server.
  • Alternatively, you can edit the start script (e.g. Transkribus.bat on Windows, Transkribus.sh on Linux) to include the environment variables for the proxy server:
   java -Dhttps.proxyHost=<proxyserver>
        -Dhttps.proxyPort=<proxyPort>
        -Dhttps.proxyUser=<user name for proxy>   
        -Dhttps.proxyPassword=<password for proxy>
        -jar Transkribus-0.7.0.jar

However, editing this file will be necessary on each update of Transkribus.

Known Issues

Logging in to the Server is not possible via Transkribus, but on the website it works.

  • Solution: There is a known issue with specific versions of Java 7 (e.g. Java 7u25). You can check your installed version by opening a terminal/command line and entering "java -version". If you encounter this problem, try updating Java on your machine.

Logging in is prevented by the Firewall of your Internet Provider

  • Some IT departments are blocking the SSL port 443 and/or unknown applications via a firewall. Check with your IT department if that might be the case.

Norton Antivirus detects a threat and is blocking the zip file from being unpacked.

  • Solution: This is a false alarm which Norton gives when encountering software it is not familiar with (WS.Reputation.1). You should be able to restore the file from quarantine by following the instructions from the following resource [1].

Versions older or equal than 0.6.5 cannot update (very long error message):

  • Please click on the "Home" button (upper left corner), then "Install a specific version", select the newest version from "Releases" and tick the box beside "Download complete package".
  • Afterwards click on "Update" or "Replace". This way, the complete package is downloaded and the update should work.

Wrong JAVA Version on Mac

  • After opening the command file on the Mac, Transkribus says that there is a wrong Java version installed (1.6.0.65) instead of 1.7. However, there is the most current version of Java RE (1.8.0.66) installed.
    • The problem is that Java 1.6.0.65 is the default Java on the command line which the Transkribus.command uses. You can check the default version by opening the terminal and typing 'java -version'.
    • To solve the problem you can either download the latest jdk as a .tar.gz package from here:
   http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

and unpack it into the Transkribus folder - the Transkribus.command file will automatically check for java installations in its sub directories!

    • Or you could make your java 8 installation the default one on command line following e.g. the instructions here:
   http://myshittycode.com/2014/03/17/mac-os-x-setting-default-java-version/

Transkribus does not start on (Fedora) Linux - 'MOZILLA_FIVE_HOME not set' error message

  • The package "libwebkitgtk" may not be installed. On Fedora you can install the package using dnf on the command line (use "yum" instead of "dnf" in older versions of Fedora):
   sudo dnf install webkitgtk