Skip to content

Commit

Permalink
Update Installation.md for JabRef 5.x
Browse files Browse the repository at this point in the history
  • Loading branch information
@koppor
koppor authored Aug 25, 2019
1 parent efd8e9a commit 91d18b6
Showing 1 changed file with 58 additions and 47 deletions.
105 changes: 58 additions & 47 deletions en/Installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Installation
helpCategories:
- General
---

# Installation

This page describes how to install Java, which is required for JabRef.
Expand All @@ -15,31 +16,39 @@ You can also install it manually as described here.
The installation steps are written having the [JavaFX development branch](https://builds.jabref.org/javafx/) in mind.
Thus, it especially describes installing [JavaFX].

## Table of Contents

<!-- toc -->

- [Supported JDKs and JREs](#supported-jdks-and-jres)
- [JabRef 5.x](#jabref-5x)
- [JabRef 4.x](#jabref-4x)
- [Verify Java Installation](#verify-java-installation)
- [Installation Commands](#installation-commands)
* [Ubuntu and Oracle Java](#ubuntu-and-oracle-java)
* [Ubuntu 16.04 and OpenJDK](#ubuntu-1604-and-openjdk)
* [Debian Jessie 8 and Oracle Java](#debian-jessie-8-and-oracle-java)
+ [Using the ppa](#using-the-ppa)
+ [Directly from Oracle](#directly-from-oracle)
* [Fedora 23 and Oracle Java](#fedora-23-and-oracle-java)
* [Fedora and OpenJDK](#fedora-and-openjdk)
* [CentOS 6 or 7 and Oracle Java](#centos-6-or-7-and-oracle-java)
* [openSUSE](#opensuse)
* [Arch and Manjaro](#arch-and-manjaro)
* [Windows and Oracle Java](#windows-and-oracle-java)
* [Mac OS and Oracle Java](#mac-os-and-oracle-java)
- [JabRef 5.x](#jabref-5x-1)
- [Ubuntu](#ubuntu)
- [JabRef 4.x](#jabref-4x-1)
- [Ubuntu and Oracle Java](#ubuntu-and-oracle-java)
- [Ubuntu and OpenJDK](#ubuntu-and-openjdk)
- [Debian Jessie 8 and Oracle Java](#debian-jessie-8-and-oracle-java)
- [Using the ppa](#using-the-ppa)
- [Directly from Oracle](#directly-from-oracle)
- [Fedora 23 and Oracle Java](#fedora-23-and-oracle-java)
- [Fedora and OpenJDK](#fedora-and-openjdk)
- [CentOS 6 or 7 and Oracle Java](#centos-6-or-7-and-oracle-java)
- [openSUSE](#opensuse)
- [Arch and Manjaro](#arch-and-manjaro)
- [Windows and Oracle Java](#windows-and-oracle-java)
- [Mac OS and Oracle Java](#mac-os-and-oracle-java)
- [Freezes when running JabRef](#freezes-when-running-jabref)
- [JabRef and OpenOffice/LibreOffice integration](#jabref-and-openofficelibreoffice-integration)

<!-- tocstop -->

## Supported JDKs and JREs

### JabRef 5.x

> JabRef 5.x requires JRE 11
### JabRef 4.x

> JabRef 4.x requires JRE 8 (and does not run at JRE 9 onwoards)
JavaFX is not included in every Java runtime environment or development kit.
Therefore, we highly recommend to use [Oracle Java 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
JavaFX is included since Java 1.8.0_60.
Expand All @@ -49,7 +58,6 @@ Therefore, we only recommend this if you know what you are doing.
In case you want to use OpenJDK with OpenJFX in general you should follow this [instructions](https://wiki.openjdk.java.net/display/OpenJFX/Building+OpenJFX).
For Ubuntu 16.04 LTS and 18.04 LTS head to the section [Installation Commands](#installation-commands).


## Verify Java Installation

In case you already have a Java version installed - or you closely followed the steps below, you can check your Java version by typing the following command into your command line interface:
Expand All @@ -68,45 +76,52 @@ Your Java version should look like this, depending on your operating system and
**Oracle Java 32-Bit:**

```
Java version "1.8.0_x"
Java version "1.8.0_x"
Java(TM) SE Runtime Environment (build 1.8.x)
Java HotSpot(TM) Client VM (build 25.x, mixed mode)
```


**Oracle Java 64-Bit:**

```
Java version "1.8.0_x"
Java version "1.8.0_x"
Java(TM) SE Runtime Environment (build 1.8.x)
Java HotSpot(TM) 64-Bit Server VM (build 25.x, mixed mode)
```


**OpenJDK 32-Bit:**

```
OpenJDK version "1.8.0_x"
OpenJDK version "1.8.0_x"
OpenJDK Runtime Environment (build 1.8.0_x)
OpenJDK Client VM (build 25.x, mixed mode)
```


**OpenJDK 64-Bit:**

```
OpenJDK version "1.8.0_x"
OpenJDK version "1.8.0_x"
OpenJDK Runtime Environment (build 1.8.0_x)
OpenJDK 64-Bit Server VM (build 25.x, mixed mode)
```

If this does not report to be a product from Oracle (for instance tells you that it is a GCJ VM) even if you have installed the Oracle JVM then you need to change your setup.
In the following, the installation is documented for Ubuntu, Debian, Fedora, CentOS, Windows, and MacOSX.


## Installation Commands

### Ubuntu and Oracle Java
### JabRef 5.x

#### Ubuntu

1. Follow the steps at https://bell-sw.com/pages/liberica_install_guide-11.0.4/#apt-repository-deb-based-linux-distributions
2. Ensure that gtk3 is available: `sudo apt-get install gtkterm`

Now, you should be able to execute `java -jar JabRef--master--latest.jar`

### JabRef 4.x

#### Ubuntu and Oracle Java

This applies for both 32bit and 64bit and both Ubuntu 14.04 LTS, 16.04 LTS and 18.04 LTS.

Expand All @@ -118,21 +133,21 @@ Install Oracle JDK with "personal packages archiv (ppa)" which includes an autom

If you want to install JRE or install java without ppa you should follow these [instructions](https://help.ubuntu.com/community/Java).

### Ubuntu and OpenJDK
#### Ubuntu and OpenJDK

Just install JavaFX by executing `sudo apt-get install openjfx`.

For Ubuntu 18.04 and newer, `openjfx` [uses the Java version 11](https://github.com/JabRef/help.jabref.org/issues/204) which is currently not supported by JabRef. Hence, use an older version:
1) If you accidently installed the new version, remove it with `sudo apt purge openjfx`.
2) Install an older version with `sudo apt install openjfx=8u161-b12-1ubuntu2 libopenjfx-jni=8u161-b12-1ubuntu2 libopenjfx-java=8u161-b12-1ubuntu2`.
3) To prevent the software updater from installing the newer not supported version, mark it to be not updated with `sudo apt-mark hold openjfx libopenjfx-jni libopenjfx-java`.

This also works for Linux Mint 19.1 Tessa which is based on Ubuntu 18.04.
1. If you accidently installed the new version, remove it with `sudo apt purge openjfx`.
2. Install an older version with `sudo apt install openjfx=8u161-b12-1ubuntu2 libopenjfx-jni=8u161-b12-1ubuntu2 libopenjfx-java=8u161-b12-1ubuntu2`.
3. To prevent the software updater from installing the newer not supported version, mark it to be not updated with `sudo apt-mark hold openjfx libopenjfx-jni libopenjfx-java`.

This also works for Linux Mint 19.1 Tessa which is based on Ubuntu 18.04.

### Debian Jessie 8 and Oracle Java
#### Debian Jessie 8 and Oracle Java

#### Using the ppa
##### Using the ppa

1. Add repository: `sudo sh -c 'echo "deb http://ppa.launchpad.net/webupd8team/java/ubuntu trusty main" >> /etc/apt/sources.list'`
2. Add GPG key: `sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys EEA14886`
Expand All @@ -141,16 +156,15 @@ This also works for Linux Mint 19.1 Tessa which is based on Ubuntu 18.04.

Based on: <http://tecadmin.net/install-java-8-on-debian/>

#### Directly from Oracle
##### Directly from Oracle

1. Download tag.gz-file from the [Java SE Development Kit 8 Downloads] site
2. Navigate to the folder where you downloaded the tar.gz-file
3. Create package with `make-jpkg jdk-[Version]-linux-x64.tar.gz` including the most recent Java version instead of`[Version]`
4. Get root access with `su`
5. Install with `dpkg -i oracle-java8-jdk_[Version].deb`


### Fedora 23 and Oracle Java
#### Fedora 23 and Oracle Java

1. Download rpm-file from the [Java SE Development Kit 8 Downloads] site
2. Navigate to the folder where you downloaded the rpm-file
Expand All @@ -160,7 +174,7 @@ Based on: <http://tecadmin.net/install-java-8-on-debian/>

Recent JabRef builds are available at <https://build.opensuse.org/package/show/home:cornell_vrdc/jabref3>.

### Fedora and OpenJDK
#### Fedora and OpenJDK

1. Install OpenJDK: `sudo dnf install java-1.8.0-openjdk`
2. Install JavaFX (actually OpenJFX): `sudo dnf install openjfx java-1.8.0-openjdk-openjfx`
Expand All @@ -171,19 +185,19 @@ Recent JabRef builds are available at <https://build.opensuse.org/package/show/h
*Warning*: There is a [bug](https://bugzilla.redhat.com/show_bug.cgi?id=1547378) in `openjfx` in Fedora 29.
JabRef versions newer than 4.3.1 will not work with OpenJDK and Fedora 29 until this is fixed. See also [issue 4473](https://github.com/JabRef/jabref/issues/4473).

### CentOS 6 or 7 and Oracle Java
#### CentOS 6 or 7 and Oracle Java

1. Download rpm-file from the [Java SE Development Kit 8 Downloads] site
2. Install with `sudo yum localinstall jre-[Version]-linux-[BIT].rpm` include the most recent Java version for `[Version]` and `i586` or `x64` for `[BIT]` depending on your OS version

### openSUSE
#### openSUSE

The necessary Java packages can be installed via "1-click installs":

1. [OpenJDK](https://software.opensuse.org/package/java-1_8_0-openjdk)
2. [java-openjfx](https://software.opensuse.org/package/java-1_8_0-openjfx)

### Arch and Manjaro ###
#### Arch and Manjaro

Two packages are available in the [Arch User Repository (AUR)](https://aur.archlinux.org/):

Expand All @@ -192,8 +206,7 @@ Two packages are available in the [Arch User Repository (AUR)](https://aur.archl

Both packages install precompiled jar files and add a command and a .desktop file to the OS.


### Windows and Oracle Java
#### Windows and Oracle Java

The "modern" way:

Expand All @@ -207,8 +220,7 @@ The "old" way:
1. Download exe file from the [Java SE Development Kit 8 Downloads] site
2. Run installation wizzard


### Mac OS and Oracle Java
#### Mac OS and Oracle Java

1. Download dmg-file from the [Java SE Development Kit 8 Downloads] site
2. Run installation wizzard
Expand All @@ -227,4 +239,3 @@ For Linux you have to install the package `libreoffice-java-common`.

[Java SE Development Kit 8 Downloads]: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
[JavaFX]: https://en.wikipedia.org/wiki/JavaFX

0 comments on commit 91d18b6

Please sign in to comment.