DOCUMENTATION

Racketeer v0.3.0 — offline-first rack documentation for fire & security, IT, and AV integrators.

System Requirements

Install — Windows

Download the Windows installer (Racketeer-Setup-0.3.0.exe) from the download page.

1. Make sure Docker Desktop is installed and running before you start.
2. Run Racketeer-Setup-0.3.0.exe — accept the UAC prompt.
3. The installer will load the Docker image, register a background Windows Service, and add a Start Menu shortcut.
4. When the installer finishes, Racketeer opens automatically at http://localhost:9002.
5. Racketeer will start automatically on next boot.

Install — Linux

Download racketeer-0.3.0-linux.zip and extract it.

unzip racketeer-0.3.0-linux.zip -d racketeer
cd racketeer
chmod +x install-standalone.sh
sudo ./install-standalone.sh

The installer loads the Docker image and registers a systemd service (racketeer). Racketeer will be available at http://localhost:9002 and will start automatically on boot.

# Check status
sudo systemctl status racketeer

# Stop
sudo systemctl stop racketeer

# Start
sudo systemctl start racketeer

Install — macOS

Download racketeer-0.3.0-macos.zip and extract it.

unzip racketeer-0.3.0-macos.zip -d racketeer
cd racketeer
chmod +x install-standalone.sh
sudo ./install-standalone.sh

The installer registers a LaunchDaemon so Racketeer starts at boot. Access at http://localhost:9002.

Install — Docker Compose (Advanced)

# Load the image from the downloaded .tar.gz
docker load -i racketeer-image.tar.gz

# Start with the provided compose file
docker-compose up -d

# Open in browser
http://localhost:9002

Data is persisted to a ./data volume. Back this up regularly — it contains your entire database and license key.

First Login

Navigate to http://localhost:9002 (or the port you configured).

The default admin credentials are:

Username:  admin
PIN:       1234

License Activation

The beta build ships with a pre-activated 999-seat license valid until March 2027 — no activation required to evaluate the product.

To activate a purchased license key:

1. Log in as an admin user.
2. Click your username in the top-right corner → License.
3. Paste your RKS1.-prefixed license key into the field and click Activate.
4. The page will confirm your plan tier, seat count, and expiry date. No internet connection is required.

Sites & Racks

The Racketeer data hierarchy is: Sites → Racks → Devices → Ports.

• A Site represents a physical location (e.g. "Head Office", "Client A — Server Room").
• A Rack lives inside a site and has a U-height (e.g. 42U), a key number, and optional power budget.

From the dashboard, click Add Site to create a site, then Add Rack inside it. Click a rack card to open the rack builder.

Adding Devices

Inside the rack builder, the device palette appears on the left. Drag a device type from the palette and drop it into a U-slot in the rack. You can also click any device in the palette and then click the target slot.

• Devices can be placed on the front or back of the rack (toggle the Front/Back button).
• Full-depth devices (servers, UPS) block the opposite face at that U-position.
• Half-width and quarter-width devices allow multiple devices per U.

Click any placed device to open its detail panel where you can rename it, set IP addresses, power draw, serial number, and more.

Port Mapping

Click a device in the rack, then click the Ports tab in the detail panel. Click any port to open the port details dialog.

For each port you can set:

• Label — e.g. "Gi0/1", "Port 3", "HDMI-Out"
• Connected To — free-text or pick another device/port. Both ends update when you save.
• Cable ID — optional asset tag for the physical cable (e.g. "CAT6-042")
• Cable Length — in metres
• IP Address, VLAN, MAC — for network ports
• Notes

Capacity Planning View

Click the Capacity button in the dashboard header to overlay capacity indicators on every rack card:

• U Space — filled U / total U as a progress bar (green <70%, amber 70–90%, red >90%)
• Power — total device power draw / rack power budget (set in rack settings)
• Ports — connected ports / total ports across all devices

Cable Register

Navigate to Cables in the dashboard header (or go directly to /connections). The cable register shows every port-to-port connection across all your sites and racks in a single table.

• Filter by site, rack, cable type, or free-text search.
• Export the full register as CSV or PDF.

Audit Log PROFESSIONAL+

Navigate to Audit in the dashboard header (admin users only, visible on Professional plan and above).

Every change to the database is recorded with a timestamp, the logged-in username, the action type (create / update / delete), and the entity affected. The audit log is immutable — entries are never edited, only appended.

• Filter by action type, user, entity type, or free-text search.
• Export as PDF for client handover or compliance documentation.
• Entries are retained up to 10,000 (oldest evicted first).

Rack Templates & Duplication PROFESSIONAL+

Duplicate a rack: click the ⋮ menu on any rack card → Duplicate. The clone is added to the same site.

Save as Template: click the ⋮ menu on any rack card → Save as Template. Give the template a name. IP addresses, MAC addresses, and asset numbers are stripped automatically.

Create from Template: click From Template below the "Add Rack" button. Pick a saved template — a new rack is created pre-populated with all devices and port configurations from the template.

Site Client Info & PDF Cover Page

Click the ℹ (info) icon on any site card to open the Client Info panel. Fill in any combination of:

• Client / company name
• Site address
• Contact name, phone, email
• Contract reference
• Next service date
• Notes

When client info is present, all PDF exports for that site include a formatted cover page. The site card will show the client name and, if a next service date is set, highlight it amber when it falls within the next 30 days.

PDF & CSV Export

Exports are available at both the site level and individual rack level.

Site PDF

From the dashboard, click the ⋮ menu on a site card → Export Site PDF. Includes a cover page (if client info is set), a summary table of all racks, and device listings for each rack.

Rack PDF / Mounting Guide

Open a rack, click Export → Rack PDF or Mounting Guide. The mounting guide lists each device with its U position, height, and weight.

CSV Export

From the dashboard Tools menu → Export CSV. Produces a spreadsheet of all devices across all sites and racks.

Cable Register PDF / CSV

From the Cables page, use the Export buttons in the top-right corner.

Plan Comparison

Default Credentials

Username:  admin
PIN:       1234

Change these immediately after installation. Go to the user menu (top right) → Accounts.

Data Location & Backup

All application data (sites, racks, devices, accounts, license key) is stored in a single JSON file:

# Windows (default install)
C:\ProgramData\Racketeer\data\db.json

# Linux / macOS (Docker volume)
./data/db.json  (in your docker-compose directory)

Back up the entire data/ folder regularly. Restoring is as simple as replacing the folder and restarting the service.

Changelog

See the full CHANGELOG.md on GitHub for a complete version history.