Extracted Archive
The PSAppDeployToolkit archive, when unzipped, archive package consists of the following folders and files, and should reflect what you see when you unzip the PSAppDeployToolkit archive:
Toolkit
├── Deploy-Application.exe
│ Deploy-Application.exe.config
│ Deploy-Application.ps1
│
├───AppDeployToolkit
│ AppDeployToolkitBanner.png
│ AppDeployToolkitConfig.xml
│ AppDeployToolkitExtensions.ps1
│ AppDeployToolkitHelp.ps1
│ AppDeployToolkitLogo.ico
│ AppDeployToolkitLogo.png
│ AppDeployToolkitMain.cs
│ AppDeployToolkitMain.ps1
│ RunHidden.vbs
│
├───Files
└───SupportFiles
Examples
├── Launching
├── ServiceUI
├── VLC
└── WinSCP
CHANGELOG.txt
COPYING.Lesser
LICENSE
README.md
Here we will examine each of the files and folders and describe their function:
Root folder
Folder Name | Description |
---|---|
Toolkit/ | Contains PSAppDeployToolkit itself and all of the files / folder structure required to create a deployment package. |
Examples/ | Contains example deployments for both Adobe Reader and Microsoft Office 2013. |
CHANGELOG.txt | The changelog for the current release of the PSAppDeployToolkit. |
COPYING.Lesser | Part of the LGPL license agreement under which the PSAppDeployToolkit is distributed. |
LICENSE | Part of the LGPL license agreement under which the PSAppDeployToolkit is distributed. |
README.md | Project documentation. |
/Toolkit folder
This contains all of the files needed to create a new deployment package
Folder / File Name | Description |
---|---|
AppDeployToolkit/ | Contains the PSAppDeployToolkit dependency files. |
Files/ | Contains the primary installation file(s), e.g. MSI file. This folder is empty by default. |
SupportFiles/ | Contains any supporting resources or assets, e.g. files you need to copy to the target machine using the PSAppDeployToolkit during deployment. This folder is empty by default. |
Deploy_Application.ps1 | PowerShell script that contains the logic to perform the actual install / uninstall / repair. This is the only file that needs to be modified, depending on your level of customization. |
Deploy-Application.exe | An optional executable that can be used to launch the Deploy-Application.ps1 script without opening a PowerShell console window. Supports passing command-line parameters to the script. |
Deploy-Application.exe.config | A .NET configuration file required for Deploy-Application.exe to function correctly. |
/Toolkit/AppDeployToolkit folder
File Name | Description |
---|---|
AppDeployToolkitBanner.png | The default PSAppDeployToolkit branded header, used on any messaging displayed to the end user if interaction is required. To brand the PSAppDeployToolkit User Interface with your own custom / corporate banner, replace this file with your own image. The file must be in PNG format and must be 450 x 50 in size. |
AppDeployToolkitConfig.xml | PSAppDeployToolkit global configuration file. Used by the AppDeployToolkitMain.ps1 script, and sets default values for how the toolkit should behave overall. This is intended to be a static file that is configured once, not on a per-deployment basis. |
AppDeployToolkitExtensions.ps1 | This is an optional PowerShell script that can be used to extend the PSAppDeployToolkit functionality with custom functions. It is automatically dot-sourced by the AppDeployToolkitMain.ps1 script. |
AppDeployToolkitHelp.ps1 | PowerShell script to display a Help consoleThis is a script that displays a help console to browse the functions included in the PSAppDeployToolkit and copy and paste examples in to your deployment script. |
AppDeployToolkitLogo.ico | Contains the default PSAppDeployToolkit branded icon. To brand the balloon notifications and UI window title bars with your own custom / corporate logo, replace this file with your own icon. |
AppDeployToolkitMain.cs | Contains additional classes and methods referred by the AppDeployToolkitMain.ps1 script. |
AppDeployToolkitMain.ps1 | Contains all of the functions and logic used by the installation script. By Separating the logic from the installation script, we can obfuscate away the complex code and make enhancements independently of the installation scripts that contain per-application actions. |
/Examples folder
This contains a number of helpful examples to get you started with the PSAppDeployToolkit.
Folder / File Name | Description |
---|---|
Launching/ | Contains a number of batch files which can simplify launching the toolkit with various options |
ServiceUI/ | Contains a PowerShell helper script and documentation for how to leverage ServiceUI.exe to launch interactive deployments under the SYSTEM account, e.g. when deploying through Microsoft Intune. |
VLC/ | Example deployment script for VLC Media Player. |
WinSCP/ | Example deployment script for WinSCP. |