Quick Start

Get LLrdc running on your machine in seconds.

Requirements

Ensure you have the following installed on your system before proceeding:

• Docker: Used to run the isolated Ubuntu 24.04 and XFCE4 environment.
• Git: Required to clone the repository.
• NVIDIA Container Toolkit (Optional): Required only if you plan to use an NVIDIA GPU for hardware-accelerated video encoding (NVENC). Get it here.

Installation Steps

Follow these simple steps to build and run the container:

Terminal

# 1. Clone the repository
git clone https://github.com/danchitnis/LLrdc.git
cd LLrdc

# 2. Build the Docker image
./docker-build.sh

# 3. Start the container
./docker-run.sh

# If you have an NVIDIA GPU and the NVIDIA Container Toolkit installed,
# you can enable hardware acceleration (H.264/AV1 NVENC):
# ./docker-run.sh --gpu

# For specific network interfaces (e.g., Tailscale or Ethernet):
# ./docker-run.sh -i tailscale0
# ./docker-run.sh -i eth0

# 4. Open http://localhost:8080

Once the container is running, open your favorite modern web browser and navigate to http://localhost:8080 to access your desktop.