Skip to content

Commit 237fef9

Browse files
dromagnoliaaime
authored andcommitted
Updating TurboJpeg plugin to use OpenMicroscopy bindings
1 parent 36cb431 commit 237fef9

2 files changed

Lines changed: 25 additions & 25 deletions

File tree

doc/en/user/extensions/libjpeg-turbo/index.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,26 @@ The module, once installed, replaces the standard JPEG encoder for GeoServer and
1818
!!! note
1919
This module depends on a successful installation of the libjpeg-turbo native libraries described in the next section.
2020

21+
## Installing the GeoServer libjpeg-turbo extension
22+
23+
1. Login, and navigate to **About & Status > About GeoServer** and check **Build Information** to determine the exact version of GeoServer you are running.
24+
25+
2. Visit the [website download](https://geoserver.org/download) page, change the **Archive** tab, and locate your release.
26+
27+
From the list of **Output Formats** extensions download **JPEG Turbo**.
28+
29+
- {{ release }} example: [libjpeg-turbo](https://sourceforge.net/projects/geoserver/files/GeoServer/{{ release }}/extensions/geoserver-{{ release }}-libjpeg-turbo-plugin.zip)
30+
- {{ snapshot }} example: [libjpeg-turbo](https://build.geoserver.org/geoserver/main/ext-latest/geoserver-{{ snapshot }}-libjpeg-turbo-plugin.zip)
31+
32+
Verify that the version number in the filename corresponds to the version of GeoServer you are running (for example {{ release }} above).
33+
34+
3. Extract the contents of the archive into the **`WEB-INF/lib`** directory of the GeoServer installation.
35+
2136
## Installing the libjpeg-turbo native library
2237

23-
Installing the libjpeg-turbo native library is a precondition to have the relative GeoServer Map Encoder properly installed; once the GeoServer extension has been installed as we explain in the following section, the needed JARs with the Java bridge to the library are in the classpath, therefore all we need to do is to install the native library itself to start encoding JPEG at turbo speed.
38+
Installing the libjpeg-turbo native library is a prerequisite for properly enabling the corresponding GeoServer Map Encoder. Once the GeoServer extension is installed, the required JARs providing the Java bindings to the native library are already available on the classpath.
39+
40+
The turbojpeg-X.X.X.jar bundle (at the time of writing, turbojpeg-8.5.0.jar), included in the libjpeg-turbo-plugin.zip, also contains the necessary native libraries. Therefore, the only remaining step is to install the native library itself to enable high-performance JPEG encoding.
2441

2542
1. Linux users may also check if it is available from their package manager:
2643

@@ -31,37 +48,20 @@ Installing the libjpeg-turbo native library is a precondition to have the relati
3148

3249
To perform the installation of the libjpeg-turbo binaries (or native library) you have to perform the following steps:
3350

34-
1. Go to the download site [here](https://sourceforge.net/projects/libjpeg-turbo/files/) and download the latest available stable release (1.2.90 at the time of writing).
35-
2. Select the package that matches the target platform in terms of Operating System (e.g. Linux rather than Windows) and Architecture (32 vs 64 bits).
36-
3. Perform the installation using the target platform conventions. As an instance for Windows you should be using an installer that installs all the needed libs in a location at user's choice. On Ubuntu Linux systems you can use the *deb* files instead.
37-
4. Once the native libraries are installed, you have to make sure the GeoServer can load them. This should happen automatically after Step 2 on Linux, while on Windows you should make sure that the location where you placed the DLLs is part of the PATH environment variable for the Java Process for the GeoServer.
51+
1. Extract the turbojpeg-X.X.X.jar file (located in the WEB-INF/lib directory of your GeoServer installation) into a temporary folder.
3852

39-
!!! warning
53+
2. Navigate to the META-INF/lib directory and select the package that matches your target platform, considering both the operating system (e.g., Linux or Windows) and the architecture (32-bit or 64-bit).
54+
3. Copy the required native library (e.g., turbojpeg.dll for Windows or turbojpeg.so for Linux) to a location included in the Java process’s native library path for GeoServer. See the **Notes** below for further details.
55+
56+
!!! note
4057
When installing on Windows, always make sure that the location where you placed the DLLs is part of the `PATH` environment variable for the Java Process for the GeoServer. This usually means that you have to add such location to the PATH environmental variable for the user that is used to run GeoServer or the system wide variables.
4158

42-
!!! warning
59+
!!! note
4360
When installing on Linux, make sure that the location where you placed the DLLs is part of the `LD_LIBRARY_PATH` environment variable for the Java Process for the GeoServer. This usually happens automatically for the various Linux packages, but in some cases you might be forced to do that manually
4461

4562
!!! note
4663
It does not hurt to add also the location where the native libraries are installed to the Java startup options `-Djava.library.path=<absolute_and_valid_path>`.
4764

48-
## Installing the GeoServer libjpeg-turbo extension
49-
50-
!!! warning
51-
Before moving on make sure you installed the libjpeg-turbo binaries as per the section above.
52-
53-
1. Login, and navigate to **About & Status > About GeoServer** and check **Build Information** to determine the exact version of GeoServer you are running.
54-
55-
2. Visit the [website download](https://geoserver.org/download) page, change the **Archive** tab, and locate your release.
56-
57-
From the list of **Output Formats** extensions download **JPEG Turbo**.
58-
59-
- {{ release }} example: [libjpeg-turbo](https://sourceforge.net/projects/geoserver/files/GeoServer/{{ release }}/extensions/geoserver-{{ release }}-libjpeg-turbo-plugin.zip)
60-
- {{ snapshot }} example: [libjpeg-turbo](https://build.geoserver.org/geoserver/main/ext-latest/geoserver-{{ snapshot }}-libjpeg-turbo-plugin.zip)
61-
62-
Verify that the version number in the filename corresponds to the version of GeoServer you are running (for example {{ release }} above).
63-
64-
3. Extract the contents of the archive into the **`WEB-INF/lib`** directory of the GeoServer installation.
6565

6666
## Checking if the extension is enabled
6767

src/release/ext-libjpeg-turbo.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<includes>
1212
<include>gs-libjpeg-turbo*.jar</include>
1313
<include>*imageio-ext-turbojpeg*.jar</include>
14-
<include>*turbojpeg-wrapper-*.jar</include>
14+
<include>turbojpeg*.jar</include>
1515
</includes>
1616
</fileSet>
1717
<fileSet>

0 commit comments

Comments
 (0)