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 via UNC/SMB network shares.

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.

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 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 Device Groups	Create device groups, add UNC target paths, and validate connectivity
Deploying Configurations	Run the deployment wizard: preflight checks, rollout, and monitoring status
Managing Policies	Set up ABAC policies, manage people records, and configure access attributes
Device Enrollment	Review the enrollment queue, approve or reject incoming device requests, and map device ownership
Importing & Exporting Profiles	Export profiles to JSON, import from JSON with conflict resolution, and bulk import via CSV
Using Providers	Add cloud provider instances, assign them to profile sources, and handle credential security

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, and snapshot behaviour
Audit Log	Reading, filtering, and exporting the deployment and change audit history
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.

Markdown Conventions for This Doc Set¶

These conventions apply to all pages in docs/user-guide/.

Heading Levels¶

Level	Usage
`# H1`	Page title only — one per file
`## H2`	Major sections within a page
`### H3`	Sub-sections or step groups
`#### H4`	Individual steps or field descriptions

Notes and Admonitions¶

Use a block-quote prefix to signal admonition type:

> **Note:** General supplementary information.

> **Tip:** Shortcut or best-practice hint.

> **Important:** Information the reader must not skip.

> **Warning:** Risk of data loss or deployment failure.

Cross-Linking Style¶

Link to other pages using relative paths from the current file:
```
See [Glossary](concepts/glossary.md) for term definitions.
```
Link to a specific heading anchor using lowercase-with-hyphens:
```
See [Profile](concepts/glossary.md#profile).
```
Do not use absolute paths or external URLs for internal pages.

Prerequisites and Next Steps¶

Every tutorial page must open with a ## Prerequisites section and close with a ## Next Steps section:

## Prerequisites

- ntkDeploy installed — see [Installation](getting-started/installation.md).
- At least one device group configured — see [Managing Device Groups](tutorials/managing-device-groups.md).

## Next Steps

- [Deploying Configurations](tutorials/deploying-configurations.md)
- [Audit Log](reference/audit-log.md)

Code Blocks¶

Use fenced code blocks with an explicit language tag (bash, json, powershell).
Inline UI labels use bold: click Save, press Deploy.
Field names and values use code: set schemaVersion to 2.

Documentation generated for ntkDeploy. For source code and build instructions, refer to the repository README at the project root.