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 install (Linux / macOS / SSH target)
curl -sSL https://raw.githubusercontent.com/SmritaPandey/ITAM/main/scripts/deploy/install.sh | bash

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

Both scripts auto-detect Docker and pull the latest packaged release themselves — you don't need to know or pin a specific release tag by hand. If you'd rather review the script before running it against a production machine (reasonable for anything piped into a shell), it lives at scripts/deploy/install.sh /install.ps1 in this repository.

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:

If the health check doesn't respond within a minute or two of docker compose up -d, check docker compose logs api before assuming something's broken — the very first boot runs migrations against a fresh database and can take longer than a normal restart.

Was this article helpful?