mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-06-16 10:53:43 +00:00
Merge branch 'main' into gary-fix-markup
This commit is contained in:
Gary Moore
@ -1,47 +0,0 @@
|
||||
---
|
||||
title: Browser Support
|
||||
ms.date: 03/30/2023
|
||||
ms.topic: concept-article
|
||||
description: Learn about browser support in Kiosk Mode
|
||||
---
|
||||
|
||||
# Browser Support
|
||||
|
||||
Today, you can use two browsers, Internet Explorer 11 and [Microsoft Edge](/deployedge/microsoft-edge-configure-kiosk-mode) to create an assigned access single-app or multi-app kiosk experience.
|
||||
|
||||
## Microsoft Edge Kiosk Mode
|
||||
|
||||
> Available for LTSC starting in [Windows 10 IoT Enterprise 2021 LTSC](/windows/iot/iot-enterprise/whats-new/Windows-10-IoT-Enterprise-LTSC-2021)
|
||||
|
||||
[Microsoft Edge kiosk mode](/deployedge/microsoft-edge-configure-kiosk-mode) offers two lockdown experiences of the browser so organizations can create, manage, and provide the best experience for their customers. The following lockdown experiences are available:
|
||||
|
||||
* Digital/Interactive Signage experience - Displays a specific site in full-screen mode.
|
||||
* Public-Browsing experience - Runs a limited multi-tab version of Microsoft Edge.
|
||||
|
||||
Both experiences are running a Microsoft Edge InPrivate session, which protects user data.
|
||||
|
||||
## Internet Explorer 11
|
||||
|
||||
[Internet Explorer 11](/internet-explorer/internet-explorer) is considered a legacy browser, in subsequent releases.
|
||||
|
||||
In anticipation of that, you can use [Internet Explorer (IE) mode](/deployedge/edge-ie-mode) on Microsoft Edge. IE mode allows you to run legacy web apps and modern web apps in a single browser.
|
||||
|
||||
> [!NOTE]
|
||||
> For in-support Windows 10 IoT Enterprise [Semi-Annual Channel (SAC) releases](/lifecycle/products/windows-10-iot-enterprise), Internet Explorer 11 will reach end of support on June 15, 2022.
|
||||
>
|
||||
> Internet Explorer 11 follows the Long-Term-Servicing-Channel (LTSC) Lifecycle for [Windows 10 IoT Enterprise LTSC](/lifecycle/products/?terms=Windows%2010%20IoT%20Enterprise%20LTSC) products.
|
||||
|
||||
## Supported Versions
|
||||
|
||||
| Browser | Internet Explorer 11 | Microsoft Edge Legacy | Microsoft Edge |
|
||||
|--|--|--|--|
|
||||
| OS Release | [IE11 App](/internet-explorer/internet-explorer) | [Edge Browser - Legacy](/deployedge/microsoft-edge-kiosk-mode-transition-plan) | [New Edge Browser](/deployedge/microsoft-edge-configure-kiosk-mode) |
|
||||
| Windows 10 IoT Enterprise LTSC 2019 | [Follows OS Release Support Lifecycle](/lifecycle/products/windows-10-iot-enterprise-ltsc-2019) | No browser security updates after March, 9, 2021 (removed where applicable). In-box engine supported until OS end of service | Microsoft Edge and WebView2 Runtime not in-box (requires app migration from EdgeHTML) |
|
||||
| Windows 10 IoT Enterprise, version 21H2 | End of support June 15, 2022 | Removed & replaced with New Microsoft Edge Browser in May 2021 Update | Included in-box or installed with May 2021 Update |
|
||||
| Windows 10 IoT Enterprise LTSC 2021 | [Follows OS Release Support Lifecycle](/lifecycle/products/windows-10-iot-enterprise-ltsc-2021) | Not included | Microsoft Edge included in-box and follows [Modern Lifecycle Policy](/lifecycle/policies/modern) |
|
||||
| Windows 11 IoT Enterprise | N/A | N/A | Microsoft Edge included in-box and follows [Modern Lifecycle Policy](/lifecycle/policies/modern) |
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Configure Microsoft Edge kiosk mode](/deployedge/microsoft-edge-configure-kiosk-mode)
|
||||
* [Plan your kiosk mode transition](/deployedge/microsoft-edge-kiosk-mode-transition-plan)
|
||||
291
windows/configuration/shell-launcher/configuration-file.md
Normal file
291
windows/configuration/shell-launcher/configuration-file.md
Normal file
@ -0,0 +1,291 @@
|
||||
---
|
||||
title: Create a Shell Launcher configuration file
|
||||
description: Learn how to create an XML file to configure a device with Shell Launcher.
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: how-to
|
||||
---
|
||||
|
||||
# Create a Shell Launcher configuration file
|
||||
|
||||
To configure Shell Launcher, you must create and apply a configuration XML file to your devices. The configuration file must conform to a *schema*, as defined in [Shell Launcher XML Schema Definition (XSD)](xsd.md).
|
||||
|
||||
This article describes how to configure a Shell Launcher configuration file, including practical examples.
|
||||
|
||||
Let's start by looking at the basic structure of the XML file. A Shell Launcher configuration file contains:
|
||||
|
||||
- One or multiple `profiles`. Each `profile` defines:
|
||||
- the application that replaces the standard Windows shell (`Explorer.exe`), which is executed when a user signs in
|
||||
- the default action to take when the application exits, and actions when the application exits with a specific return code
|
||||
- One or multiple `configs`. Each `config` associates a user account to a `profile`
|
||||
|
||||
> [!NOTE]
|
||||
> A profile has no effect if it's not associated to a user account.
|
||||
|
||||
Here's a basic example of a Shell Launcher configuration file, with one profile and one config:
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<ShellLauncherConfiguration
|
||||
xmlns="http://schemas.microsoft.com/ShellLauncher/2018/Configuration"
|
||||
xmlns:V2="http://schemas.microsoft.com/ShellLauncher/2019/Configuration">
|
||||
<Profiles>
|
||||
<Profile Id="{GUID}">
|
||||
<!-- Add configuration here as needed -->
|
||||
</Profile>
|
||||
</Profiles>
|
||||
<Configs>
|
||||
<Config>
|
||||
<!-- Add configuration here as needed -->
|
||||
</Config>
|
||||
</Configs>
|
||||
</ShellLauncherConfiguration>
|
||||
```
|
||||
|
||||
## Versioning
|
||||
|
||||
The Shell Launcher configuration XML is versioned. The version is defined in the XML root element, and it's used to determine which schema to use to validate the XML file. The version is also used to determine which features are available for the configuration. Here's a table of the versions, aliases used in the documentation examples, and namespaces:
|
||||
|
||||
| Version | Alias | Namespace |
|
||||
|-|-|-|
|
||||
|Windows 10|`V2`|http://schemas.microsoft.com/ShellLauncher/2019/Configuration|
|
||||
|Windows 10|default|http://schemas.microsoft.com/ShellLauncher/2018/Configuration|
|
||||
|
||||
To authorize a compatible configuration XML that includes version-specific elements and attributes, always include the namespace of the add-on schemas, and decorate the attributes and elements accordingly with the namespace alias. For example, to configure the kiosk application to execute in full screen, use the below example. Note the alias `V2` associated to `http://schemas.microsoft.com/ShellLauncher/2019/Configuration` namespace, and the alias is tagged on the `AppType` and `AllAppsFullScreen` properties inline.
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<ShellLauncherConfiguration
|
||||
xmlns="http://schemas.microsoft.com/ShellLauncher/2018/Configuration"
|
||||
xmlns:V2="http://schemas.microsoft.com/ShellLauncher/2019/Configuration">
|
||||
<Profiles>
|
||||
<Profile Id="{GUID}">
|
||||
<!-- Add configuration here as needed -->
|
||||
<Shell Shell="%ProgramFiles(x86)%\Microsoft\Edge\Application\msedge.exe" V2:AppType="Desktop" V2:AllAppsFullScreen="true">
|
||||
</Profile>
|
||||
</Profiles>
|
||||
<Configs>
|
||||
<Config>
|
||||
<!-- Add configuration here as needed -->
|
||||
</Config>
|
||||
</Configs>
|
||||
</ShellLauncherConfiguration>
|
||||
```
|
||||
|
||||
Here you can find the [Shell Launcher XML Schema Definitions (XSDs)](xsd.md).
|
||||
|
||||
## Profiles
|
||||
|
||||
A configuration file can contain one or more profiles. Each profile has a unique identifier `Profile Id` and, optionally, a `Name`. For example:
|
||||
|
||||
```xml
|
||||
<Profiles>
|
||||
<Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F78}" Name="Microsoft Learn example">
|
||||
<!-- Add configuration here as needed -->
|
||||
</Profile>
|
||||
</Profiles>
|
||||
```
|
||||
|
||||
> [!TIP]
|
||||
> The `Profile Id` must be unique within the XML file. You can generate a GUID with the PowerShell cmdlet `New-Guid`.
|
||||
|
||||
You can define a `Defaultprofile` that is used when no other profile is associated to a user account. This ensures that every user using the device uses the same application. Example:
|
||||
|
||||
```xml
|
||||
<Profiles>
|
||||
<DefaultProfile>
|
||||
<!-- Add configuration here as needed -->
|
||||
</DefaultProfile>
|
||||
</Profiles>
|
||||
```
|
||||
|
||||
### Shell
|
||||
|
||||
Each profile defines a `Shell` element, which contains details about the application to execute. The `Shell` element has the following properties:
|
||||
|
||||
| Property| Description | Details |
|
||||
|-|-|-|
|
||||
|`Shell`| Application that is used as a Windows shell. |- For Universal Windows Platform (UWP) apps, you must provide the App User Model ID (AUMID). Learn how to [Find the Application User Model ID of an installed app](../store/find-aumid.md).<br>- For desktop apps, specify the full path of the executable, which can contain system environment variables in the form of `%variableName%`. You can also specify any parameters that the app might require. |
|
||||
|`V2:AppType`| Defines the type of application. |Allowed values are `Desktop` and `UWP`.|
|
||||
|`V2:AllAppsFullScreen` | Boolean value that defines if all applications are executed in full screen. |- When set to `true`, Shell Launcher runs every app in full screen, or maximized for desktop apps.<br>- When set to `false` or not set, only the custom shell app runs in full screen; other apps launched by the user run in windowed mode.|
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<Profile Id="{GUID}">
|
||||
<Shell Shell="" V2:AppType="" V2:AllAppsFullScreen="">
|
||||
<!-- Add configuration here as needed -->
|
||||
</Shell>
|
||||
</Profile>
|
||||
```
|
||||
|
||||
In the next example, the Weather app is executed in full screen.
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<ShellLauncherConfiguration xmlns="http://schemas.microsoft.com/ShellLauncher/2018/Configuration"
|
||||
xmlns:V2="http://schemas.microsoft.com/ShellLauncher/2019/Configuration">
|
||||
<Profiles>
|
||||
<DefaultProfile>
|
||||
<Shell Shell="Microsoft.BingWeather_8wekyb3d8bbwe!App" V2:AppType="UWP">
|
||||
<DefaultAction Action="RestartShell"/>
|
||||
</Shell>
|
||||
</DefaultProfile>
|
||||
</Profiles>
|
||||
<Configs/>
|
||||
</ShellLauncherConfiguration>
|
||||
```
|
||||
|
||||
In the next example, Microsoft Edge is executed in full screen, opening a website. The website is reloaded after 2 minutes of inactivity.
|
||||
|
||||
```xml
|
||||
<Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F78}">
|
||||
<Shell Shell="%ProgramFiles(x86)%\Microsoft\Edge\Application\msedge.exe --kiosk https://www.contoso.com --edge-kiosk-type=fullscreen --kiosk-idle-timeout-minutes=2" V2:AppType="Desktop" V2:AllAppsFullScreen="true">
|
||||
<DefaultAction Action="RestartShell"/>
|
||||
</Shell>
|
||||
</Profile>
|
||||
```
|
||||
|
||||
#### ReturnCodeActions
|
||||
|
||||
Shell Launcher defines four actions to handle app exits. You can customize Shell Launcher and use the actions based on different exit code. Here are the `ReturnCodeActions` enums:
|
||||
|
||||
- `RestartShell`
|
||||
- `RestartDevice`
|
||||
- `ShutdownDevice`
|
||||
- `DoNothing`
|
||||
|
||||
The actions can be used as default action, or mapped to a specific exit code. Refer to [Shell Launcher](/windows-hardware/customize/enterprise/wesl-usersettingsetcustomshell) to learn how to use exit codes with Shell Launcher WMI.
|
||||
|
||||
You can specify at most four custom actions mapping to four exit codes, and one default action for all other exit codes. When an app exits, and if the exit code isn't found in the custom action mapping, or there's no default action defined, nothing happens. For this reason, you should at least define `DefaultAction`.
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<Profile Id="{GUID}">
|
||||
<Shell Shell="" V2:AppType="" V2:AllAppsFullScreen="">
|
||||
<ReturnCodeActions>
|
||||
<ReturnCodeAction ReturnCode="0" Action="RestartShell"/>
|
||||
<ReturnCodeAction ReturnCode="-1" Action="RestartDevice"/>
|
||||
<ReturnCodeAction ReturnCode="255" Action="ShutdownDevice"/>
|
||||
<ReturnCodeAction ReturnCode="1" Action="DoNothing"/>
|
||||
</ReturnCodeActions>
|
||||
<DefaultAction Action="RestartDevice"/>
|
||||
</Shell>
|
||||
</Profile>
|
||||
```
|
||||
|
||||
## Configs
|
||||
|
||||
Under `Configs`, define one or more user accounts and their association with a profile.
|
||||
|
||||
Individual accounts are specified using `<Account Name=""/>`.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Before applying the Shell Launcher configuration, make sure the specified user account is available on the device, otherwise it fails.
|
||||
>
|
||||
> For both domain and Microsoft Entra accounts, as long as the device is Active Directory joined or Microsoft Entra joined, the account can be discovered in the domain forest or tenant that the device is joined to. For local accounts, it is required that the account exist before you configure the account for Shell Launcher.
|
||||
|
||||
### Local user
|
||||
|
||||
Local account can be entered as `devicename\user`, `.\user`, or just `user`.
|
||||
|
||||
```xml
|
||||
<Config>
|
||||
<Account Name="Learn Example"/>
|
||||
<Profile Id="{GUID}"/>
|
||||
</Config>
|
||||
```
|
||||
|
||||
### Active Directory user
|
||||
|
||||
Domain accounts must be entered using the format `domain\samAccountName`.
|
||||
|
||||
```xml
|
||||
<Config>
|
||||
<Account Name="contoso\user"/>
|
||||
<Profile Id="{GUID}"/>
|
||||
</Config>
|
||||
```
|
||||
|
||||
### Microsoft Entra user
|
||||
|
||||
Microsoft Entra accounts must be specified with the format: `AzureAD\{UPN}`. `AzureAD` must be provided *as is*, then follow with the Microsoft Entra user principal name (UPN).
|
||||
|
||||
```xml
|
||||
<Config>
|
||||
<Account Name="azuread\user@contoso.onmicrosoft.com"/>
|
||||
<Profile Id="{GUID}"/>
|
||||
</Config>
|
||||
```
|
||||
|
||||
When the user account signs in, the associated Shell Launcher profile is applied, loading the application specified in the profile.
|
||||
|
||||
### Autologon account
|
||||
|
||||
With `<AutoLogonAccount>`, Shell Launcher creates and manages a user account to automatically sign in after a device restarts. The account is a local standard user named `Kiosk`.
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<Configs>
|
||||
<Config>
|
||||
<!--account managed by Shell Launcher-->
|
||||
<AutoLogonAccount/>
|
||||
<Profile Id="{GUID}"/>
|
||||
</Config>
|
||||
<Configs>
|
||||
<!--local account-->
|
||||
<Account Name="Learn Example"/>
|
||||
<Profile ID="{GUID}"/>
|
||||
</Configs>
|
||||
<Configs>
|
||||
<!--Microsoft Entra account-->
|
||||
<Account Name="azuread\kiosk@contoso.com"/>
|
||||
<Profile ID="{GUID}"/>
|
||||
</Configs>
|
||||
</Configs>
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
Here's a complete example of a Shell Launcher configuration file, with two profiles and three configs:
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<ShellLauncherConfiguration xmlns="http://schemas.microsoft.com/ShellLauncher/2018/Configuration" xmlns:V2="http://schemas.microsoft.com/ShellLauncher/2019/Configuration">
|
||||
<Profiles>
|
||||
<DefaultProfile>
|
||||
<Shell Shell="%SystemRoot%\explorer.exe" />
|
||||
</DefaultProfile>
|
||||
<Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F79}" Name="Weather">
|
||||
<Shell Shell="Microsoft.BingWeather_8wekyb3d8bbwe!App" V2:AppType="UWP">
|
||||
<DefaultAction Action="RestartShell" />
|
||||
</Shell>
|
||||
</Profile>
|
||||
<Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F78}" Name="Edge">
|
||||
<Shell Shell="%ProgramFiles(x86)%\Microsoft\Edge\Application\msedge.exe --kiosk https://www.contoso.com --edge-kiosk-type=fullscreen --kiosk-idle-timeout-minutes=2" V2:AppType="Desktop" V2:AllAppsFullScreen="true">
|
||||
<ReturnCodeActions>
|
||||
<ReturnCodeAction ReturnCode="0" Action="RestartShell" />
|
||||
<ReturnCodeAction ReturnCode="-1" Action="RestartDevice" />
|
||||
<ReturnCodeAction ReturnCode="255" Action="ShutdownDevice" />
|
||||
</ReturnCodeActions>
|
||||
<DefaultAction Action="RestartShell" />
|
||||
</Shell>
|
||||
</Profile>
|
||||
</Profiles>
|
||||
<Configs>
|
||||
<Config>
|
||||
<AutoLogonAccount />
|
||||
<Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F78}" />
|
||||
</Config>
|
||||
<Config>
|
||||
<Account Name="azuread\kiosk1@contoso.onmicrosoft.com" />
|
||||
<Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F79}" />
|
||||
</Config>
|
||||
<Config>
|
||||
<Account Name="azuread\kiosk2@contoso.onmicrosoft.com" />
|
||||
<Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F78}" />
|
||||
</Config>
|
||||
</Configs>
|
||||
</ShellLauncherConfiguration>
|
||||
```
|
||||
143
windows/configuration/shell-launcher/configure-wmi.md
Normal file
143
windows/configuration/shell-launcher/configure-wmi.md
Normal file
@ -0,0 +1,143 @@
|
||||
---
|
||||
title: Configure Shell Launcher with the WMI provider
|
||||
description: Learn how to configure a Windows kiosk using the WMI provider for Shell Launcher.
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: reference
|
||||
---
|
||||
|
||||
# Configure Shell Launcher with the WMI provider
|
||||
|
||||
This article provides a guide on configuring Shell Launcher using the WMI provider, which consists of a set of classes for managing Shell Launcher settings.
|
||||
|
||||
Included in this article is a PowerShell script that demonstrates how to utilize the WMI provider for configuring Shell Launcher. The script offers examples on setting the default shell, assigning a custom shell to a user, and removing a custom shell. Additionally, the WMI provider can be used to enable or disable Shell Launcher.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The script is not intended to be run as-is. You must modify the script to match your environment and requirements. For example, you must change the user name in the script to match an existing user on your system. The script is provided as a reference only.
|
||||
|
||||
```PowerShell
|
||||
# Verify Shell Launcher license
|
||||
|
||||
function Check-ShellLauncherLicenseEnabled
|
||||
{
|
||||
[string]$source = @"
|
||||
using System;
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
static class CheckShellLauncherLicense
|
||||
{
|
||||
const int S_OK = 0;
|
||||
|
||||
public static bool IsShellLauncherLicenseEnabled()
|
||||
{
|
||||
int enabled = 0;
|
||||
|
||||
if (NativeMethods.SLGetWindowsInformationDWORD("EmbeddedFeature-ShellLauncher-Enabled", out enabled) != S_OK) {
|
||||
enabled = 0;
|
||||
}
|
||||
return (enabled != 0);
|
||||
}
|
||||
|
||||
static class NativeMethods
|
||||
{
|
||||
[DllImport("Slc.dll")]
|
||||
internal static extern int SLGetWindowsInformationDWORD([MarshalAs(UnmanagedType.LPWStr)]string valueName, out int value);
|
||||
}
|
||||
|
||||
}
|
||||
"@
|
||||
|
||||
$type = Add-Type -TypeDefinition $source -PassThru
|
||||
|
||||
return $type[0]::IsShellLauncherLicenseEnabled()
|
||||
}
|
||||
|
||||
[bool]$result = $false
|
||||
|
||||
$result = Check-ShellLauncherLicenseEnabled
|
||||
"`nShell Launcher license enabled is set to " + $result
|
||||
if (-not($result))
|
||||
{
|
||||
"`nThis device doesn't have required license to use Shell Launcher"
|
||||
exit
|
||||
}
|
||||
|
||||
$COMPUTER = "localhost"
|
||||
$NAMESPACE = "root\standardcimv2\embedded"
|
||||
|
||||
# Create a handle to the class instance so we can call the static methods.
|
||||
try {
|
||||
$ShellLauncherClass = [wmiclass]"\\$COMPUTER\${NAMESPACE}:WESL_UserSetting"
|
||||
} catch [Exception] {
|
||||
write-host $_.Exception.Message;
|
||||
write-host "Make sure Shell Launcher feature is enabled"
|
||||
exit
|
||||
}
|
||||
|
||||
|
||||
# This well-known security identifier (SID) corresponds to the BUILTIN\Administrators group.
|
||||
|
||||
$Admins_SID = "S-1-5-32-544"
|
||||
|
||||
# Create a function to retrieve the SID for a user account on a machine.
|
||||
|
||||
function Get-UsernameSID($AccountName) {
|
||||
|
||||
$NTUserObject = New-Object System.Security.Principal.NTAccount($AccountName)
|
||||
$NTUserSID = $NTUserObject.Translate([System.Security.Principal.SecurityIdentifier])
|
||||
|
||||
return $NTUserSID.Value
|
||||
}
|
||||
|
||||
# Get the SID for a user account named "Cashier". Rename "Cashier" to an existing account on your system to test this script.
|
||||
|
||||
$Cashier_SID = Get-UsernameSID("Cashier")
|
||||
|
||||
# Define actions to take when the shell program exits.
|
||||
|
||||
$restart_shell = 0
|
||||
$restart_device = 1
|
||||
$shutdown_device = 2
|
||||
$do_nothing = 3
|
||||
|
||||
# Examples. You can change these examples to use the program that you want to use as the shell.
|
||||
|
||||
# This example sets the command prompt as the default shell, and restarts the device if the command prompt is closed.
|
||||
|
||||
$ShellLauncherClass.SetDefaultShell("cmd.exe", $restart_device)
|
||||
|
||||
# Display the default shell to verify that it was added correctly.
|
||||
|
||||
$DefaultShellObject = $ShellLauncherClass.GetDefaultShell()
|
||||
|
||||
"`nDefault Shell is set to " + $DefaultShellObject.Shell + " and the default action is set to " + $DefaultShellObject.defaultaction
|
||||
|
||||
# Set Internet Explorer as the shell for "Cashier", and restart the machine if Internet Explorer is closed.
|
||||
|
||||
$ShellLauncherClass.SetCustomShell($Cashier_SID, "c:\program files\internet explorer\iexplore.exe www.microsoft.com", ($null), ($null), $restart_shell)
|
||||
|
||||
# Set Explorer as the shell for administrators.
|
||||
|
||||
$ShellLauncherClass.SetCustomShell($Admins_SID, "explorer.exe")
|
||||
|
||||
# View all the custom shells defined.
|
||||
|
||||
"`nCurrent settings for custom shells:"
|
||||
Get-WmiObject -namespace $NAMESPACE -computer $COMPUTER -class WESL_UserSetting | Select Sid, Shell, DefaultAction
|
||||
|
||||
# Enable Shell Launcher
|
||||
|
||||
$ShellLauncherClass.SetEnabled($TRUE)
|
||||
$IsShellLauncherEnabled = $ShellLauncherClass.IsEnabled()
|
||||
"`nEnabled is set to " + $IsShellLauncherEnabled.Enabled
|
||||
|
||||
# Remove the new custom shells.
|
||||
|
||||
$ShellLauncherClass.RemoveCustomShell($Admins_SID)
|
||||
$ShellLauncherClass.RemoveCustomShell($Cashier_SID)
|
||||
|
||||
# Disable Shell Launcher
|
||||
|
||||
$ShellLauncherClass.SetEnabled($FALSE)
|
||||
$IsShellLauncherEnabled = $ShellLauncherClass.IsEnabled()
|
||||
"`nEnabled is set to " + $IsShellLauncherEnabled.Enabled
|
||||
```
|
||||
266
windows/configuration/shell-launcher/configure.md
Normal file
266
windows/configuration/shell-launcher/configure.md
Normal file
@ -0,0 +1,266 @@
|
||||
---
|
||||
title: Configure Shell Launcher
|
||||
description: Learn how to configure Shell Launcher.
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: how-to
|
||||
---
|
||||
|
||||
# Configure Shell Launcher
|
||||
|
||||
There are two ways you can configure Shell Launcher:
|
||||
|
||||
1. Using the `ShellLauncher` node of the [Assigned Access Configuration Service Provider (CSP)](/windows/client-management/mdm/assignedaccess-csp), which also automatically enables Shell Launcher on the device, if the device supports it
|
||||
1. Using the **Shell Launcher WMI providers** directly in an application. When using this method, you must [enable Shell Launcher](#enable-shell-launcher) first
|
||||
|
||||
You can configure the following options for Shell Launcher:
|
||||
|
||||
- Add/remove a shell configuration for a specific user or group
|
||||
- Change the default shell configuration
|
||||
- Get information on a shell configuration for a specific user or group
|
||||
|
||||
> [!NOTE]
|
||||
> Any changes don't take effect until a user signs in.
|
||||
|
||||
## Enable Shell Launcher
|
||||
|
||||
Shell Launcher is an optional component in Windows that is not enabled by default. To configure it, you must first enable it. You can enable and configure Shell Launcher in a customized Windows image, or you can enable it before applying a provisioning package to configure it.
|
||||
|
||||
> [!NOTE]
|
||||
> When you configure Shell Launcher with the Assigned Access Configuration Service Provider (CSP), Shell Launcher is automatically enabled, if the device supports it. There's no need to enable Shell Launcher separately when you configure it using Assigned Access CSP.
|
||||
|
||||
There are multiple ways to enable Shell Launcher, select the method that best fits your needs to learn more.
|
||||
|
||||
#### [:::image type="icon" source="../images/icons/control-panel.svg"::: **Control Panel**](#tab/control-panel1)
|
||||
|
||||
To enable Shell Launcher using Control Panel, follow these steps:
|
||||
|
||||
1. Open **Control Panel** > **Programs** > **Turn Windows features on or off** or use the command `optionalfeatures.exe`
|
||||
1. Expand **Device Lockdown** and select **Shell Launcher**
|
||||
1. Select **OK** to enable Shell Launcher
|
||||
|
||||
#### [:::image type="icon" source="../images/icons/powershell.svg"::: **PowerShell**](#tab/powershell1)
|
||||
|
||||
To enable Shell Launcher using PowerShell, follow these steps:
|
||||
|
||||
1. Open a PowerShell window with administrator privileges
|
||||
1. Run the following command:
|
||||
|
||||
```powershell
|
||||
Enable-WindowsOptionalFeature -FeatureName Client-DeviceLockdown,Client-EmbeddedShellLauncher -Online
|
||||
```
|
||||
|
||||
#### [:::image type="icon" source="../images/icons/settings.svg"::: **DISM**](#tab/dism1)
|
||||
|
||||
The following example uses a Windows image called `install.wim`, but you can use the same procedure to apply a provisioning package.
|
||||
|
||||
1. Open a command prompt with administrator privileges.
|
||||
1. Copy install.wim to a temporary folder on hard drive (in the following steps, we assume it's called `C:\wim`)
|
||||
1. Modify the following script to match your environment:
|
||||
|
||||
```cmd
|
||||
@echo off
|
||||
REM Create a new directory
|
||||
md c:\wim
|
||||
|
||||
REM Mount the image
|
||||
dism /mount-wim /wimfile:c:\bootmedia\sources\install.wim /index:1 /MountDir:c:\wim
|
||||
|
||||
REM Enable the feature
|
||||
dism /image:c:\wim /enable-feature /all /featureName:Client-EmbeddedShellLauncher
|
||||
|
||||
REM Commit the change
|
||||
dism /unmount-wim /MountDir:c:\wim /Commit
|
||||
```
|
||||
|
||||
For more information on DISM, see [What Is Deployment Image Servicing and Management](/windows-hardware/manufacture/desktop/what-is-dism).
|
||||
|
||||
#### [:::image type="icon" source="../images/icons/dev.svg"::: **WMI**](#tab/wmi)
|
||||
|
||||
You can enable or disable Shell Launcher by calling the `SetEnabled` function in the Windows Management Instrumentation (WMI) class `WESL_UserSetting`.
|
||||
|
||||
For more information, see [WESL_UserSetting](wesl-usersetting.md).
|
||||
|
||||
---
|
||||
|
||||
## Launch different shells for different user accounts
|
||||
|
||||
By default, Shell Launcher runs the default shell, which is specified when you create the OS image at design time. The default shell is set to the Windows Command Processor (`Cmd.exe`), but you can specify any executable file to be the default shell.
|
||||
|
||||
You can also configure Shell Launcher to launch a different shell for specific users or groups if you don't want to run the default shell. For example, you might configure a device to launch a custom application shell for guest accounts, but run the standard Windows Explorer shell for administrator accounts for servicing the device.
|
||||
|
||||
When the current signed in account belongs to two or more groups that have different configurations defined for each group, Shell Launcher uses the first configuration it finds. The search order isn't defined, so we recommend that you avoid assigning a user to multiple groups with different Shell Launcher configurations.
|
||||
|
||||
> [!NOTE]
|
||||
> If you use the WMI provider to configure Shell Launcher for a user or group at run time, you must use the security identifier (SID) for that security principal. You can't use the user name or group name.
|
||||
>
|
||||
> For more information about common security identifiers, see [Well-known SIDs](/windows/win32/secauthz/well-known-sids).
|
||||
|
||||
## Shell Launcher startup and exit behavior
|
||||
|
||||
Shell Launcher processes the `Run` and `RunOnce` registry keys before starting the custom shell, so your custom shell doesn't need to handle the automatic startup of other applications and services.
|
||||
|
||||
Shell Launcher also handles the behavior of the system when your custom shell exits. You can configure the shell exit behavior if the default behavior doesn't meet your needs. When a custom shell exits, Shell Launcher can perform one of four actions:
|
||||
|
||||
- `0`: Restart the shell
|
||||
- `1`: Restart the device
|
||||
- `2`: Shut down the device
|
||||
- `3`: Do nothing
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Make sure that your shell application does not automatically exit and is not automatically closed by any features such as Dialog Filter, as this can lead to an infinite cycle of exiting and restarting, unless the return code action is set to do nothing.
|
||||
|
||||
### Default return code action
|
||||
|
||||
You can define a default return code action for Shell Launcher with the DefaultReturnCodeAction setting. If you don't change the initial value, the default return code action is set to 0 (zero), which indicates that Shell Launcher restarts the shell when the shell exits.
|
||||
|
||||
### Map the exit code to a Shell Launcher action
|
||||
|
||||
Shell Launcher can take a specific action based on the exit code returned by the shell. For any given exit code returned by the shell, you can configure the action that Shell Launcher takes by mapping that exit code to one of the shell exit actions.
|
||||
|
||||
If the exit code doesn't match a defined value, Shell Launcher performs the default return code action.
|
||||
|
||||
For example, your shell might return exit code values of `-1`, `0`, `1`, or `255` depending on how the shell exits. You can configure Shell Launcher to:
|
||||
|
||||
- restart the device (`1`) when the shell returns an exit code of value `-1`
|
||||
- restart the shell (`0`) when the shell returns an exit code of value `0`
|
||||
- do nothing (`3`) when the shell returns an exit code of value 1
|
||||
- shut down the device (`2`) when the shell returns an exit code of value `255`
|
||||
|
||||
Your custom return code action mapping would look like this:
|
||||
|
||||
|Exit code|Action|
|
||||
|:----:|----|
|
||||
|`-1`|`1` (restart the device)|
|
||||
|`0`|`0` (restart the shell)|
|
||||
|`1`|`3` (do nothing)|
|
||||
|`255`|`2` (shut down the device)|
|
||||
|
||||
## Set your custom shell with the Assigned Access CSP
|
||||
|
||||
The configuration of Shell Launcher is done using an XML file. The XML file is applied to the device via the [Assigned Access CSP](/windows/client-management/mdm/assignedaccess-csp#shelllauncher), using one of the following options:
|
||||
|
||||
- A Mobile Device Management (MDM) solution, like Microsoft Intune
|
||||
- Provisioning packages
|
||||
- The MDM Bridge WMI Provider
|
||||
|
||||
> [!NOTE]
|
||||
> Configuring Shell Launcher using Assigned Access CSP, automatically enables Shell Launcher on the device, if the device supports it.
|
||||
|
||||
To learn how to configure the Shell Launcher XML file, see [Create a Shell Launcher configuration file](configuration-file.md).
|
||||
|
||||
[!INCLUDE [tab-intro](../../../includes/configure/tab-intro.md)]
|
||||
|
||||
#### [:::image type="icon" source="../images/icons/intune.svg"::: **Intune/CSP**](#tab/intune)
|
||||
|
||||
You can configure devices using a [custom policy][MEM-1] with the [AssignedAccess CSP][WIN-3].
|
||||
|
||||
- **Setting:** `./Vendor/MSFT/AssignedAccess/ShellLauncher`
|
||||
- **Value:** content of the XML configuration file
|
||||
|
||||
Assign the policy to a group that contains as members the devices that you want to configure.
|
||||
|
||||
#### [:::image type="icon" source="../images/icons/provisioning-package.svg"::: **PPKG**](#tab/ppkg)
|
||||
|
||||
You can configure Shell Launcher by creating a provisioning package and then applying the provisioning package during image deployment time or at runtime:
|
||||
|
||||
- If you're creating an installation media with settings for Shell Launcher included in the image, or you're applying a provisioning package during setup, you must enable Shell Launcher on the installation media with DISM for a provisioning package to successfully apply
|
||||
- If exectuing the provisioning package at runtime, ensure to [enable Shell Launcher](#enable-shell-launcher) before applying the provisioning package
|
||||
|
||||
[!INCLUDE [provisioning-package-1](../../../includes/configure/provisioning-package-1.md)]
|
||||
|
||||
| Path | Setting name | Value |
|
||||
|--|--|--|
|
||||
| `SMISettings/ShellLauncher/` | `Enable` | ENABLE |
|
||||
| `SMISettings/ShellLauncher/` | * | It depends on specific settings. |
|
||||
|
||||
[!INCLUDE [provisioning-package-2](../../../includes/configure/provisioning-package-2.md)]
|
||||
|
||||
#### [:::image type="icon" source="../images/icons/powershell.svg"::: **PowerShell**](#tab/ps)
|
||||
|
||||
[!INCLUDE [powershell-wmi-bridge-1](../../../includes/configure/powershell-wmi-bridge-1.md)]
|
||||
|
||||
```PowerShell
|
||||
$shellLauncherConfiguration = @"
|
||||
|
||||
# content of the XML configuration file
|
||||
|
||||
"@
|
||||
|
||||
$namespaceName="root\cimv2\mdm\dmmap"
|
||||
$className="MDM_AssignedAccess"
|
||||
$obj = Get-CimInstance -Namespace $namespaceName -ClassName $className
|
||||
$obj.ShellLauncher = [System.Net.WebUtility]::HtmlEncode($shellLauncherConfiguration)
|
||||
$obj = Set-CimInstance -CimInstance $obj -ErrorVariable cimSetError -ErrorAction SilentlyContinue
|
||||
if($cimSetError) {
|
||||
Write-Output "An ERROR occurred. Displaying error record and attempting to retrieve error logs...`n"
|
||||
Write-Error -ErrorRecord $cimSetError[0]
|
||||
|
||||
$timeout = New-TimeSpan -Seconds 30
|
||||
$stopwatch = [System.Diagnostics.Stopwatch]::StartNew()
|
||||
$eventLogFilterHashTable = @{ LogName='Microsoft-Windows-AssignedAccess/Admin' }
|
||||
do{
|
||||
$events = Get-WinEvent -FilterHashtable $eventLogFilterHashTable -ErrorAction Ignore
|
||||
} until ($events.Count -or $stopwatch.Elapsed -gt $timeout) # wait for the log to be available
|
||||
|
||||
if($events.Count) {
|
||||
$events | ForEach-Object {
|
||||
Write-Output "$($_.TimeCreated) [$($_.LevelDisplayName.ToUpper())] $($_.Message -replace "`n|`r")"
|
||||
}
|
||||
} else {
|
||||
Write-Warning "Timed-out attempting to retrieve event logs..."
|
||||
}
|
||||
|
||||
Exit 1
|
||||
}
|
||||
|
||||
Write-Output "Successfully applied Shell Launcher configuration"
|
||||
```
|
||||
|
||||
[!INCLUDE [powershell-wmi-bridge-2](../../../includes/configure/powershell-wmi-bridge-2.md)]
|
||||
|
||||
---
|
||||
|
||||
> [!TIP]
|
||||
> For practical examples, see the [Quickstart: configure a kiosk experience with Shell Launcher](quickstart-kiosk.md).
|
||||
|
||||
## User experience
|
||||
|
||||
After the settings are applied, the users that are configured to use Shell Launcher will execute the custom shell after sign-in.
|
||||
|
||||
Depending on your configuration, you can have a user to automatically sign in to the device.
|
||||
|
||||
## Remove Shell Launcher
|
||||
|
||||
Here are the options to remove Shell Launcher, select the method that best fits your needs:
|
||||
|
||||
#### [:::image type="icon" source="../images/icons/intune.svg"::: **Intune/CSP**](#tab/intune)
|
||||
|
||||
Unassign or delete the policy that contains the configuration.
|
||||
|
||||
#### [:::image type="icon" source="../images/icons/provisioning-package.svg"::: **PPKG**](#tab/ppkg)
|
||||
|
||||
Uninstall the provisioning package that contains the configuration.
|
||||
|
||||
#### [:::image type="icon" source="../images/icons/powershell.svg"::: **PowerShell**](#tab/ps)
|
||||
|
||||
```PowerShell
|
||||
$namespaceName="root\cimv2\mdm\dmmap"
|
||||
$className="MDM_AssignedAccess"
|
||||
$obj = Get-CimInstance -Namespace $namespaceName -ClassName $className
|
||||
$obj.Configuration = $null
|
||||
Set-CimInstance -CimInstance $obj
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Next steps
|
||||
|
||||
> [!div class="nextstepaction"]
|
||||
> Learn how to configure the Shell Launcher XML file:
|
||||
>
|
||||
> [Create a Shell Launcher configuration file](configuration-file.md)
|
||||
|
||||
<!--links-->
|
||||
|
||||
[MEM-1]: /mem/intune/configuration/custom-settings-windows-10
|
||||
[WIN-3]: /windows/client-management/mdm/assignedaccess-csp
|
||||
@ -0,0 +1,13 @@
|
||||
---
|
||||
author: paolomatarazzo
|
||||
ms.author: paoloma
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: include
|
||||
---
|
||||
|
||||
```msgraph-interactive
|
||||
POST https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations
|
||||
Content-Type: application/json
|
||||
|
||||
{ "id": "00-0000-0000-0000-000000000000", "displayName": "_MSLearn_Example_Kiosk - Shell Launcher", "description": "This is a sample policy created from an article on learn.microsoft.com.", "roleScopeTagIds": [ "0" ], "@odata.type": "#microsoft.graph.windows10CustomConfiguration", "omaSettings": [ { "@odata.type": "#microsoft.graph.omaSettingString", "displayName": "ShellLauncher", "description": null, "omaUri": "./Vendor/MSFT/AssignedAccess/ShellLauncher", "secretReferenceValueId": null, "isEncrypted": true, "value": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<ShellLauncherConfiguration\nxmlns=\"http://schemas.microsoft.com/ShellLauncher/2018/Configuration\"\nxmlns:V2=\"http://schemas.microsoft.com/ShellLauncher/2019/Configuration\">\n <Profiles>\n <DefaultProfile>\n <Shell Shell=\"%SystemRoot%\\explorer.exe\"/>\n </DefaultProfile>\n <Profile Id=\"{EDB3036B-780D-487D-A375-69369D8A8F78}\">\n <Shell Shell=\"%ProgramFiles(x86)%\\Microsoft\\Edge\\Application\\msedge.exe --kiosk https://www.contoso.com --edge-kiosk-type=fullscreen --kiosk-idle-timeout-minutes=2\" V2:AppType=\"Desktop\" V2:AllAppsFullScreen=\"true\">\n <ReturnCodeActions>\n <ReturnCodeAction ReturnCode=\"0\" Action=\"RestartShell\"/>\n <ReturnCodeAction ReturnCode=\"-1\" Action=\"RestartDevice\"/>\n <ReturnCodeAction ReturnCode=\"255\" Action=\"ShutdownDevice\"/>\n </ReturnCodeActions>\n <DefaultAction Action=\"RestartShell\"/>\n </Shell>\n </Profile>\n </Profiles>\n <Configs>\n <Config>\n <AutoLogonAccount/>\n <Profile Id=\"{EDB3036B-780D-487D-A375-69369D8A8F78}\"/>\n </Config>\n </Configs>\n</ShellLauncherConfiguration>" } ], }
|
||||
```
|
||||
@ -0,0 +1,43 @@
|
||||
---
|
||||
author: paolomatarazzo
|
||||
ms.author: paoloma
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: include
|
||||
---
|
||||
|
||||
```PowerShell
|
||||
$shellLauncherConfiguration = @"
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<ShellLauncherConfiguration
|
||||
xmlns="http://schemas.microsoft.com/ShellLauncher/2018/Configuration"
|
||||
xmlns:V2="http://schemas.microsoft.com/ShellLauncher/2019/Configuration">
|
||||
<Profiles>
|
||||
<DefaultProfile>
|
||||
<Shell Shell="%SystemRoot%\explorer.exe"/>
|
||||
</DefaultProfile>
|
||||
<Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F78}">
|
||||
<Shell Shell="%ProgramFiles(x86)%\Microsoft\Edge\Application\msedge.exe --kiosk https://www.contoso.com --edge-kiosk-type=fullscreen --kiosk-idle-timeout-minutes=2" V2:AppType="Desktop" V2:AllAppsFullScreen="true">
|
||||
<ReturnCodeActions>
|
||||
<ReturnCodeAction ReturnCode="0" Action="RestartShell"/>
|
||||
<ReturnCodeAction ReturnCode="-1" Action="RestartDevice"/>
|
||||
<ReturnCodeAction ReturnCode="255" Action="ShutdownDevice"/>
|
||||
</ReturnCodeActions>
|
||||
<DefaultAction Action="RestartShell"/>
|
||||
</Shell>
|
||||
</Profile>
|
||||
</Profiles>
|
||||
<Configs>
|
||||
<Config>
|
||||
<AutoLogonAccount/>
|
||||
<Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F78}"/>
|
||||
</Config>
|
||||
</Configs>
|
||||
</ShellLauncherConfiguration>
|
||||
"@
|
||||
|
||||
$namespaceName="root\cimv2\mdm\dmmap"
|
||||
$className="MDM_AssignedAccess"
|
||||
$obj = Get-CimInstance -Namespace $namespaceName -ClassName $className
|
||||
$obj.ShellLauncher = [System.Net.WebUtility]::HtmlEncode($shellLauncherConfiguration)
|
||||
$obj = Set-CimInstance -CimInstance $obj
|
||||
```
|
||||
@ -0,0 +1,35 @@
|
||||
---
|
||||
author: paolomatarazzo
|
||||
ms.author: paoloma
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: include
|
||||
---
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<ShellLauncherConfiguration
|
||||
xmlns="http://schemas.microsoft.com/ShellLauncher/2018/Configuration"
|
||||
xmlns:V2="http://schemas.microsoft.com/ShellLauncher/2019/Configuration">
|
||||
<Profiles>
|
||||
<DefaultProfile>
|
||||
<Shell Shell="%SystemRoot%\explorer.exe"/>
|
||||
</DefaultProfile>
|
||||
<Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F78}">
|
||||
<Shell Shell="%ProgramFiles(x86)%\Microsoft\Edge\Application\msedge.exe --kiosk https://www.contoso.com --edge-kiosk-type=fullscreen --kiosk-idle-timeout-minutes=2" V2:AppType="Desktop" V2:AllAppsFullScreen="true">
|
||||
<ReturnCodeActions>
|
||||
<ReturnCodeAction ReturnCode="0" Action="RestartShell"/>
|
||||
<ReturnCodeAction ReturnCode="-1" Action="RestartDevice"/>
|
||||
<ReturnCodeAction ReturnCode="255" Action="ShutdownDevice"/>
|
||||
</ReturnCodeActions>
|
||||
<DefaultAction Action="RestartShell"/>
|
||||
</Shell>
|
||||
</Profile>
|
||||
</Profiles>
|
||||
<Configs>
|
||||
<Config>
|
||||
<AutoLogonAccount/>
|
||||
<Profile Id="{EDB3036B-780D-487D-A375-69369D8A8F78}"/>
|
||||
</Config>
|
||||
</Configs>
|
||||
</ShellLauncherConfiguration>
|
||||
```
|
||||
@ -1,344 +1,65 @@
|
||||
---
|
||||
title: Shell Launcher
|
||||
description: Shell Launcher
|
||||
ms.date: 06/07/2018
|
||||
title: Shell Launcher Overview
|
||||
description: Learn how to configure devices with Shell Launcher.
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: overview
|
||||
---
|
||||
|
||||
# Shell Launcher
|
||||
# Shell Launcher overview
|
||||
|
||||
Using Shell Launcher, you can configure a kiosk device to use almost any application or executable as your custom shell. The application that you specify replaces the default shell (explorer.exe) that usually runs when a user logs on.
|
||||
Shell Launcher is a Windows feature that you can use to replace the default Windows Explorer shell (`Explorer.exe`) with a Windows desktop application or a Universal Windows Platform (UWP) app. This feature is useful for creating a custom user experience on devices that are used for a specific purpose, including kiosks, ATMs, and digital signage.
|
||||
|
||||
You can also configure Shell Launcher to launch different shell applications for different users or user groups.
|
||||
Shell Launcher controls which application a user gets as the shell after sign-in. It doesn't prevent a user from accessing other desktop applications and system components. From a custom shell, you can launch secondary views displayed on multiple monitors, or launch other apps in full screen on user's demand. You can also configure Shell Launcher to launch different shell applications for different users or user groups.
|
||||
|
||||
There are a few exceptions to the applications and executables you can use as a custom shell:
|
||||
With Shell Launcher, you can use features and methods to control access to other applications or system components. These methods include, but aren't limited to:
|
||||
|
||||
- You can't use the following executable as a custom shell: `C:\\Windows\\System32\\Eshell.exe`. Using Eshell.exe as the default shell will result in a blank screen after user signs in.
|
||||
- You can't use a Universal Windows app as a custom shell.
|
||||
- You can't use a custom shell to launch Universal Windows apps, for example, the Settings app.
|
||||
- You can't use an application that launches a different process and exits as a custom shell. For example, you can't specify **write.exe** in Shell Launcher. Shell Launcher launches a custom shell and monitors the process to identify when the custom shell exits. **Write.exe** creates a 32-bit wordpad.exe process and exits. Because Shell Launcher isn't aware of the newly created wordpad.exe process, Shell Launcher takes action based on the exit code of **Write.exe**, and restart the custom shell.
|
||||
- You can't prevent the system from shutting down. For Shell Launcher V1 and V2, you can't block the session ending by returning FALSE upon receiving the [WM_QUERYENDSESSION](/windows/win32/shutdown/wm-queryendsession) message in a graphical application or returning FALSE in the [handler routine](/windows/console/handlerroutine) that is added through the [SetConsoleCtrlHandler](/windows/console/setconsolectrlhandler) function in a console application.
|
||||
- Configuration Service Provider (CSP)
|
||||
- Group policy (GPO)
|
||||
- [AppLocker](/windows/security/threat-protection/windows-defender-application-control/applocker/applocker-overview)
|
||||
|
||||
> [!NOTE]
|
||||
> You cannot configure both Shell Launcher and assigned access on the same system.
|
||||
>
|
||||
> Use **Shell Launcher V2**, you can specify a Universal Windows app as a custom shell. Check [Use Shell Launcher to create a Windows 10 kiosk](/windows/configuration/kiosk-shelllauncher) for the differences between Shell Launcher v1 and Shell Launcher V2.
|
||||
[!INCLUDE [shell-launcher](../../../includes/licensing/shell-launcher.md)]
|
||||
|
||||
Shell Launcher processes the **Run** and **RunOnce** registry keys before starting the custom shell, so your custom shell doesn't need to handle the automatic startup of other applications and services.
|
||||
## Shell Launcher version history
|
||||
|
||||
Shell Launcher also handles the behavior of the system when your custom shell exits. You can configure the shell exit behavior if the default behavior doesn't meet your needs.
|
||||
Shell Launcher has undergone several iterations since its introduction, with the most notable being Shell Launcher v1 and Shell Launcher v2. Each version has brought improvements and new features to enhance the user experience and functionality of custom shells in Windows environments:
|
||||
|
||||
Methods of controlling access to other desktop applications and system components can be used in addition to using the Shell Launcher such as, [Group Policy](https://www.microsoft.com/download/details.aspx?id=25250), [AppLocker](/windows/iot/iot-enterprise/customize/application-control#applocker), and [Mobile Device Management](/windows/client-management/mdm/)
|
||||
- Shell Launcher v1 was the original implementation, introduced to provide basic functionality for replacing the default shell. However, it had limitations, such as only supporting Win32 applications as custom shells and lacking flexibility for handling modern app scenarios
|
||||
- Shell Launcher v2, introduced with Windows 10, version 1809, added support for Universal Windows Platform (UWP) apps as custom shells, making it more versatile for modern environments
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> In Shell Launcher v1, available in Windows 10, you can only specify a Windows desktop application as the replacement shell. In Shell Launcher v2, available in Windows 10, version 1809 and above, you can also specify a UWP app as the replacement shell.
|
||||
>
|
||||
> To use Shell Launcher v2 in version 1809, you need to install the [KB4551853 update](https://support.microsoft.com/topic/may-12-2020-kb4551853-os-build-17763-1217-c2ea33f7-4506-dd13-2739-d9c7bb80b26d).
|
||||
### Differences between Shell Launcher v1 and Shell Launcher v2
|
||||
|
||||
## Differences between Shell Launcher v1 and Shell Launcher v2
|
||||
- Shell Launcher v1 replaces `Explorer.exe` with `Eshell.exe`, which can only launch a Windows desktop application
|
||||
- Shell Launcher v2 replaces `Explorer.exe` with `CustomShellHost.exe`, which can launch a Windows desktop application or a UWP app
|
||||
- In addition to allowing you to use a UWP app for your replacement shell, Shell Launcher v2 offers more enhancements:
|
||||
- You can use a custom Windows desktop application that can then launch UWP apps, such as Settings and Touch Keyboard
|
||||
- From a custom UWP shell, you can launch secondary views and run on multiple monitors
|
||||
- The custom shell app runs in full screen, and can run other apps in full screen on user's demand
|
||||
|
||||
Shell Launcher v1 replaces `explorer.exe`, the default shell, with `eshell.exe`, which can launch a Windows desktop application.
|
||||
Shell Launcher v2 replaces `explorer.exe` with `customshellhost.exe`. This new executable file can launch a Windows desktop application or a UWP app.
|
||||
In addition to allowing you to use a UWP app for your replacement shell, Shell Launcher v2 offers more enhancements:
|
||||
|
||||
- You can use a custom Windows desktop application that can then launch UWP apps, such as Settings and Touch Keyboard.
|
||||
- From a custom UWP shell, you can launch secondary views and run on multiple monitors.
|
||||
- The custom shell app runs in full screen, and can run other apps in full screen on user's demand.
|
||||
For sample XML configurations for the different app combinations, see [Samples for Shell Launcher v2](https://github.com/microsoft/Windows-IoT-Samples/tree/master/samples/ShellLauncher/ShellLauncherV2).
|
||||
|
||||
## Requirements
|
||||
## Limitations
|
||||
|
||||
Windows 10 Enterprise or Windows 10 Education.
|
||||
Here are some limitations to consider when using Shell Launcher:
|
||||
|
||||
## Terminology
|
||||
|
||||
- **Turn on, enable:** To make the setting available to the device and optionally apply the settings to the device.
|
||||
- **Configure:** To customize the setting or subsettings.
|
||||
- **Embedded Shell Launcher:** This feature is called Embedded Shell Launcher in Windows 10, version 1511.
|
||||
- **Custom Shell Launcher:** This feature is called Shell Launcher in Windows 10, version 1607 and later.
|
||||
|
||||
## Turn on Shell Launcher
|
||||
|
||||
Shell Launcher is an optional component and isn't turned on by default in Windows 10. It must be turned on prior to configuring. You can turn on and configure Shell Launcher in a customized Windows 10 image (.wim) if Microsoft Windows hasn't been installed. If Windows has already been installed, you must turn on Shell Launcher before applying a provisioning package to configure Shell Launcher.
|
||||
|
||||
### Enable Shell Launcher using Control Panel
|
||||
|
||||
1. In the **Search the web and Windows** field, type **Programs and Features** and either press **Enter** or tap or select **Programs and Features** to open it.
|
||||
1. In the **Programs and Features** window, select **Turn Windows features on or off**.
|
||||
1. In the **Windows Features** window, expand the **Device Lockdown** node, select or clear the checkbox for **Shell Launcher**, and then select **OK.**
|
||||
1. The **Windows Features** window indicates that Windows is searching for required files and displays a progress bar. Once found, the window indicates that Windows is applying the changes. When completed, the window indicates the requested changes are completed.
|
||||
1. Select **Close** to close the **Windows Features** window.
|
||||
|
||||
> [!NOTE]
|
||||
> Turning on Shell Launcher does not require a device restart.
|
||||
|
||||
### Enable Shell Launcher by calling WESL_UserSetting
|
||||
|
||||
1. Enable or disable Shell Launcher by calling the WESL_UserSetting.SetEnabled function in the Windows Management Instrumentation (WMI) class WESL_UserSetting.
|
||||
1. If you enable or disable Shell Launcher using WESL_UserSetting, the changes don't affect any sessions that are currently signed in; you must sign out and sign back in.
|
||||
|
||||
This example uses a Windows image called install.wim, but you can use the same procedure to apply a provisioning package (for more information on DISM, see [What Is Deployment Image Servicing and Management](/windows-hardware/manufacture/desktop/what-is-dism).
|
||||
|
||||
### Enable Shell Launcher using DISM
|
||||
|
||||
1. Open a command prompt with administrator privileges.
|
||||
1. Copy install.wim to a temporary folder on hard drive (in the following steps, we assume it's called C:\\wim).
|
||||
1. Create a new directory.
|
||||
|
||||
```cmd
|
||||
md c:\wim
|
||||
```
|
||||
|
||||
1. Mount the image.
|
||||
|
||||
```cmd
|
||||
dism /mount-wim /wimfile:c:\bootmedia\sources\install.wim /index:1 /MountDir:c:\wim
|
||||
```
|
||||
|
||||
1. Enable the feature.
|
||||
|
||||
```cmd
|
||||
dism /image:c:\wim /enable-feature /all /featureName:Client-EmbeddedShellLauncher
|
||||
```
|
||||
|
||||
1. Commit the change.
|
||||
|
||||
```cmd
|
||||
dism /unmount-wim /MountDir:c:\wim /Commit
|
||||
```
|
||||
|
||||
### Enable Shell Launcher using Windows Configuration Designer
|
||||
|
||||
The Shell Launcher settings are also available as Windows provisioning settings so you can configure these settings to be applied during the image runtime. You can set one or all Shell Launcher settings by creating a provisioning package using Windows Configuration Designer and then applying the provisioning package during image deployment time or runtime. If Windows hasn't been installed and you're using Windows Configuration Designer to create installation media with settings for Shell Launcher included in the image or you're applying a provisioning package during setup, you must enable Shell Launcher on the installation media with DISM in order for a provisioning package to successfully apply.
|
||||
|
||||
Use the following steps to create a provisioning package that contains the ShellLauncher settings.
|
||||
|
||||
1. Build a provisioning package in Windows Configuration Designer by following the instructions in [Create a provisioning package for Windows 10](/windows/configuration/provisioning-packages/provisioning-create-package).
|
||||
1. In the **Available customizations** page, select **Runtime settings** > **SMISettings** > **ShellLauncher**.
|
||||
1. Set the value of **Enable** to **ENABLE**. More options to configure Shell Launcher appears, and you can set the values as desired.
|
||||
1. Once you have finished configuring the settings and creating the provisioning package, you can apply the package to the image deployment time or runtime. See the [Apply a provisioning package](/windows/configuration/provisioning-packages/provisioning-apply-package) for more information. The process for applying the package to a Windows 10 Enterprise image is the same.
|
||||
|
||||
## Configure Shell Launcher
|
||||
|
||||
There are two ways you can configure Shell Launcher:
|
||||
|
||||
1. In Windows 10, version 1803, you can configure Shell Launcher using the **ShellLauncher** node of the Assigned Access Configuration Service Provider (CSP). See [AssignedAccess CSP](/windows/client-management/mdm/assignedaccess-csp) for details. Configuring Shell Launcher using this method also automatically enables Shell Launcher on the device, if the device supports it.
|
||||
1. Use the Shell Launcher WMI providers directly in a PowerShell script or application.
|
||||
|
||||
You can configure the following options for Shell Launcher:
|
||||
|
||||
- Enable or disable Shell Launcher.
|
||||
- Specify a shell configuration for a specific user or group.
|
||||
- Remove a shell configuration for a specific user or group.
|
||||
- Change the default shell configuration.
|
||||
- Get information on a shell configuration for a specific user or group.
|
||||
|
||||
Any changes don't take effect until a user signs in.
|
||||
|
||||
## Launch different shells for different user accounts
|
||||
|
||||
By default, Shell Launcher runs the default shell, which is specified when you create the OS image at design time. The default shell is set to Cmd.exe, but you can specify any executable file to be the default shell.
|
||||
|
||||
You can configure Shell Launcher to launch a different shell for specific users or groups if you don't want to run the default shell. For example, you might configure a device to run a custom application shell for guest accounts, but run the standard Windows Explorer shell for administrator accounts in order to service the device.
|
||||
|
||||
If you use the WMI providers to configure Shell Launcher for a user or group at run time, you must use the security identifier (SID) for that user or group; you can't use the user name or group name.
|
||||
|
||||
For more information about common security identifiers, see [Well-known SIDs](/windows/win32/secauthz/well-known-sids).
|
||||
|
||||
When the current signed in account belongs to two or more groups that have different configurations defined for each group, Shell Launcher uses the first configuration it finds. The search order isn't defined, so we recommend that you avoid assigning a user to multiple groups with different Shell Launcher configurations.
|
||||
|
||||
## Perform an action when the shell exits
|
||||
|
||||
When a custom shell exits, Shell Launcher can perform one of four actions:
|
||||
|
||||
|Action|Description|
|
||||
|:---:|:---|
|
||||
|0|Restart the shell.|
|
||||
|1|Restart the device.|
|
||||
|2|Shut down the device.|
|
||||
|3|Do nothing.|
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Make sure that your shell application does not automatically exit and is not automatically closed by any features such as Dialog Filter, as this can lead to an infinite cycle of exiting and restarting, unless the return code action is set to do nothing.
|
||||
|
||||
### Default return code action
|
||||
|
||||
You can define a default return code action for Shell Launcher with the DefaultReturnCodeAction setting. If you don't change the initial value, the default return code action is set to 0 (zero), which indicates that Shell Launcher restarts the shell when the shell exits.
|
||||
|
||||
### Map the exit code to a Shell Launcher action
|
||||
|
||||
Shell Launcher can take a specific action based on the exit code returned by the shell. For any given exit code returned by the shell, you can configure the action that Shell Launcher takes by mapping that exit code to one of the shell exit actions.
|
||||
|
||||
If the exit code doesn't match a defined value, Shell Launcher performs the default return code action.
|
||||
|
||||
For example, your shell might return exit code values of -1, 0, 1, or 255 depending on how the shell exits. You can configure Shell Launcher to:
|
||||
|
||||
- restart the device (1) when the shell returns an exit code of value -1
|
||||
- restart the shell (0) when the shell returns an exit code of value 0
|
||||
- do nothing (3) when the shell returns an exit code of value 1
|
||||
- shut down the device (2) when the shell returns an exit code of value 255
|
||||
|
||||
Your custom return code action mapping would look like this:
|
||||
|
||||
|Exit code|Action|
|
||||
|:----:|----|
|
||||
|-1|1 (restart the device)|
|
||||
|0|0 (restart the shell)|
|
||||
|1|3 (do nothing)|
|
||||
|255|2 (shut down the device)|
|
||||
|
||||
## Set your custom shell
|
||||
|
||||
Modify the following PowerShell script as appropriate and run the script on the device.
|
||||
|
||||
```PowerShell
|
||||
# Check if shell launcher license is enabled
|
||||
function Check-ShellLauncherLicenseEnabled
|
||||
{
|
||||
[string]$source = @"
|
||||
using System;
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
static class CheckShellLauncherLicense
|
||||
{
|
||||
const int S_OK = 0;
|
||||
|
||||
public static bool IsShellLauncherLicenseEnabled()
|
||||
{
|
||||
int enabled = 0;
|
||||
|
||||
if (NativeMethods.SLGetWindowsInformationDWORD("EmbeddedFeature-ShellLauncher-Enabled", out enabled) != S_OK) {
|
||||
enabled = 0;
|
||||
}
|
||||
return (enabled != 0);
|
||||
}
|
||||
|
||||
static class NativeMethods
|
||||
{
|
||||
[DllImport("Slc.dll")]
|
||||
internal static extern int SLGetWindowsInformationDWORD([MarshalAs(UnmanagedType.LPWStr)]string valueName, out int value);
|
||||
}
|
||||
|
||||
}
|
||||
"@
|
||||
|
||||
$type = Add-Type -TypeDefinition $source -PassThru
|
||||
|
||||
return $type[0]::IsShellLauncherLicenseEnabled()
|
||||
}
|
||||
|
||||
[bool]$result = $false
|
||||
|
||||
$result = Check-ShellLauncherLicenseEnabled
|
||||
"`nShell Launcher license enabled is set to " + $result
|
||||
if (-not($result))
|
||||
{
|
||||
"`nThis device doesn't have required license to use Shell Launcher"
|
||||
exit
|
||||
}
|
||||
|
||||
$COMPUTER = "localhost"
|
||||
$NAMESPACE = "root\standardcimv2\embedded"
|
||||
|
||||
# Create a handle to the class instance so we can call the static methods.
|
||||
try {
|
||||
$ShellLauncherClass = [wmiclass]"\\$COMPUTER\${NAMESPACE}:WESL_UserSetting"
|
||||
} catch [Exception] {
|
||||
write-host $_.Exception.Message;
|
||||
write-host "Make sure Shell Launcher feature is enabled"
|
||||
exit
|
||||
}
|
||||
|
||||
|
||||
# This well-known security identifier (SID) corresponds to the BUILTIN\Administrators group.
|
||||
|
||||
$Admins_SID = "S-1-5-32-544"
|
||||
|
||||
# Create a function to retrieve the SID for a user account on a machine.
|
||||
|
||||
function Get-UsernameSID($AccountName) {
|
||||
|
||||
$NTUserObject = New-Object System.Security.Principal.NTAccount($AccountName)
|
||||
$NTUserSID = $NTUserObject.Translate([System.Security.Principal.SecurityIdentifier])
|
||||
|
||||
return $NTUserSID.Value
|
||||
}
|
||||
|
||||
# Get the SID for a user account named "Cashier". Rename "Cashier" to an existing account on your system to test this script.
|
||||
|
||||
$Cashier_SID = Get-UsernameSID("Cashier")
|
||||
|
||||
# Define actions to take when the shell program exits.
|
||||
|
||||
$restart_shell = 0
|
||||
$restart_device = 1
|
||||
$shutdown_device = 2
|
||||
$do_nothing = 3
|
||||
|
||||
# Examples. You can change these examples to use the program that you want to use as the shell.
|
||||
|
||||
# This example sets the command prompt as the default shell, and restarts the device if the command prompt is closed.
|
||||
|
||||
$ShellLauncherClass.SetDefaultShell("cmd.exe", $restart_device)
|
||||
|
||||
# Display the default shell to verify that it was added correctly.
|
||||
|
||||
$DefaultShellObject = $ShellLauncherClass.GetDefaultShell()
|
||||
|
||||
"`nDefault Shell is set to " + $DefaultShellObject.Shell + " and the default action is set to " + $DefaultShellObject.defaultaction
|
||||
|
||||
# Set Internet Explorer as the shell for "Cashier", and restart the machine if Internet Explorer is closed.
|
||||
|
||||
$ShellLauncherClass.SetCustomShell($Cashier_SID, "c:\program files\internet explorer\iexplore.exe www.microsoft.com", ($null), ($null), $restart_shell)
|
||||
|
||||
# Set Explorer as the shell for administrators.
|
||||
|
||||
$ShellLauncherClass.SetCustomShell($Admins_SID, "explorer.exe")
|
||||
|
||||
# View all the custom shells defined.
|
||||
|
||||
"`nCurrent settings for custom shells:"
|
||||
Get-WmiObject -namespace $NAMESPACE -computer $COMPUTER -class WESL_UserSetting | Select Sid, Shell, DefaultAction
|
||||
|
||||
# Enable Shell Launcher
|
||||
|
||||
$ShellLauncherClass.SetEnabled($TRUE)
|
||||
|
||||
$IsShellLauncherEnabled = $ShellLauncherClass.IsEnabled()
|
||||
|
||||
"`nEnabled is set to " + $IsShellLauncherEnabled.Enabled
|
||||
|
||||
# Remove the new custom shells.
|
||||
|
||||
$ShellLauncherClass.RemoveCustomShell($Admins_SID)
|
||||
|
||||
$ShellLauncherClass.RemoveCustomShell($Cashier_SID)
|
||||
|
||||
# Disable Shell Launcher
|
||||
|
||||
$ShellLauncherClass.SetEnabled($FALSE)
|
||||
|
||||
$IsShellLauncherEnabled = $ShellLauncherClass.IsEnabled()
|
||||
|
||||
"`nEnabled is set to " + $IsShellLauncherEnabled.Enabled
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> The previous script includes examples of multiple configuration options, including removing a custom shell and disabling Shell Launcher. It is not intended to be run as-is.
|
||||
- Windows doesn't support setting a custom shell before the out-of-box experience (OOBE). If you do, you can't deploy the resulting image
|
||||
- Shell Launcher doesn't support a custom shell with an application that launches a different process and exits. For example, you can't specify `write.exe` in Shell Launcher. Shell Launcher launches a custom shell and monitors the process to identify when the custom shell exits. `Write.exe` creates a 32-bit `wordpad.exe` process and exits. Since Shell Launcher isn't aware of the newly created `wordpad.exe` process, Shell Launcher takes action based on the exit code of `Write.exe`, such as restarting the custom shell
|
||||
|
||||
## Shell Launcher user rights
|
||||
|
||||
A custom shell is launched with the same level of user rights as the account that is signed in. This means that a user with administrator rights can perform any system action that requires administrator rights, including launching other applications with administrator rights, while a user without administrator rights can't.
|
||||
A custom shell is launched with the same level of user rights as the account that is signed in. This means that a user with administrative rights can perform any system action that requires administrative rights, including launching other applications with administrative rights.
|
||||
|
||||
> [!WARNING]
|
||||
> If your shell application requires administrator rights and needs to be elevated, and User Account Control (UAC) is present on your device, you must disable UAC in order for Shell Launcher to launch the shell application.
|
||||
> If your shell application requires administrative rights and needs to be elevated, and User Account Control (UAC) is enabled, you must disable UAC for Shell Launcher to launch the shell application.
|
||||
|
||||
## Related articles
|
||||
## Next steps
|
||||
|
||||
- [Unbranded Boot](../unbranded-boot/index.md)
|
||||
- [Custom Logon](../custom-logon/index.md)
|
||||
- [Use Shell Launcher to create a Windows 10 Kiosk](/windows/configuration/kiosk-shelllauncher)
|
||||
- [Launch different shells for different user accounts](/windows-hardware/customize/enterprise/shell-launcher#launch-different-shells-for-different-user-accounts)
|
||||
- [Perform an action when the shell exits](/windows-hardware/customize/enterprise/shell-launcher#perform-an-action-when-the-shell-exits)
|
||||
- [Shell Launcher user rights](/windows-hardware/customize/enterprise/shell-launcher#shell-launcher-user-rights)
|
||||
> [!div class="nextstepaction"]
|
||||
> Learn how to configure Shell Launcher:
|
||||
>
|
||||
> [Configure Shell Launcher](configure.md)
|
||||
|
||||
### :::image type="icon" source="../images/icons/rocket.svg" border="false"::: Quickstarts
|
||||
|
||||
If you want to quickly test Shell Launcher, check out the following quickstart:
|
||||
|
||||
- [Quickstart: configure a kiosk with Shell Launcher](quickstart-kiosk.md)
|
||||
|
||||
@ -1,61 +0,0 @@
|
||||
---
|
||||
title: Kiosk Mode
|
||||
ms.date: 01/18/2024
|
||||
ms.topic: overview
|
||||
description: Learn about Kiosk Mode in Windows IoT Enterprise.
|
||||
---
|
||||
|
||||
# Kiosk mode
|
||||
|
||||
Windows IoT Enterprise allows you to build fixed purpose devices such as ATM machines, point-of-sale terminals, medical devices, digital signs, or kiosks. Kiosk mode helps you create a dedicated and locked down user experience on these fixed purpose devices. Windows IoT Enterprise offers a set of different locked-down experiences for public or specialized use: [assigned access single-app kiosks](single-app-kiosk.md), [assigned access multi-app kiosks](multi-app-kiosk.md), or [shell launcher](index.md).
|
||||
|
||||
Kiosk configurations are based upon either [assigned access](../assigned-access/overview.md) or [shell launcher](index.md). There are several kiosk configuration methods that you can choose from, depending on your answers to the following questions.
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> A benefit of using an assigned access kiosk mode is [these policies](/windows/configuration/kiosk-policies) are automatically applied to the device to optimize the lock-down experience.
|
||||
|
||||
## Which type of app will your kiosk run?
|
||||
|
||||
Your kiosk can run a Universal Windows Platform (UWP) app or a Windows desktop application. For [digital signage](/windows/configuration/setup-digital-signage), select a digital sign player as your kiosk app. Check out the [Guidelines for Kiosk Apps](/windows/configuration/guidelines-for-assigned-access-app).
|
||||
|
||||
## Which type of kiosk do you need?
|
||||
|
||||
If you want your kiosk to run a single app for anyone to see or use, consider an [assigned-access single-app kiosk](/windows/configuration/shell-launcher/single-app-kiosk) that runs either a [Universal Windows Platform (UWP) app](/windows/configuration/kiosk-methods#uwp) or a [Windows desktop application](/windows/configuration/kiosk-methods#classic).
|
||||
|
||||
For a kiosk that people can sign in to with their accounts or that runs more than one app, consider an [assigned access multi-app kiosk](/windows/configuration/kiosk-methods#desktop).
|
||||
|
||||
## Which type of user account will be the kiosk account?
|
||||
|
||||
The kiosk account can be a local standard user account, a domain account, or an Azure Active Directory (Azure AD) account, depending on the method that you use to configure the kiosk. If you want people to sign in and authenticate on the device, you should use an assigned access multi-app kiosk configuration. The assigned access single-app kiosk configuration doesn't require people to sign in to the device, although they can sign in to the kiosk app if you select an app that has a sign-in method.
|
||||
|
||||
## Kiosk capabilities for Windows 10 IoT Enterprise
|
||||
|
||||
| Mode | Features | Description | Customer Usage |
|
||||
|------|----------|------------ |-----------------|
|
||||
| Assigned access | Single-app kiosk (UWP) | Auto launches a UWP app in full screen and prevents access to other system functions, while monitoring the lifecycle of the kiosk app. Only supports one single-app kiosk profile under one account per device. | Digital signs & single function devices
|
||||
| Assigned access | Single-app kiosk (Microsoft Edge) | Auto launches Microsoft Edge and prevents access to other system functions, while monitoring the lifecycle of browser. Only supports one single-app kiosk profile under one account per device. | Public browsing kiosks & digital signs |
|
||||
| Assigned access | Multi-app kiosk (Restricted User Experience) | Windows 10: Always auto launches a restricted Start menu in full screen with the list of allowed app tiles. <br/> Windows 11: Presents the familiar Windows desktop experience with a restricted set of apps. | Frontline Worker shared devices |
|
||||
| Shell launcher | Shell launcher | Auto launches an app that the customer specifies and monitors the lifecycle of this app. App can be used as a "shell" if desired. No default lockdown policies like hotkey blocking are enforced in Shell Launcher. | Fixed purpose devices with a custom shell experience |
|
||||
|
||||
## How to configure your device for kiosk mode?
|
||||
|
||||
Visit the following documentation to set up a kiosk according to your scenario:
|
||||
|
||||
* [Configure kiosks and digital signs](/windows/configuration/kiosk-methods)
|
||||
* [Set up a single-app kiosk](/windows/configuration/kiosk-single-app)
|
||||
* [Set up a multi-app kiosk](/windows/configuration/lock-down-windows-10-to-specific-apps)
|
||||
* [Configure Microsoft Edge kiosk mode](/deployedge/microsoft-edge-configure-kiosk-mode)
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Find the Application User Model ID of an installed app](/windows/configuration/find-the-application-user-model-id-of-an-installed-app)
|
||||
* [Validate your kiosk configuration](/windows/configuration/kiosk-validate)
|
||||
* [Guidelines for choosing an app for assigned access (kiosk mode)](/windows/configuration/guidelines-for-assigned-access-app)
|
||||
* [Policies enforced on kiosk devices](/windows/configuration/kiosk-policies)
|
||||
* [Assigned access XML reference](/windows/configuration/kiosk-xml)
|
||||
* [Use AppLocker to create a Windows 10 kiosk](/windows/configuration/lock-down-windows-10-applocker)
|
||||
* [Use Shell Launcher to create a Windows 10 kiosk](/windows/configuration/kiosk-shelllauncher)
|
||||
* [Use MDM Bridge WMI Provider to create a Windows 10 kiosk](/windows/configuration/kiosk-mdm-bridge)
|
||||
* [Troubleshoot kiosk mode issues](/windows/configuration/kiosk-troubleshoot)
|
||||
* [Plan your kiosk mode transition to Microsoft Edge](/deployedge/microsoft-edge-kiosk-mode-transition-plan)
|
||||
@ -1,39 +0,0 @@
|
||||
---
|
||||
title: Multi-App Kiosk
|
||||
ms.date: 08/16/2023
|
||||
ms.topic: concept-article
|
||||
description: Learn about the Multi-App Kiosk in Windows IoT Enterprise.
|
||||
---
|
||||
|
||||
# Assigned access multi-app kiosk
|
||||
|
||||
An assigned access multi-app kiosk runs one or more apps from the desktop. People using the kiosk see a customized Start that shows only the tiles for the apps that are allowed. With this approach, you can configure a locked-down experience for different account types. A multi-app kiosk is appropriate for devices that are shared by multiple people. Here's a [guide](/windows/configuration/lock-down-windows-10-to-specific-apps) on how to set up a multi-app kiosk.
|
||||
|
||||
> [!NOTE]
|
||||
> Multi-app kiosk mode isn't available for Windows 11 IoT Enterprise, version 21H2, or 22H2. Refer to [What's new for subsequent releases](/windows/iot/iot-enterprise/whats-new/release-history#windows-11-iot-enterprise) for information about its return.
|
||||
>
|
||||
> **Update** - [Multi-app kiosk mode is now available in Windows 11](https://techcommunity.microsoft.com/t5/windows-it-pro-blog/multi-app-kiosk-mode-now-available-in-windows-11/ba-p/3845558)., version 22H2 as part of the Windows continuous innovation releases. To learn how you can take advantage of features introduced via Windows continuous innovation, see more about how you can access this feature in Windows 11 IoT Enterprise, version 22H2, see [Delivering continuous innovation in Windows 11](https://support.microsoft.com/windows/delivering-continuous-innovation-in-windows-11-b0aa0a27-ea9a-4365-9224-cb155e517f12).
|
||||
|
||||
## Benefits of using a multi-app kiosk
|
||||
|
||||
The benefit of a kiosk that runs multiple specified apps is to provide an easy-to-understand experience for individuals by showing them only the things they need to use, and removing the things they don't need to access.
|
||||
|
||||
A multi-app kiosk is appropriate for devices that are shared by multiple people. Each user can authenticate with the device and receive a customized lockdown experience based on the configuration.
|
||||
|
||||
## Configuring your multi-app kiosk
|
||||
|
||||
* [Configure a kiosk in Microsoft Intune](/windows/configuration/lock-down-windows-10-to-specific-apps#configure-a-kiosk-in-microsoft-intune)
|
||||
* [Configure a kiosk using a provisioning package](/windows/configuration/lock-down-windows-10-to-specific-apps#configure-a-kiosk-using-a-provisioning-package)
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> When you configure a multi-app kiosk, [specific policies](/windows/configuration/kiosk-policies) are enforced that affects all nonadministrator users on the device.
|
||||
|
||||
## More Resources
|
||||
|
||||
* [New features and improvements](/windows/configuration/lock-down-windows-10-to-specific-apps)
|
||||
* [Set up a multi-app kiosk](/windows/configuration/lock-down-windows-10-to-specific-apps)
|
||||
* [Kiosk apps for assigned access: Best practices](/windows-hardware/drivers/partnerapps/create-a-kiosk-app-for-assigned-access)
|
||||
* [Guidelines for choosing an app for assigned access](/windows/configuration/guidelines-for-assigned-access-app)
|
||||
* [Configure kiosks and digital signs](/windows/configuration/kiosk-methods)
|
||||
* [More kiosk methods and reference information](/windows/configuration/kiosk-additional-reference)
|
||||
83
windows/configuration/shell-launcher/quickstart-kiosk.md
Normal file
83
windows/configuration/shell-launcher/quickstart-kiosk.md
Normal file
@ -0,0 +1,83 @@
|
||||
---
|
||||
title: "Quickstart: configure a single-app kiosk with Shell Launcher"
|
||||
description: Learn how to configure a signle-app kiosk experience with Shell Launcher, using the Assigned Access configuration service provider (CSP), Microsoft Intune, PowerShell, or group policy (GPO).
|
||||
ms.topic: quickstart
|
||||
ms.date: 3/7/2025
|
||||
---
|
||||
|
||||
# Quickstart: configure a kiosk with Shell Launcher
|
||||
|
||||
This quickstart provides practical examples of how to configure a *kiosk experience* on Windows with Shell Launcher. The examples describe the steps using a mobile device management solution (MDM) like Microsoft Intune, and PowerShell. While different solutions are used, the configuration settings and results are the same.
|
||||
|
||||
The examples can be modified to fit your specific requirements. For example, you can change the app used, the URL specified when opening Microsoft Edge, or change the name of the user that automatically signs in to Windows.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
>[!div class="checklist"]
|
||||
>Here's a list of requirements to complete this quickstart:
|
||||
>
|
||||
>- A Windows Enterprise or Education device
|
||||
>- Microsoft Intune, or a non-Microsoft MDM solution, if you want to configure the settings using MDM
|
||||
>- Access to the [psexec tool](/sysinternals/downloads/psexec), if you want to test the configuration using Windows PowerShell
|
||||
|
||||
## Configure a kiosk device
|
||||
|
||||
[!INCLUDE [tab-intro](../../../includes/configure/tab-intro.md)]
|
||||
|
||||
#### [:::image type="icon" source="../images/icons/intune.svg"::: **Intune/CSP**](#tab/intune)
|
||||
|
||||
> [!TIP]
|
||||
> Use the following Graph call to automatically create a custom policy in your Microsoft Intune tenant without assignments nor scope tags.
|
||||
>
|
||||
> When using this call, authenticate to your tenant in the Graph Explorer window. If it's the first time using Graph Explorer, you may need to authorize the application to access your tenant or to modify the existing permissions. This graph call requires *DeviceManagementConfiguration.ReadWrite.All* permissions.
|
||||
|
||||
[!INCLUDE [quickstart-intune](includes/quickstart-intune.md)]
|
||||
|
||||
Assign the policy to a group that contains as members the devices that you want to configure.
|
||||
|
||||
Alternatively, you can configure devices using a [custom policy][MEM-1] with the [AssignedAccess CSP][WIN-3].
|
||||
|
||||
- **Setting:** `./Vendor/MSFT/AssignedAccess/ShellLauncher`
|
||||
- **Value:**
|
||||
|
||||
[!INCLUDE [quickstart-xml](includes/quickstart-xml.md)]
|
||||
|
||||
#### [:::image type="icon" source="../images/icons/powershell.svg"::: **PowerShell**](#tab/ps)
|
||||
|
||||
[!INCLUDE [powershell-wmi-bridge-1](../../../includes/configure/powershell-wmi-bridge-1.md)]
|
||||
|
||||
[!INCLUDE [quickstart-ps](includes/quickstart-ps.md)]
|
||||
|
||||
[!INCLUDE [powershell-wmi-bridge-2](../../../includes/configure/powershell-wmi-bridge-2.md)]
|
||||
|
||||
---
|
||||
|
||||
## User experience
|
||||
|
||||
After the settings are applied, reboot the device. A local user account is automatically signed in, opening Microsoft Edge.
|
||||
|
||||
## Remove Shell Launcher
|
||||
|
||||
Once you no longer need the kiosk configuration, you can remove it.
|
||||
|
||||
Here's a PowerShell example to remove the Shell Launcher configuration:
|
||||
|
||||
```powershell
|
||||
$namespaceName="root\cimv2\mdm\dmmap"
|
||||
$className="MDM_AssignedAccess"
|
||||
$obj = Get-CimInstance -Namespace $namespaceName -ClassName $className
|
||||
$obj.ShellLauncher = $null
|
||||
Set-CimInstance -CimInstance $obj
|
||||
```
|
||||
|
||||
## Next steps
|
||||
|
||||
> [!div class="nextstepaction"]
|
||||
> Learn more how to create a Shell Launcher configuration file:
|
||||
>
|
||||
> [Create a Shell Launcher configuration file](configuration-file.md)
|
||||
|
||||
<!--links-->
|
||||
|
||||
[WIN-3]: /windows/client-management/mdm/assignedaccess-csp
|
||||
[MEM-1]: /mem/intune/configuration/custom-settings-windows-10
|
||||
@ -1,38 +0,0 @@
|
||||
---
|
||||
title: Assigned access Single-App Kiosk
|
||||
ms.date: 03/30/2023
|
||||
ms.topic: concept-article
|
||||
description: Learn about the Single-App Kiosk in Windows IoT Enterprise.
|
||||
---
|
||||
|
||||
# Assigned access single-app kiosk
|
||||
|
||||
A single-app kiosk uses the assigned access feature to run a single app above the lock screen. When the kiosk account signs in, the app is launched automatically. The person using the kiosk can't do anything on the device outside of the kiosk app.
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> Assigned access single-app kiosk mode is not supported over a remote desktop connection. Your kiosk users must sign in on the physical device that is set up as a kiosk.
|
||||
|
||||
## Benefits of using a single-app kiosk
|
||||
|
||||
A single-app kiosk is ideal for public use. Using [shell launcher](./index.md), you can configure a kiosk device that runs a Windows desktop application as the user interface. The application that you specify replaces the default shell (explorer.exe) that usually runs when a user logs on. This type of single-app kiosk runs above the lock screen, and users have access to only this app and nothing else on the system. This experience is often used for public-facing kiosk machines. Check out [Set up a kiosk on Windows 10 Pro, Enterprise, or Education](/windows/configuration/set-up-a-kiosk-for-windows-10-for-desktop-editions) for more information.
|
||||
|
||||
## Configuring your single-app kiosks
|
||||
|
||||
You have several options for configuring your single-app kiosk.
|
||||
|
||||
* [Settings App](/windows/configuration/kiosk-single-app#local)
|
||||
* [PowerShell](/windows/configuration/kiosk-single-app#powershell)
|
||||
* [Kiosk Wizard in Windows Configuration Designer](/windows/configuration/kiosk-single-app#wizard)
|
||||
* [Microsoft Intune or other MDM providers](/windows/configuration/kiosk-single-app#mdm)
|
||||
|
||||
> [!TIP]
|
||||
> You can also configure a kiosk account and app for single-app kiosk within [XML in a provisioning package](/windows/configuration/lock-down-windows-10-to-specific-apps) by using a [kiosk profile](/windows/configuration/lock-down-windows-10-to-specific-apps#profile).
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Set up a single-app kiosk](/windows/configuration/kiosk-single-app)
|
||||
* [Guidelines for choosing an app for assigned access](/windows/configuration/guidelines-for-assigned-access-app)
|
||||
* [Kiosk apps for assigned access: Best practices](/windows-hardware/drivers/partnerapps/create-a-kiosk-app-for-assigned-access)
|
||||
* [Configure kiosks and digital signs](/windows/configuration/kiosk-methods)
|
||||
* [More kiosk methods and reference information](/windows/configuration/kiosk-additional-reference)
|
||||
@ -1,25 +1,33 @@
|
||||
|
||||
items:
|
||||
- name: Shell Launcher
|
||||
- name: Overview
|
||||
href: index.md
|
||||
- name: Configure Shell Launcher
|
||||
href: configure.md
|
||||
- name: "Quickstart: Configure a kiosk"
|
||||
href: quickstart-kiosk.md
|
||||
- name: Create a configuration file
|
||||
href: configuration-file.md
|
||||
- name: Reference
|
||||
items:
|
||||
- name: Overview
|
||||
href: index.md
|
||||
- name: WMI Provider Reference
|
||||
items:
|
||||
- name: Class WESL_UserSetting
|
||||
href: wesl-usersetting.md
|
||||
- name: GetCustomShell
|
||||
href: wesl-usersettinggetcustomshell.md
|
||||
- name: GetDefaultShell
|
||||
href: wesl-usersettinggetdefaultshell.md
|
||||
- name: IsEnabled
|
||||
href: wesl-usersettingisenabled.md
|
||||
- name: RemoveCustomShell
|
||||
href: wesl-usersettingremovecustomshell.md
|
||||
- name: SetCustomShell
|
||||
href: wesl-usersettingsetcustomshell.md
|
||||
- name: SetDefaultShell
|
||||
href: wesl-usersettingsetdefaultshell.md
|
||||
- name: SetEnabled
|
||||
href: wesl-usersettingsetenabled.md
|
||||
|
||||
- name: Shell Launcher XSD
|
||||
href: xsd.md
|
||||
- name: WMI Provider
|
||||
items:
|
||||
- name: Class WESL_UserSetting
|
||||
href: wesl-usersetting.md
|
||||
- name: GetCustomShell
|
||||
href: wesl-usersettinggetcustomshell.md
|
||||
- name: GetDefaultShell
|
||||
href: wesl-usersettinggetdefaultshell.md
|
||||
- name: IsEnabled
|
||||
href: wesl-usersettingisenabled.md
|
||||
- name: RemoveCustomShell
|
||||
href: wesl-usersettingremovecustomshell.md
|
||||
- name: SetCustomShell
|
||||
href: wesl-usersettingsetcustomshell.md
|
||||
- name: SetDefaultShell
|
||||
href: wesl-usersettingsetdefaultshell.md
|
||||
- name: SetEnabled
|
||||
href: wesl-usersettingsetenabled.md
|
||||
- name: Configure Shell Launcher with WMI
|
||||
href: configure-wmi.md
|
||||
@ -1,133 +0,0 @@
|
||||
---
|
||||
title: WEDL_AssignedAccess
|
||||
description: WEDL_AssignedAccess
|
||||
ms.date: 02/25/2025
|
||||
ms.topic: reference
|
||||
---
|
||||
|
||||
# WEDL_AssignedAccess
|
||||
|
||||
This Windows Management Instrumentation (WMI) provider class configures settings for assigned access.
|
||||
|
||||
[!INCLUDE [shell-launcher](../../../includes/licensing/assigned-access.md)]
|
||||
|
||||
## Syntax
|
||||
|
||||
```mof
|
||||
class WEDL_AssignedAccess {
|
||||
[Key] string UserSID;
|
||||
[Read, Write] string AppUserModelId;
|
||||
[Read] sint32 Status;
|
||||
};
|
||||
```
|
||||
|
||||
## Members
|
||||
|
||||
The following tables list any methods and properties that belong to this class.
|
||||
|
||||
### Methods
|
||||
|
||||
This class contains no methods.
|
||||
|
||||
### Properties
|
||||
|
||||
| Property | Data type | Qualifiers | Description |
|
||||
|----------|----------------|------------|-------------|
|
||||
| **UserSID** | string | [key] | The security identifier (SID) for the user account that you want to use as the assigned access account. |
|
||||
| **AppUserModelId** | string | [read, write] | The Application User Model ID (AUMID) of the Windows app to launch for the assigned access account. |
|
||||
| **Status** | Boolean | none | Indicates the current status of the assigned access configuration |
|
||||
|
||||
| Value | Description |
|
||||
|:-----:|-------------|
|
||||
| 0 | A valid account is configured, but no Windows app is specified. Assigned access is not enabled. |
|
||||
| 1 | Assigned access is enabled. |
|
||||
| 0x100 | UserSID error: cannot find the account. |
|
||||
| 0x103 | UserSID error: the account profile does not exist. |
|
||||
| 0x200 | AppUserModelID error: cannot find the Windows app. |
|
||||
| 0x201 | Task Scheduler error: Could not schedule task. Make sure that the Task Scheduler service is running. |
|
||||
| 0xffffffff | Unspecified error.|
|
||||
|
||||
### Remarks
|
||||
|
||||
Changes to assigned access do not affect any sessions that are currently signed in; you must sign out and sign back in.
|
||||
|
||||
## Example
|
||||
|
||||
The following Windows PowerShell script demonstrates how to use this class to set up an assigned access account.
|
||||
|
||||
```powershell
|
||||
#
|
||||
#---Define variables---
|
||||
#
|
||||
|
||||
$COMPUTER = "localhost"
|
||||
$NAMESPACE = "root\standardcimv2\embedded"
|
||||
|
||||
# Define the assigned access account.
|
||||
# To use a different account, change $AssignedAccessAccount to a user account that is present on your device.
|
||||
|
||||
$AssignedAccessAccount = "KioskAccount"
|
||||
|
||||
# Define the Windows app to launch, in this example, use the Application Model User ID (AUMID) for Windows Calculator.
|
||||
# To use a different Windows app, change $AppAUMID to the AUMID of the Windows app to launch.
|
||||
# The Windows app must be installed for the account.
|
||||
|
||||
$AppAUMID = "Microsoft.WindowsCalculator_8wekyb3d8bbwe!App"
|
||||
|
||||
#
|
||||
#---Define helper functions---
|
||||
#
|
||||
|
||||
function Get-UsernameSID($AccountName) {
|
||||
|
||||
# This function retrieves the SID for a user account on a machine.
|
||||
# This function does not check to verify that the user account actually exists.
|
||||
|
||||
$NTUserObject = New-Object System.Security.Principal.NTAccount($AccountName)
|
||||
$NTUserSID = $NTUserObject.Translate([System.Security.Principal.SecurityIdentifier])
|
||||
|
||||
return $NTUserSID.Value
|
||||
}
|
||||
|
||||
#
|
||||
#---Set up the new assigned access account---
|
||||
#
|
||||
|
||||
# Get the SID for the assigned access account.
|
||||
|
||||
$AssignedAccessUserSID = Get-UsernameSID($AssignedAccessAccount)
|
||||
|
||||
# Check to see if an assigned access account is already set up, and if so, clear it.
|
||||
|
||||
$AssignedAccessConfig = get-WMIObject -namespace $NAMESPACE -computer $COMPUTER -class WEDL_AssignedAccess
|
||||
|
||||
if ($AssignedAccessConfig) {
|
||||
|
||||
# Configuration already exists. Delete it so that we can create a new one, since only one assigned access account can be set up at a time.
|
||||
|
||||
$AssignedAccessConfig.delete();
|
||||
|
||||
}
|
||||
|
||||
# Configure assigned access to launch the specified Windows app for the specified account.
|
||||
|
||||
Set-WmiInstance -class WEDL_AssignedAccess -ComputerName $COMPUTER -Namespace $NAMESPACE -Arguments @{
|
||||
UserSID = $AssignedAccessUserSID;
|
||||
AppUserModelId = $AppAUMID
|
||||
} | Out-Null;
|
||||
|
||||
# Confirm that the settings were created properly.
|
||||
|
||||
$AssignedAccessConfig = get-WMIObject -namespace $NAMESPACE -computer $COMPUTER -class WEDL_AssignedAccess
|
||||
|
||||
if ($AssignedAccessConfig) {
|
||||
|
||||
"Set up assigned access for the " + $AssignedAccessAccount + " account."
|
||||
" UserSID = " + $AssignedAccessConfig.UserSid
|
||||
" AppModelId = " + $AssignedAccessConfig.AppUserModelId
|
||||
|
||||
} else {
|
||||
|
||||
"Could not set up assigned access account."
|
||||
}
|
||||
```
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: WESL_UserSetting
|
||||
description: WESL_UserSetting
|
||||
ms.date: 02/25/2025
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: reference
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: WESL_UserSetting.GetCustomShell
|
||||
description: WESL_UserSetting.GetCustomShell
|
||||
ms.date: 02/25/2025
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: reference
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: WESL_UserSetting.GetDefaultShell
|
||||
description: WESL_UserSetting.GetDefaultShell
|
||||
ms.date: 02/25/2025
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: reference
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: WESL_UserSetting.IsEnabled
|
||||
description: WESL_UserSetting.IsEnabled
|
||||
ms.date: 02/25/2025
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: reference
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: WESL_UserSetting.RemoveCustomShell
|
||||
description: WESL_UserSetting.RemoveCustomShell
|
||||
ms.date: 02/25/2025
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: reference
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: WESL_UserSetting.SetCustomShell
|
||||
description: WESL_UserSetting.SetCustomShell
|
||||
ms.date: 02/25/2025
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: reference
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: WESL_UserSetting.SetDefaultShell
|
||||
description: WESL_UserSetting.SetDefaultShell
|
||||
ms.date: 02/25/2025
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: reference
|
||||
---
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: WESL_UserSetting.SetEnabled
|
||||
description: WESL_UserSetting.SetEnabled
|
||||
ms.date: 02/25/2025
|
||||
ms.date: 3/7/2025
|
||||
ms.topic: reference
|
||||
---
|
||||
|
||||
|
||||
193
windows/configuration/shell-launcher/xsd.md
Normal file
193
windows/configuration/shell-launcher/xsd.md
Normal file
@ -0,0 +1,193 @@
|
||||
---
|
||||
title: Shell Launcher XML Schema Definition (XSD)
|
||||
description: Shell Launcher XSD reference article.
|
||||
ms.topic: reference
|
||||
ms.date: 3/7/2025
|
||||
---
|
||||
|
||||
# Shell Launcher XML Schema Definition (XSD)
|
||||
|
||||
This reference article contains the latest Shell Launcher XML schema definition (XSD) and the XSD additions for each version of Windows.
|
||||
|
||||
## Shell Launcher XSD
|
||||
|
||||
Here's the latest Shell Launcher XSD, introduced in Windows 11:
|
||||
|
||||
```xml
|
||||
<xs:schema
|
||||
elementFormDefault="qualified"
|
||||
xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns="http://schemas.microsoft.com/ShellLauncher/2018/Configuration"
|
||||
xmlns:default="http://schemas.microsoft.com/ShellLauncher/2018/Configuration"
|
||||
xmlns:V2="http://schemas.microsoft.com/ShellLauncher/2019/Configuration" targetNamespace="http://schemas.microsoft.com/ShellLauncher/2018/Configuration">
|
||||
|
||||
<xs:import namespace="http://schemas.microsoft.com/ShellLauncher/2019/Configuration"/>
|
||||
|
||||
<xs:complexType name="profile_list_t">
|
||||
<xs:sequence minOccurs="1" maxOccurs="1">
|
||||
<xs:choice minOccurs="1" maxOccurs="1">
|
||||
<xs:element name="DefaultProfile" type="default_profile_t"/>
|
||||
<xs:element name="Profile" type="profile_t"/>
|
||||
</xs:choice>
|
||||
<xs:element name="Profile" type="profile_t" minOccurs="0" maxOccurs="unbounded"/>
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="default_profile_t">
|
||||
<xs:sequence minOccurs="1" maxOccurs="1">
|
||||
<xs:element name="Shell" type="default_shell_t" minOccurs="1" maxOccurs="1"/>
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="default_shell_t">
|
||||
<xs:sequence minOccurs="1" maxOccurs="1">
|
||||
<xs:element name="DefaultAction" type="default_action_t" minOccurs="0" maxOccurs="1"/>
|
||||
</xs:sequence>
|
||||
<xs:attribute name="Shell" type="xs:string" use="required"/>
|
||||
<xs:attribute ref="V2:AppType"/>
|
||||
<xs:attribute ref="V2:AllAppsFullScreen"/>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="custom_shell_t">
|
||||
<xs:all minOccurs="1" maxOccurs="1">
|
||||
<xs:element name="ReturnCodeActions" type="return_code_action_list_t" minOccurs="0" maxOccurs="1">
|
||||
<xs:unique name="ForbidDuplicatedReturnCodes">
|
||||
<xs:selector xpath="default:ReturnCodeAction"/>
|
||||
<xs:field xpath="@ReturnCode"/>
|
||||
</xs:unique>
|
||||
</xs:element>
|
||||
<xs:element name="DefaultAction" type="default_action_t" minOccurs="0" maxOccurs="1"/>
|
||||
</xs:all>
|
||||
<xs:attribute name="Shell" type="xs:string" />
|
||||
<xs:attribute ref="V2:AppType"/>
|
||||
<xs:attribute ref="V2:AllAppsFullScreen"/>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="default_action_t">
|
||||
<xs:attribute name="Action" type="system_action_t" use="required"/>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:simpleType name="system_action_t">
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:enumeration value="RestartShell" />
|
||||
<xs:enumeration value="RestartDevice" />
|
||||
<xs:enumeration value="ShutdownDevice" />
|
||||
<xs:enumeration value="DoNothing" />
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
<xs:complexType name="profile_t">
|
||||
<xs:sequence minOccurs="1" maxOccurs="1">
|
||||
<xs:element name="Shell" type="custom_shell_t" minOccurs="1" maxOccurs="1"/>
|
||||
</xs:sequence>
|
||||
<xs:attribute name="Id" type="guid_t" use="required"/>
|
||||
<xs:attribute name="Name" type="xs:string" use="optional"/>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:simpleType name="guid_t">
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:pattern value="\{[0-9a-fA-F]{8}\-([0-9a-fA-F]{4}\-){3}[0-9a-fA-F]{12}\}"/>
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
<xs:complexType name="return_code_action_list_t">
|
||||
<xs:sequence minOccurs="1" maxOccurs="1">
|
||||
<xs:element name="ReturnCodeAction" type="return_code_action_t" minOccurs="1" maxOccurs="unbounded"/>
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="return_code_action_t">
|
||||
<xs:attribute name="ReturnCode" type="xs:integer" use="required"/>
|
||||
<xs:attribute name="Action" type="system_action_t" use="required"/>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="config_list_t">
|
||||
<xs:sequence minOccurs="1" maxOccurs="1">
|
||||
<xs:element name="Config" type="config_t" minOccurs="0" maxOccurs="unbounded"/>
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="config_t">
|
||||
<xs:sequence minOccurs="1" maxOccurs="1">
|
||||
<xs:choice minOccurs="1" maxOccurs="1">
|
||||
<xs:element name="Account" type="account_t" minOccurs="1" maxOccurs="1">
|
||||
<xs:key name="mutexNameOrSID">
|
||||
<xs:selector xpath="."/>
|
||||
<xs:field xpath="@Name|@Sid"/>
|
||||
</xs:key>
|
||||
</xs:element>
|
||||
<xs:element name="AutoLogonAccount" type="autologon_account_t" minOccurs="1" maxOccurs="1"/>
|
||||
</xs:choice>
|
||||
<xs:element name="Profile" type="profile_id_t" minOccurs="1" maxOccurs="1"/>
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="account_t">
|
||||
<xs:attribute name="Name" type="xs:string" use="optional"/>
|
||||
<xs:attribute name="Sid" type="xs:string" use="optional"/>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="autologon_account_t">
|
||||
<xs:attribute name="HiddenId" type="guid_t" fixed="{50021E57-1CE4-49DF-99A9-8DB659E2C2DD}"/>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="profile_id_t">
|
||||
<xs:attribute name="Id" type="guid_t" use="required"/>
|
||||
</xs:complexType>
|
||||
|
||||
<!--below is the definition of the config xml content-->
|
||||
<xs:element name="ShellLauncherConfiguration">
|
||||
<xs:complexType>
|
||||
<xs:sequence minOccurs="1" maxOccurs="1">
|
||||
<xs:element name="Profiles" type="profile_list_t" minOccurs="1" maxOccurs="1">
|
||||
<xs:unique name="ForbidDuplicatedProfiles">
|
||||
<xs:selector xpath="default:Profile"/>
|
||||
<xs:field xpath="@Id"/>
|
||||
</xs:unique>
|
||||
</xs:element>
|
||||
<xs:element name="Configs" type="config_list_t" minOccurs="0" maxOccurs="1">
|
||||
<xs:unique name="ForbidDuplicatedConfigs_Name">
|
||||
<xs:selector xpath="default:Config/default:Account"/>
|
||||
<xs:field xpath="@Name"/>
|
||||
</xs:unique>
|
||||
<xs:unique name="ForbidDuplicatedConfigs_Sid">
|
||||
<xs:selector xpath="default:Config/default:Account"/>
|
||||
<xs:field xpath="@Sid"/>
|
||||
</xs:unique>
|
||||
<xs:unique name="ForbidDuplicatedAutoLogonAccount">
|
||||
<xs:selector xpath="default:Config/default:AutoLogonAccount"/>
|
||||
<xs:field xpath="@HiddenId"/>
|
||||
</xs:unique>
|
||||
</xs:element>
|
||||
</xs:sequence>
|
||||
</xs:complexType>
|
||||
</xs:element>
|
||||
</xs:schema>
|
||||
```
|
||||
|
||||
## Windows 10, version 1903 additions
|
||||
|
||||
In Windows 10, version 1903, Shell Launcher introduced the support of both UWP and desktop apps as the custom shell.
|
||||
|
||||
Here's the Shell Launcher XSD for the features added in Windows 10, version 1903:
|
||||
|
||||
```xml
|
||||
<xs:schema
|
||||
elementFormDefault="qualified"
|
||||
xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns="http://schemas.microsoft.com/ShellLauncher/2019/Configuration"
|
||||
xmlns:default="http://schemas.microsoft.com/ShellLauncher/2019/Configuration" targetNamespace="http://schemas.microsoft.com/ShellLauncher/2019/Configuration">
|
||||
|
||||
<xs:attribute name="AppType">
|
||||
<xs:simpleType>
|
||||
<xs:restriction base="xs:string">
|
||||
<xs:enumeration value="UWP"/>
|
||||
<xs:enumeration value="Desktop"/>
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
</xs:attribute>
|
||||
|
||||
<xs:attribute name="AllAppsFullScreen" type="xs:boolean"/>
|
||||
|
||||
</xs:schema>
|
||||
```
|
||||
Reference in New Issue
Block a user