Differences

This shows you the differences between two versions of the page.

--- 02_user_tutorials:00_installation:01_from_executable [2025/04/03 15:12] – created gaetan
+++ 02_user_tutorials:00_installation:01_from_executable [2025/11/01 02:50] (current) – gaetan
@@ Line 1: / Line 1: @@
-====== From executable ======
+====== Install with executable file ======
+The easiest way to install GroIMP is to run an executable file. The executable file is downloadable on the grogra website. It can then be executed like many common installer file by double clicking on it. This trigger the installation of the software. The file will also automatically create a shortcut.
+===== Requirements =====
-====== Requirements ======
-GroIMP is
+GroIMP is written in Java, which means it should follow Java's WORA-principle (Write Once, Run
-written in Java, which means it should follow Java's WORA-principle (Write Once, Run
 Anywhere) and should run on every Java-capable platform. GroIMP has been tested
-successfully on Unix and  Windows platforms.
+successfully on Mac, Linux and  Windows platforms.
-GroIMP 2.1.7 requires
+GroIMP 2.2 requires the installation of a **Java runtime environment of version 21**. This
-the installation of a  Java runtime environment of version 17. This
+can be obtained from Oracle at [[https://www.oracle.com/de/java/technologies/downloads/#java21]].
-can be obtained from Oracle at [[https://www.oracle.com/|www.oracle.com]].
-For a reasonably
+For a reasonably performant runtime behaviour, at least 256 MB RAM and a 1 GHz processor are
-performant runtime behavior, at least 256 MB RAM and a 1 GHz processor are
 recommended.
-====== Download ======
-The binary distribution of GroIMP is available on the [[https://gitlab.com/grogra/groimp/-/releases|gitlab release section]] as a zip-file, windows exe, or debian release.
+===== Download =====
+GroIMP installation executable are available on the [[https://download.grogra.de/|grogra website]] and on the [[https://gitlab.com/grogra/groimp/-/releases|gitlab release section]] as a zip-file, windows exe, or debian release.
+===== Run the installation =====
+==== Windows ====
+The windows exe is an executable file that will extract and install GroIMP on your computer.
+While you are downloading the file you might get some warning from your web browser that the software is not certified by Microsoft. Please ignore this warning, as we neither had the funding nor the time to go through the certification process.
+Please double click on the downloaded file (make sure you have administrator rights on your machine for installation), and follow the instructions one by one:
+{{:tutorials:beginnerstut_image4.png?293x204}} {{:tutorials:beginnerstut_image5.png?295x202}}
+Normally, click on ‘I Agree’, then on ‘Next’. Choose the destination folder, then the maximum heap size for Java. This allocates a certain amount of RAM (random access memory) to the Java Virtual Machine on which GroIMP is running. By default, 1500 MB are allocated, but you can allocate up to 50 per cent of the RAM available on your machine to Java, without any problem (so on a machine with 10 GB RAM you can enter 5000):\\
+{{:tutorials:beginnerstut_image6.png?284x193}} {{:tutorials:beginnerstut_image7.png?282x192}}
+After this you click on ‘Install’ and wait for the installation to finish (this can take more than ten minutes).
+After the installation, a folder “GroIMP-2.2” should be available under something like this address: “C:\Program Files\”.
+GroIMP will now be available either on your desktop or in the list of programmes:
+{{:tutorials:beginnerstut_image8.png?82x73}}
+==== Mac OS ====
+Mac users need to download the zip-file, extract it and run GroIMP from the command line.
+The directory structure of the zip-file has to be preserved, check
+that your zip program is set up accordingly (and does not extract all files
+into one  and the same directory).
+After extraction of the zip-file, the following files, amongst others, are present in the installation
+directory:
+`README`
+This plain text file contains additional information about the GroIMP distribution. Please read it
+carefully.
+`INSTALL`
+This plain text file contains  instructions for the installation of the GroIMP
+distribution, legal notices and other information. Please read it carefully. If you
+have trouble with the installation procedure described in this manual, please consult
+the file `INSTALL` for a solution.
+`plugins`
+This directory contains all the plugins that are part of the binary distribution of
+GroIMP.
+`core.jar`
+This file is an executable java archive and the entry-point for the Java runtime
+environment to start the GroIMP application.
+==== Ubuntu & Debian ====
+The .deb file is an executable file that will extract and install GroIMP on your computer.
+In most modern Ubuntu systems you can just click on the downloaded deb file and it will open the package manager which allows you to install the software.
+If this is not possible you can use ''sudo dpkg -i /path/to/groimp.deb'' in a command line.
+=== Increasing heap space on Linux ===
+If you want to start GroIMP with additional heap space you can do so from the command line:
+<code>
+groimp -Xmx Xmx5G
+</code>
+==== Others ====
+As a java software it is possible to execute GroIMP on any system that can run a java virtual machine of version 21. This includes almost any version of Linux as well as some other systems.
+For this case we provide an archive with the compiled jar on the Gitlab release page.
+This can then be executed with java -jar core.jar