🚀Quickstart

Get started with serving Bubbaloop serving platform

Setup the project

Windows users are recommeneded to use Windows Subsystems by running wsl.exe --install Ubuntu-22.04 on a Powershell.

You may need to install rust if you have not.

1

Download the project

git clone https://github.com/kornia/bubbaloop.git

2

Install pre-requisites

you need to install cargo in order to fetch and build necessary packages. If you don't have cargo, you can install it by following the instructions on the official Rust website.

Install justfile: https://github.com/casey/just?tab=readme-ov-file#linux

3

Install Dependencies

To get started, ensure all necessary system dependencies

just install_deps

Serve in local

Launch the server via the terminal; it defaults to listening on 0.0.0.0:3000

just serve

You might observe something like this:

[2025-01-04T23:14:46Z INFO bubbaloop::api] 🚀 Starting the server
[2025-01-04T23:14:46Z INFO bubbaloop::api] 🔥 Listening on: 0.0.0.0:3000
[2025-01-04T23:14:46Z INFO bubbaloop::api] 🔧 Press Ctrl+C to stop the server

Serve remotely

Repeat the process about in a remote machine (e.g. in Nvidia Jetson) and give a HOSTand an IP to serve remotely.

just serve 192.168.1.154 3000

Use the Rust CLI 🦀

just help

Usage: bubbaloop [-h <host>] [-p <port>] <command> [<args>]

Bubbaloop CLI

Options:
  -h, --host        the host to listen on
  -p, --port        the port to listen on
  --help, help      display usage information

Commands:
  compute           Execute local routines on the server
  pipeline          Pipeline management commands
  stats             Get stats about the server