Skip to content
UnboundBytes

Installation

Installation Guide

Section titled “Installation Guide”

This guide covers detailed installation instructions for all UnboundBytes components.

TypeScript SDK

Section titled “TypeScript SDK”

The TypeScript SDK is the recommended way to interact with the UnboundBytes API from Node.js and browser applications.

Requirements

Section titled “Requirements”
  • Node.js 20.x or later
  • TypeScript 5.x (optional, but recommended)

Package Managers

Section titled “Package Managers”
Terminal window
npm install @unboundbytes/sdk

TypeScript Configuration

Section titled “TypeScript Configuration”

If using TypeScript, ensure your tsconfig.json has the following settings:

{
  "compilerOptions": {
    "moduleResolution": "bundler",
    "module": "ES2022",
    "target": "ES2022",
    "strict": true
  }
}

Verify Installation

Section titled “Verify Installation”
import { UnboundBytesClient } from '@unboundbytes/sdk';


const client = new UnboundBytesClient({
  auth: { type: 'bearer', token: 'test' }
});


console.log('SDK installed successfully!');

Agent Installation

Section titled “Agent Installation”

The UnboundBytes Agent is a lightweight Rust daemon that runs on your infrastructure.

System Requirements

Section titled “System Requirements”
  • Linux (Debian/Ubuntu, RHEL/CentOS, or compatible)
  • 64-bit architecture (x86_64 or aarch64)
  • Docker or Podman runtime
  • Network connectivity to the orchestrator

Quick Install

Section titled “Quick Install”
Terminal window
curl -sSL https://get.unboundbytes.com/agent | bash

Manual Installation

Section titled “Manual Installation”

  1. Download the agent binary

    Terminal window
    # For x86_64
    curl -LO https://releases.unboundbytes.com/agent/latest/unboundbytes-agent-linux-x86_64.tar.gz
    

    # For ARM64
    curl -LO https://releases.unboundbytes.com/agent/latest/unboundbytes-agent-linux-aarch64.tar.gz

  2. Extract and install

    Terminal window
    tar -xzf unboundbytes-agent-*.tar.gz
    sudo mv unboundbytes-agent /usr/local/bin/
    sudo chmod +x /usr/local/bin/unboundbytes-agent

  3. Create configuration directory

    Terminal window
    sudo mkdir -p /etc/unboundbytes

  4. Create systemd service

    Terminal window
    sudo tee /etc/systemd/system/unboundbytes-agent.service << 'EOF'
    [Unit]
    Description=UnboundBytes Agent
    After=network.target docker.service
    Wants=docker.service
    

    [Service]
    Type=simple
    ExecStart=/usr/local/bin/unboundbytes-agent
    Restart=always
    RestartSec=10
    Environment=RUST_LOG=info
    

    [Install]
    WantedBy=multi-user.target
    EOF

  5. Start the agent

    Terminal window
    sudo systemctl daemon-reload
    sudo systemctl enable unboundbytes-agent
    sudo systemctl start unboundbytes-agent

Verify Agent Status

Section titled “Verify Agent Status”
Terminal window
sudo systemctl status unboundbytes-agent
sudo journalctl -u unboundbytes-agent -f

Development Setup

Section titled “Development Setup”

For local development and testing, you can run the orchestrator locally.

Clone the Repository

Section titled “Clone the Repository”
Terminal window
git clone https://github.com/unboundbytes/unboundbytes-core.git
cd unboundbytes-core

Install Dependencies

Section titled “Install Dependencies”
Terminal window
npm install

Run Local Development Server

Section titled “Run Local Development Server”
Terminal window
# Start the orchestrator
npm run dev -- --scope=orchestrator


# In another terminal, start the portal
npm run dev -- --scope=portal

Environment Variables

Section titled “Environment Variables”

Configure your environment for different deployment scenarios:

VariableDescriptionDefault
UB_API_URLAPI base URLhttps://api.unboundbytes.com
UB_TENANT_IDYour tenant identifier-
UB_API_TOKENAuthentication token-
UB_LOG_LEVELLog verbosityinfo

Next Steps

Section titled “Next Steps”