Installation#

This section explains how to install a production environment of OrangeQS Juice.

Development environment

This guide covers deploying OrangeQS Juice to a production environment.

For instructions on setting up a development environment, see the Development Environment section.

System Requirements#

Software Requirements#

While OrangeQS Juice is in heavy development it will target AlmaLinux 10 specifically. It is recommended to use this distribution. Although unsupported, you can use any other Linux distribution that matches the following requirements:

Linux operating system managed by systemd.
Root access.
The systemctl command available.
Podman version >=4.4.0 installed.
Either telegraf is installed, or your system uses the dnf package manager

Hardware Requirements#

While not a strict requirement, we also strongly recommend using an SSD for your OS partition for a good experience.

Initial Setup#

Ensure you are running AlmaLinux 10 and logged in as root.
Due to an issue with environment handling, SELinux must be set to permissive mode before installing OrangeQS Juice
Install jq.
```
dnf install jq
```

Install the script to download the latest version of OrangeQS Juice:

curl --fail "https://gitlab.com/orangeqs/juice/-/raw/main/packaging/download-latest-proxy.sh" > /bin/juice-download-latest && chmod +x /bin/juice-download-latest

The script is available at /bin/juice-download-latest. Verify its contents using:
```
cat /bin/juice-download-latest
```

Installation#

To install OrangeQS Juice, follow these steps:

Ensure you are logged in as root.
Install the latest version of the OrangeQS Juice system package:
```
dnf install $(juice-download-latest)
```
Install system services and configurations: Depending on the speed of your hard drive and network, this might take up to 30 minutes as it has to build multiple container images.
```
juice install
```
Improving installation time on hard-drives

The Juice installation has to build several Docker images. For installing Juice on a hard-drive, it’s recommended to use the --no-parallel-build option to build these images sequentially. This is usually faster, as it reduces the amount of random access on the hard-drive.
```
juice install --no-parallel-build
```
This option is not recommended for SSDs.
You can now access the JupyterHub interface at http://localhost:8888. You can login with any user configured on the host unix system.

Updating#

Updating OrangeQS Juice is similar to the installation process.

Ensure you are logged in as root.
Install the latest beta version of the OrangeQS Juice system package:
```
dnf install $(juice-download-latest)
```
Update configurations, rebuild, and restart all services Be advised that this will restart all components of OrangeQS Juice. Depending on the speed of your hard drive and network, this might take up to 30 minutes as it has to build multiple container images.
```
juice install --rebuild --restart
```
Improving update time on hard-drives

The Juice update has to build several Docker images. If you have installed Juice on a hard-drive, it’s recommended to use the --no-parallel-build option to build these images sequentially. This is usually faster, as it reduces the amount of random access on the hard-drive.
```
juice install --rebuild --restart --no-parallel-build
```
This option is not recommended for SSDs.

What’s next?#

Continue to First steps after installation for more information on accessing the Juice interface and performing common configurations.