Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/juice/troubleshooting/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,16 @@ To connect to a remote GPU from an application that you are running through juic

Check your Endpoint Security or Antivirus. If you see any warnings about blocked DLLs or executables, add an exception for **C:\Program Files\Juice GPU\juice**. If you are unable to do so, please contact your IT administrator.

For Linux one-step installer failures (`curl https://get.juicelabs.co | ... sh -`), check:
- Your M2M token is set in `INSTALL_JUICE_TOKEN` and is valid.
- If you set `INSTALL_JUICE_CONTROLLER`, it points to the correct controller hostname.
- `glibc` is version 2.27 or newer (`ldd --version`).
- Required libraries are installed:
- Client: `libatomic`, `libnuma`
- Agent hosting (when `INSTALL_JUICE_POOL` is set): `libvulkan`, `libGL`, `libnvidia-encode`

If `INSTALL_JUICE_POOL` is omitted, the installer only installs binaries and does not create/start the agent service. This is expected behavior.

### My agent failed to start.

Check to see if you're already running an agent.
46 changes: 46 additions & 0 deletions docs/juice/user-guide/setup/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,52 @@ Log in to [app.juicelabs.co](https://app.juicelabs.co):

...replacing `juice_linux_release` with the filename of the downloaded archive.

### Linux One-Step Installer (Optional)

For Linux systems using `systemd` or `openrc`, you can install with the hosted installer script:

```bash
curl https://get.juicelabs.co | \
INSTALL_JUICE_TOKEN=<m2m-token> \
INSTALL_JUICE_POOL=<pool-id-or-name> \
sh -
```

#### Installer Environment Variables

- `INSTALL_JUICE_TOKEN` (required): M2M token used for authentication.
- `INSTALL_JUICE_POOL` (optional): If provided, the installer creates and configures the agent service for that pool.
- `INSTALL_JUICE_CONTROLLER` (optional): Overrides the default controller host (`electra.juicelabs.co`).

#### Common Usage Modes

Install client binaries only (no service installed):

```bash
curl https://get.juicelabs.co | \
INSTALL_JUICE_TOKEN=<m2m-token> \
sh -
```

Install and register the agent service to a specific pool:

```bash
curl https://get.juicelabs.co | \
INSTALL_JUICE_TOKEN=<m2m-token> \
INSTALL_JUICE_POOL=<pool-id-or-name> \
sh -
```

Install against a non-default controller:

```bash
curl https://get.juicelabs.co | \
INSTALL_JUICE_TOKEN=<m2m-token> \
INSTALL_JUICE_CONTROLLER=<controller-hostname> \
INSTALL_JUICE_POOL=<pool-id-or-name> \
sh -
```

## (Optional) Adding juice to PATH

#### To enable your system to run `juice` from any directory:
Expand Down
5 changes: 5 additions & 0 deletions docs/juice/user-guide/setup/systerm-reqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ Both the **Client** and **GPU Agent** are supported on Windows 10 and Windows 11

The client and GPU agent are supported on Debian-based distributions (version 10 and greater, like Ubuntu 18.04) and Red Hat Enterprise Linux (RHEL) 8-based distributions, such as AlmaLinux 8 or greater. Other distributions with similar or newer release dates are also likely supported.

For the Linux one-step installer (`curl https://get.juicelabs.co | ... sh -`), your system must also have:
- glibc 2.27 or newer
- either `systemd` or `openrc`
- either `curl` or `wget`

:::note
Currently, only the client is supported when running in WSL on Windows.
:::
Expand Down
Loading