ntkDeploy User Documentation¶
Welcome to the ntkDeploy user guide. ntkDeploy is a desktop application for Windows fleet administrators to create, manage, and deploy ntkDrive configuration profiles across thousands of devices using deployment target paths such as UNC/SMB network shares and local Windows drives.
Who this guide is for: Windows system administrators managing device configurations at scale. Basic familiarity with Windows networking (UNC paths, SMB shares) and configuration management concepts is assumed.
Quick Navigation¶
| Section | What you will find |
|---|---|
| Getting Started | Install the app, complete first-run setup, and deploy your first profile |
| Concepts | Core terminology, architecture, and the environment model |
| Tutorials | Step-by-step walkthroughs for every major feature |
| Reference | Complete reference for each screen, schema, and shortcut |
| Troubleshooting | Diagnose common problems and deployment failures |
| FAQ | Frequently asked questions |
Getting Started¶
New to ntkDeploy? Start here.
| Page | Description |
|---|---|
| Installation | System requirements, downloading, and installing the MSIX package on Windows |
| First Launch | Initial configuration — server endpoints, default environment, and verifying connectivity |
| Quick Start | End-to-end walkthrough: create a profile, assign it to a device group, and run a deployment |
Concepts¶
Understand the building blocks before diving into tutorials.
| Page | Description |
|---|---|
| Glossary | Definitions for every domain term used throughout the app and this documentation |
| Architecture Overview | How ntkDeploy stores data locally (SQLite), builds deployment artifacts, and delivers them via UNC and local Windows deployment paths |
| Environments | How the Dev / Staging / Production environment model works and when to use each |
Tutorials¶
Hands-on, step-by-step guides for every major workflow.
| Page | Description |
|---|---|
| Creating a Profile | Use the schema-driven form editor to build a new configuration profile with live JSON preview |
| Managing Workspaces | Switch active organizations safely and use Manage Workspaces to create, edit, import, export, and delete workspaces |
| Managing Device Groups | Create device groups, add UNC or local target paths, and validate connectivity |
| Deploying Configurations | Run the deployment wizard: preflight checks, rollout, and monitoring status |
| Mobile Profiles | Generate encrypted .ntkprofile files for ntkMobile — provider mapping, encryption, and delivery |
| Managing Policies | Set up ABAC policies, manage people records, configure access attributes and device environment profiles, and manage Trading Partner Attributes (TPA) when the capability is enabled |
| Device Enrollment | Review the enrollment queue, approve or reject incoming device requests, and map device ownership |
| Importing & Exporting Profiles and Workspaces | Export profile JSON bundles, import them with conflict resolution, and move full workspaces with .zip bundles |
| Using Providers | Add cloud provider instances, assign them to profile sources, and handle credential security |
| Trading Partner Onboarding | TPA Identity Exchange |
Reference¶
Complete reference material for every screen and system.
| Page | Description |
|---|---|
| Dashboard | All dashboard cards, quick-action buttons, stat counters, and activity feed |
| Profile Schemas | Every schema type, its fields, validation rules, and generated JSON output |
| Deployment Preflight | Preflight check list, connectivity gate conditions, snapshot behaviour, and TPA finding codes |
| Audit Log | Reading, filtering, and exporting the deployment and change audit history, including TPA lifecycle events |
| Settings | All configurable options: server endpoints, UI theme, artifact paths, and more |
| Keyboard Shortcuts | Power-user shortcut reference for navigation, creation, and deployment actions |
Troubleshooting¶
Something not working? Start here.
| Page | Description |
|---|---|
| Common Issues | The most frequent problems encountered during setup and daily use, with solutions |
| Deployment Failures | Understanding deployment error codes, rollback behaviour, and retry strategies |
| Connectivity Issues | Diagnosing unreachable UNC paths, SMB permission errors, and network timeouts |
FAQ¶
Frequently asked questions covering licensing, data storage, multi-user setups, and upgrade paths.
Documentation generated for ntkDeploy.