Documentation

This section describes the documentation provided with Sentinel LDK.

Online Documentation

Most Sentinel LDK documentation can be found online at:

https://docs.sentinel.thalesgroup.com/softwareandservices/ldk/default.htm

Locally Installed Documentation

The Sentinel LDK documentation described below is placed on the local machine where Sentinel LDK is installed.

Software Protection and Licensing

Sentinel LDK documents can be found where Sentinel LDK is installed, under:
%ProgramFiles(x86)%\Thales\Sentinel LDK\Docs\

Document	Description
Sentinel LDK with Sentinel EMS – Installation Guide	Details the prerequisites and procedures for installing Sentinel LDK Vendor Tools, Launchers for Sentinel EMS, and the Run-time Environment.
Sentinel LDK Software Protection and Licensing Guide	Familiarize you with the Sentinel LDK applications and their functionality. This guide provides in-depth information about the logic of the applications and best practices for maximizing your software protection and licensing strategies. The guide describes a wide range of licensing strategies and models that you can implement, and can serve as the basis for elaboration and for creating new, tailor-made licensing models.

Document

Description

Sentinel LDK with Sentinel EMS – Installation Guide

Details the prerequisites and procedures for installing Sentinel LDK Vendor Tools, Launchers for Sentinel EMS, and the Run-time Environment.

Sentinel LDK Software Protection and Licensing Guide

Familiarize you with the Sentinel LDK applications and their functionality. This guide provides in-depth information about the logic of the applications and best practices for maximizing your software protection and licensing strategies. The guide describes a wide range of licensing strategies and models that you can implement, and can serve as the basis for elaboration and for creating new, tailor-made licensing models.

Getting Started Guides for Non-Windows Platforms

Getting Started Guides for Sentinel LDK under non-Windows operating systems can be found as follows:

Document	Location
Getting Started Guide for Linux	In the Linux download, or where Sentinel LDK is installed, under: %ProgramFiles(x86)%\Thales\Sentinel LDK\Additional Platforms\Linux\
Getting Started Guide for macOS	In the Mac download, or where Sentinel LDK is installed, under: %ProgramFiles(x86)%\Thales\Sentinel LDK\Additional Platforms\MacOS\
Getting Started Guide for Android	Where Sentinel LDK is installed, under: %ProgramFiles(x86)%\Thales\Sentinel LDK\Additional Platforms\Android\

Sentinel LDK User Interfaces

The documentation described in the table that follows can be accessed from the user interface for the relevant Sentinel LDK component.

Document	Description
Sentinel Admin Control Center User Guide	Documentation for the end user, describing Sentinel Admin Control Center and providing instructions for performing the various functions such as updating or attaching licenses.
Sentinel LDK Data Encryption Utility User Guide (Separate versions for Windows and for Mac)	Provides the developer with a description of the Sentinel LDK Data Encryption utility (formerly DataHASP utility), used for protecting data files that are accessed by Sentinel LDK Envelope.
Sentinel LDK Envelope User Guide (Separate versions for Windows, macOS, and Linux)	Describes how to employ Sentinel LDK Envelope to automatically wrap your programs with a protective shield. The application provides advanced protection features to enhance the overall level of security of your software. The user guide for Linux can be found in the Linux download, or where Sentinel LDK is installed, under: %ProgramFiles(x86)%\Thales\Sentinel LDK\Additional Platforms\Linux\Docs\Manuals & Tutorials.
Sentinel LDK ToolBox	Describes how to work with the ToolBox user interface for the Licensing API, License Generation API, and Admin API. Using Sentinel LDK ToolBox, the developer can experiment with the individual functions that are available in each API and can generate programming code for insertion in the developer’s own program. Provides full documentation for each of the included APIs.

Sentinel LDK APIs

Documentation for the Sentinel LDK APIs described below can be found where Sentinel LDK is installed, under:
%ProgramFiles(x86)%\Thales\Sentinel LDK\API\

Sentinel LDK API	Description
Admin API Reference	Provides the functionality available in Admin Control Center and Sentinel License Manager in the form of callable API functions.
Licensing API Reference (formerly Run-time API)	Provides the developer with an interface to use the licensing and protection functionality available in the Sentinel LDK Run-time Environment.
Run-time Installer API	Provides the developer with an interface for integrating installation of the Run-time Environment into the installation of the vendor’s protected application.