update documentation for java 17 upgrade

This commit is contained in:
Craig Raw 2022-05-23 08:55:13 +02:00
parent a324224e2a
commit b0e1f6fe32
2 changed files with 15 additions and 17 deletions

View file

@ -16,8 +16,8 @@ or for those without SSH credentials:
`git clone --recursive https://github.com/sparrowwallet/sparrow.git` `git clone --recursive https://github.com/sparrowwallet/sparrow.git`
In order to build, Sparrow requires Java 16 to be installed. In order to build, Sparrow requires Java 17 to be installed.
The release binaries are built with [AdoptOpenJdk 16.0.1+9 Hotspot](https://adoptopenjdk.net/archive.html?variant=openjdk16&jvmVariant=hotspot). The release binaries are built with [Eclipse Temurin 17.0.2+8](https://github.com/adoptium/temurin17-binaries/releases/tag/jdk-17.0.2%2B8).
Other packages may also be necessary to build depending on the platform. On Debian/Ubuntu systems: Other packages may also be necessary to build depending on the platform. On Debian/Ubuntu systems:
@ -44,7 +44,7 @@ If you prefer to run Sparrow directly from source, it can be launched from withi
`./sparrow` `./sparrow`
Java 16 or higher must be installed. Java 17 or higher must be installed.
## Configuration ## Configuration

View file

@ -12,32 +12,30 @@ Work on resolving both of these issues is ongoing.
#### Install Java #### Install Java
Because Sparrow bundles a Java runtime in the release binaries, it is essential to have the same version of Java installed when creating the release. Because Sparrow bundles a Java runtime in the release binaries, it is essential to have the same version of Java installed when creating the release.
For v1.5.0 and later, this is AdoptOpenJdk jdk-16.0.1+9 Hotspot. For v1.6.4 and later, this is Eclipse Temurin 17.0.2+8.
It is available for all supported platforms from the [AdoptOpenJdk site](https://adoptopenjdk.net/archive.html?variant=openjdk16&jvmVariant=hotspot). It is available for all supported platforms from [Eclipse Temurin 17.0.2+8](https://github.com/adoptium/temurin17-binaries/releases/tag/jdk-17.0.2%2B8).
For reference, the downloads are as follows: For reference, the downloads are as follows:
- [Linux x64](https://github.com/AdoptOpenJDK/openjdk16-binaries/releases/download/jdk-16.0.1%2B9/OpenJDK16U-jdk_x64_linux_hotspot_16.0.1_9.tar.gz) - [Linux x64](https://github.com/adoptium/temurin17-binaries/releases/download/jdk-17.0.2%2B8/OpenJDK17U-jdk_x64_linux_hotspot_17.0.2_8.tar.gz)
- [MacOS x64](https://github.com/AdoptOpenJDK/openjdk16-binaries/releases/download/jdk-16.0.1%2B9/OpenJDK16U-jdk_x64_mac_hotspot_16.0.1_9.tar.gz) - [MacOS x64](https://github.com/adoptium/temurin17-binaries/releases/download/jdk-17.0.2%2B8/OpenJDK17U-jdk_x64_mac_hotspot_17.0.2_8.tar.gz)
- [Windows x64](https://github.com/AdoptOpenJDK/openjdk16-binaries/releases/download/jdk-16.0.1%2B9/OpenJDK16U-jdk_x64_windows_hotspot_16.0.1_9.zip) - [MacOS aarch64](https://github.com/adoptium/temurin17-binaries/releases/download/jdk-17.0.2%2B8/OpenJDK17U-jdk_aarch64_mac_hotspot_17.0.2_8.tar.gz)
- [Windows x64](https://github.com/adoptium/temurin17-binaries/releases/download/jdk-17.0.2%2B8/OpenJDK17U-jdk_x64_windows_hotspot_17.0.2_8.zip)
It is also possible to install via a package manager on *nix systems. For example, on Debian/Ubuntu systems: It is also possible to install via a package manager on *nix systems. For example, on Debian/Ubuntu systems:
```shell ```shell
sudo apt-get install -y wget apt-transport-https gnupg sudo apt-get install -y wget apt-transport-https gnupg
wget https://adoptopenjdk.jfrog.io/adoptopenjdk/api/gpg/key/public wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
gpg --no-default-keyring --keyring ./adoptopenjdk-keyring.gpg --import public echo "deb https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | sudo tee /etc/apt/sources.list.d/adoptium.list
gpg --no-default-keyring --keyring ./adoptopenjdk-keyring.gpg --export --output adoptopenjdk-archive-keyring.gpg
rm adoptopenjdk-keyring.gpg
sudo mv adoptopenjdk-archive-keyring.gpg /usr/share/keyrings
echo "deb [signed-by=/usr/share/keyrings/adoptopenjdk-archive-keyring.gpg] https://adoptopenjdk.jfrog.io/adoptopenjdk/deb $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/adoptopenjdk.list
sudo apt update -y sudo apt update -y
sudo apt-get install -y adoptopenjdk-16-hotspot=16.0.1+9-3 sudo apt-get install -y temurin-17-jdk=17.0.2+8
sudo update-alternatives --config java
``` ```
A alternative option for all platforms is to use the [sdkman.io](https://sdkman.io/) package manager ([Git Bash for Windows](https://git-scm.com/download/win) is a good choice on that platform). A alternative option for all platforms is to use the [sdkman.io](https://sdkman.io/) package manager ([Git Bash for Windows](https://git-scm.com/download/win) is a good choice on that platform).
See the installation [instructions here](https://sdkman.io/install). See the installation [instructions here](https://sdkman.io/install).
Once installed, run Once installed, run
```shell ```shell
sdk install java 16.0.1.hs-adpt sdk install java 17.0.2-tem
``` ```
#### Other requirements #### Other requirements
@ -51,7 +49,7 @@ sudo apt install -y rpm fakeroot binutils
The project can cloned for a specific release tag as follows: The project can cloned for a specific release tag as follows:
```shell ```shell
GIT_TAG="1.5.2" GIT_TAG="1.6.4"
git clone --recursive --branch "${GIT_TAG}" git@github.com:sparrowwallet/sparrow.git git clone --recursive --branch "${GIT_TAG}" git@github.com:sparrowwallet/sparrow.git
``` ```