Skip to content

Installation script

Ralf Kilian edited this page Apr 14, 2021 · 45 revisions

Installation script

Table of contents


General information

This script allows to install or uninstall the project, which is optional and not mandatory in order to use it.

Notice that both processes require superuser privileges.

Details can be found inside the usage_install.txt file in the docs sub-directory of the project.

Top

Verify archive integrity

Since version 1.18.3 there is a checksum file to verify the integrity of the downloaded salomon-release archive. When downloading Salomon from its official repository, verifying the downloaded file is not mandatory.

However, when downloading the archive from a different location, it might have been modified (in a not necessarily negative way), e.g. enhanced with additional color config files or whatever. As with any software, you should check it before running or installing it with superuser privileges.

In order to verify the integrity of the archive you have downloaded, you will need the corresponding checksum file.

Verification example

For example, if you want to verify the file salomon-release-1.18.3.tar.gz, download the checksum file salomon-release-1.18.3.tar.gz.sha256 directly from the assets of the official release.

Then, copy the checksum file into the same directory from the archive and execute the following shell command:

sha256sum -c salomon-release-1.18.3.tar.gz.sha256

In case the archive is identical with the one from the official release, the command will confirm this as follows:

salomon-release-1.18.3.tar.gz: OK

Top

Install Salomon

The project will be installed to /opt/salomon and a symbolic link to its main script will be created in /usr/local/bin by default. If that directory is not part of the path related environment variable, the symbolic link will be created inside /usr/bin instead.

Now, to install, type one of the following commands, depending on the way you prefer.

Either as normal user via sudo

sudo ./install.sh -i

or directly when logged in as root:

./install.sh -i

After installing Salomon, it can simply be run by typing its name in lowercase (without a trailing .sh) followed by the arguments to use. For example:

salomon --help

Top

Uninstall Salomon

To uninstall, type one of the following commands, depending on the way you prefer.

Either as normal user via sudo

sudo ./install.sh -u

or directly when logged in as root:

./install.sh -u

Top