Navigation
SetupPlatformModules
Pages
DownloadsSecurityPricingDocsBlogContact
Documentation

Guides & reference

Deploy, discover, and operate QS Assets — from quick start to API auth.

Subscription

Cloud SaaS

  1. Sign up for Starter (free) or start a paid trial
  2. Log in → Settings → Billing to choose Professional / Enterprise
  3. Configure Integrations, then Discovery → Agents (native installers after login)
Enterprise license

Self-host appliance

  1. Subscribe to Enterprise (or buy an on-prem license from sales)
  2. Log in → Downloads — appliance .tar.gz is gated to entitled accounts
  3. Install on Ubuntu/RHEL with Docker; activate Product License (.lic)
  4. Schedule encrypted backups via qsassets backup

Install packs require login + Enterprise (or on-prem license).Client downloads →Docs →

Quick Start Guide

Choose a path first: Cloud SaaS (sign up at /register), or a licensed Linux appliance (On-prem). The steps below cover a local Docker evaluation.

Note
Landing page setup cards live at /#setup. Deep links: #docker, #onprem.

1. Setup & Unattended Deployment

Deploy via one-line terminal commands, SSH, GitHub CLI, or standalone archive packages:

bash
# Option A: 1-Line Remote SSH / Linux / macOS Unattended Install
curl -sSL https://raw.githubusercontent.com/SmritaPandey/ITAM/main/scripts/deploy/install.sh | bash

# Option B: 1-Line Windows PowerShell / WinRM / SSH Remote Install
irm https://raw.githubusercontent.com/SmritaPandey/ITAM/main/scripts/deploy/install.ps1 | iex

# Option C: GitHub Releases Direct CLI Download
gh release download v1.0.0-f82a101 -R SmritaPandey/ITAM-releases -p "*.zip"

# Option D: Docker Compose Air-Gap Bundle (Fast 52 KB)
curl -sSLO https://github.com/SmritaPandey/ITAM-releases/releases/download/v1.0.0-f82a101/qsa-docker.zip && unzip -q qsa-docker.zip && docker compose up -d

2. Launch Services (Docker or Standalone)

For containerized deployments, execute the high-performance local production bundle:

bash
docker compose -f docker-compose.yml up -d
Note
The configuration automatically provisions containerised PostgreSQL for relational asset schemas and Redis for active job queues and cache control.

3. Database Migrations & Seeds

Run the initialization pipelines inside the API container to configure database schemas and import rich enterprise seed datasets:

bash
docker compose -f docker-compose.prod.yml exec api npm run db:migrate
docker compose -f docker-compose.prod.yml exec api npm run db:seed

4. Verify Platform Access

Once the service logs signal stable system initialization, open your browser and navigate to the portals:

Was this article helpful?