Skip to content
Nodebyte

Quickstart

This guide walks you through getting Nodebyte running locally with Docker Compose.

Prerequisites

Section titled “Prerequisites”

That’s it. No local Python, Node.js, or PostgreSQL install required.

Setup

Section titled “Setup”

  1. Clone the repository

    Terminal window
    git clone https://github.com/dot-billy/nodebyte.git
    cd nodebyte

  2. Create your environment file

    Terminal window
    cp .env.example .env

    The defaults work out of the box for local development. See the Installation guide for a full environment variable reference.

  3. Start the stack

    Terminal window
    docker compose up --build

    Wait for all three containers (frontend, backend, database) to report healthy.

  4. Open the app

    ServiceURL
    Frontendhttp://localhost:3000
    APIhttp://localhost:8000
    API Docshttp://localhost:8000/docs

  5. Register your first account

    Navigate to http://localhost:3000/register and create an account. Your first team is created automatically during registration.

  6. Add your first node

    From the dashboard, click Add Node and fill in the details — name, hostname, IP, URL, kind, and tags. That’s your first inventory entry.

Invite-Only Mode

Section titled “Invite-Only Mode”

If you prefer to disable public registration, set REGISTRATION_ENABLED=false in your .env file and create the first admin user from the command line:

Terminal window
docker compose exec backend python scripts/create_admin.py

The script prompts for email, password, and team name. You can also pass them as environment variables:

Terminal window
docker compose exec \
  -e ADMIN_EMAIL="admin@example.com" \
  -e ADMIN_PASSWORD="your-secure-password" \
  -e ADMIN_TEAM="My Org" \
  backend python scripts/create_admin.py

After that, invite additional users from the Team page in the dashboard.

Seed Test Data

Section titled “Seed Test Data”

Want some sample nodes to explore? A helper script generates 100 random nodes:

Terminal window
NODEBYTE_EMAIL="you@example.com" \
NODEBYTE_PASSWORD="yourpassword" \
python3 scripts/seed_nodes.py

The backend must be running on http://localhost:8000.

Next Steps

Section titled “Next Steps”