First steps after installation#

After installing OrangeQS Juice, a basic configuration is applied to get you started quickly. This guide covers the two things you need before you can start using it: reaching the web interface, and making your own code available to it.

Accessing the Juice interface#

From the computer where you installed Juice, navigate to http://localhost:8888 in the web browser to access the web interface.

Accessing from other computers (optional). An easy way to access the Juice interface from other computers on your network is to set up an SSH tunnel. This requires SSH access to the computer where Juice is installed. If you normally login remotely over SSH using ssh <user>@<host>, you can create the tunnel with the following command from your remote computer:

ssh -L 8888:localhost:8888 <user>@<host>

This will forward your local port 8888 to the remote host’s port 8888. Now you can navigate to http://localhost:8888 on your local machine to access the Juice interface running on the remote host.

Setting up a HTTPS reverse proxy (optional). If you want to permanently and publicly access your Juice interface, it is recommended to set up a HTTPS reverse proxy. There are different ways to do this, below we have listed a few options:

  • Caddy. Simple web server with automatic HTTPS support. Requires a public IP address.

  • Cloudflare Tunnel. Useful if you are in a constrained network and do not have a public IP address.

Installing Juice extensions and Python packages#

Each user and service already has the lab repository installed — an editable Python package at ~/shared/lib/lab, meant as the place to add your own code and dependencies. Add a package by listing it in ~/shared/lib/lab/pyproject.toml’s project.dependencies, then reinstall it:

[project]
dependencies = [
    "orangeqs-juice-core",
    "numpy",  # <- your package here
]

uv pip install -e .  # from ~/shared/lib/lab

See Lab repository for the full guide to the lab repository, and Installing a package in editable mode for developing a package outside of it in editable mode.

Administering a shared installation?

Adding users, registering services, provisioning InfluxDB buckets, and installing a package for every user and service system-wide are all covered in System configuration.