3.2. Downloading the LOCKSS Installer

Note

Commands in this section are run as the lockss user 1.

The next task is to download the LOCKSS Installer.

3.2.1. LOCKSS Installer Directory

The LOCKSS Installer will be installed into a directory that will simply be known as the LOCKSS Installer Directory. Many commands in upcoming sections of this manual, such as those to install, configure, start and stop the LOCKSS system, will be listed relative to the LOCKSS Installer Directory.

By default, the LOCKSS Installer Directory is a directory named lockss-installer in the lockss user's home directory.

3.2.2. Running the LOCKSS Downloader

To install the LOCKSS Installer, you will use curl or wget 2 to invoke the LOCKSS Downloader 3. (Alternatively, for security purposes, you can download and inspect the LOCKSS Downloader before executing it manually 5.)

As the lockss user 1, run either this curl command:

curl -sSfL https://lockss.org/downloader | sh -s -

or this wget command:

wget -qO- https://lockss.org/downloader | sh -s -

You can add options after | sh -s -:

If you need your LOCKSS Installer Directory to be a directory DIR other than the default, add --download-dir=DIR (or alternatively -d DIR) after | sh -s -, like so:
```
... | sh -s - --download-dir=DIR
```
and the LOCKSS Installer will be installed into the custom LOCKSS Installer Directory DIR.
(Advanced uses only.) If you have a reason to install a version of the LOCKSS Installer other than the latest stable release, you can do so by making references to the lockss-installer Git repository on GitHub 4:
- You can install a version labeled by the Git tag TAG (e.g. version-2.0.61-alpha6) by adding --git-tag=TAG (or -t TAG).
- You can install a version from the tip of a Git branch BRA (e.g. develop) by adding --git-branch=BRA (or -b BRA).
- You can even install a version as of a specific Git commit identifier COM by adding --git-commit=COM (or -c COM).
The LOCKSS Downloader accepts other options after | sh -s -; you can list them by adding --help (or -h) after | sh -s -.

Footnotes

1

See Running Commands as the lockss User.

2

Most typical Linux systems have at least one of curl or wget installed by default. You can check by typing curl --version or wget --version and verifying that the output is not an error message. If you need to install curl, see Installing curl. If you prefer to install wget, see Installing wget.

3

See https://github.com/lockss/lockss-downloader.

4

See https://github.com/lockss/lockss-installer.

5

For security purposes, you may wish to inspect the LOCKSS Downloader before executing it.

One option is to review the contents of the script directly on GitHub to your satisfaction, then execute it as described above. The URL https://lockss.org/downloader redirects to https://github.com/lockss/lockss-downloader/raw/main/lockss-downloader.

Another option is to download a copy of the LOCKSS Downloader, review the lockss-downloader script, then execute it, all locally. To do so, follow this procedure:

Run either:

curl -Lo /tmp/lockss-downloader https://lockss.org/downloader

or:

wget -O /tmp/lockss-downloader https://lockss.org/downloader

to download the lockss-downloader script to /tmp/lockss-downloader.

Inspect /tmp/lockss-downloader to your satisfaction.
Run this command:
```
chmod +x /tmp/lockss-downloader
```
to make /tmp/lockss-downloader executable.
Type:
```
/tmp/lockss-downloader
```
to run the lockss-downloader script, appending options like --download-dir=DIR to the end as desired.