Local Setup

A local setup in the context of OSDCloud refers to preparing and configuring all the necessary tools, files, and environments on your local machine to enable OSDCloud functionality.

This setup ensures that everything required for OSDCloud to deploy Windows—such as OSDCloud scripts, drivers, modules, and the WinPE boot environment—is installed and configured on your computer.

With a local setup, you can create deployment media (e.g., USB or ISO) and use it to deploy Windows.

Tip

Perform your local setup in a dedicated environment to avoid conflicts. A virtual machine with USB passthrough or a dedicated computer not used for other tasks is highly recommended.

Prerequisites

https://www.osdcloud.com/osdcloud/setup#prerequisites

When setting up a local configuration, you need to ensure the following resources are available:

  • Admin Rights:
    The OSDCloud script requires administrative privileges to perform tasks such as mounting WIM files. Ensure that the device you use to set up your local configuration has admin rights.

  • Open Internet:
    Since the primary purpose of OSDCloud is to deploy Windows over the internet, an open and unrestricted internet connection is required.

  • OSD PowerShell Module
    OSDCloud utilizes the OSD PowerShell Module, created by the same developer, to perform most of its tasks. Since the module is frequently updated, it is important to ensure you have access to the latest version.

  • PowerShell Knowledge:
    You should have a basic understanding of PowerShell or be willing to learn how to use it.

Machine Configuration

Caution

OSDCloud operates within a Windows Preinstallation Environment (Windows PE) and can also utilize the Windows Recovery Environment (WinRE).
The version of Windows you use to configure your OSDCloud local environment affects certain functionalities:

  • Wireless Network:
    As of this writing, the WinRE for Windows 11 does not provide the same level of support for wireless networks as its Windows 10 counterpart.
  • Compatibility with older systems and virtual machines:
    To ensure support for older hardware and virtual machines, it is recommended to configure your local setup using Windows 10 instead of Windows 11.

Configuring your local setup on Windows 10 or Windows 11 requires installing the appropriate version of the Windows Assessment and Deployment Kit (Windows ADK) along with the corresponding Windows PE add-on.

Windows ADK

The Windows Assessment and Deployment Kit (ADK) is a comprehensive set of tools created for IT professionals to deploy, customize, and manage Windows operating systems. It also facilitates performance assessments and diagnostics to improve system and component quality.

Key Features:

  • Customization:
    Modify Windows images for deployment.
  • Deployment Tools:
    Includes tools like Windows PE, Sysprep, and others for large-scale OS deployment.
  • Performance Assessment:
    Evaluate system performance using the Windows Assessment and Performance Toolkits.
  • Compatibility:
    Works with various Windows versions; however, using the correct ADK version for your system is crucial to avoid compatibility issues.

(Optional) Microsoft DaRT Integration

If you have Microsoft Desktop Optimization Pack 2015, you can install Microsoft DaRT 10. This will allow you to have DaRT Tools in your OSDCloud WinPE Media

Configuration

With the prerequisites in place, the next step is to set up the local environment for installing the Windows ADK and Windows PE add-on.

This can be done using a spare computer, a virtual machine (VM), or a server. Once you’ve chosen your platform, proceed with installing the Windows OS and the required tools.

Caution

OSDCloudUSB
OSDCloudUSB lets you create a bootable USB drive with a WinPE environment preconfigured for OSDCloud. When booted, the media automatically runs the OSDCloud commands needed to install Windows on the target device.

To create an OSDCloud bootable media:

  • A system running Windows 10 (version 1703 or later) or Windows 11.
  • For virtual machines (VM), ensure USB passthrough is enabled.

USB passthrough:
USB passthrough is a feature available in virtualization platforms like VMware and Proxmox Virtual Environment. It allows USB devices to be disconnected from the host computer and connected directly to virtual machines (VMs). This enables seamless use of USB devices in VMs, as though they were physically attached.

Download Windows

As mentioned in the Machine Configuration section, the version of Windows you use to configure your OSDCloud local environment impacts certain functionalities.

The first decision to make is whether you need wireless support in WinPE. If wireless functionality is required, you must create your OSDCloud Template on Windows 10, as it uses Windows 10’s WinRE. Windows 11’s WinRE is incompatible with older systems and virtual machines.

Here are some resources to help you download Windows:

Windows installation

For an OSDCloud local setup, no special Windows configuration is required. The only requirement is having access to an administrative account with full privileges on the operating system.

Windows activation

You may need to activate Windows during installation. If your local setup is intended to be permanent, consider activating it with a legitimate activation key purchased from Microsoft.

Alternatively, you can use a generic key provided by Microsoft for installation purposes. Visit the official Microsoft Learn page for more details:

https://learn.microsoft.com/en-us/windows-server/get-started/kms-client-activation-keys?tabs=windows1110ltsc%2Cwindows81%2Cserver2025%2Cversion1803

Disadvantages and Limitations of Unactivated Windows 11/10

These are some disadvantages and limitations of unactivated Windows 11/10:

  • The Activate Windows watermark
  • Activation message on Windows Settings
  • No Personalization settings
  • Frequent notification to activate Windows

That said, whether you activate Windows or not, it won’t prevent you from using OSDCloud.

Download the Windows ADK and the WinPE add-on

The different links to download the recent and earlier versions of the Windows Assessment and Deployment Kit (ADK) are available on the official Microsoft Learn website.

https://learn.microsoft.com/en-us/windows-hardware/get-started/adk-install#other-adk-downloads

Always ensure you download the ADK version compatible with your Windows setup to avoid potential errors.

Windows 10:

Download the ADK for Windows 10, version 2004:
This ADK supports Windows 10, version 2004, and later versions of Windows 10

Windows 11:

Download the Windows ADK 10.1.26100.2454 (December 2024):

The Windows ADK 10.1.26100.2454 (December 2024) and the Windows PE add-on for this ADK support the following OS releases:

  • Windows 11, version 24H2 and all earlier supported versions of Windows 10 and 11
  • Windows Server 2025, and Windows Server 2022

Installation of the Windows ADK and the WinPE Add-on

Windows Assessment and Deployment Kit (ADK)

During the installation, you can keep the default parameters. However, ensure that you select Deployment Tools in the Select the features you want to install section.

Deploymnent Tools
Tools to customize and manage Windows images and to automate installation.

Windows Preinstallation Environnement (PE) for Windows

After completing the installation of the ADK Deployment Tools, proceed to install the Windows PE Add-on for the ADK you just installed.

Installing the OSD module

Installing the OSD Module The final steps involve ensuring that your system’s Execution Policy is set correctly and installing the OSD PowerShell Module.

Open an administrative PowerShell window.

Execute the following command to set the Execution Policy:

Set-ExecutionPolicy RemoteSigned -Force

Then, execute the following command to install the OSD Module:

Install-Module OSD -Force

TLDR

Setting up a local OSDCloud environment requires several steps, but once completed, it unlocks the full potential of the OSDCloud module for deploying Windows 10/11.

Key Steps

  1. Ensure you have:

    • Admin rights.
    • An open internet connection.
    • The latest OSD PowerShell Module.
    • Basic PowerShell knowledge.

  2. Machine Configuration:

    • Use Windows 10 WinRE for:
      • Wireless network support.
      • Compatibility with older systems and virtual machines.

  3. Windows Setup:

    • Download Windows ISOs from trusted sources:
      • Microsoft (recommended).
      • Other verified platforms (e.g., massgrave.dev).

  4. Windows ADK Installation:

    • Install:
      • Deployment Tools (for customizing and managing Windows images).
      • Windows PE add-on (to add Preinstallation Environment functionality).

  5. OSD Module Installation:

    • Open PowerShell and run the following commands: powershell
      Set-ExecutionPolicy RemoteSigned -Force
      Install-Module OSD -Force

What This Setup Enables

  • Customization Options:
    • Modify default wallpaper and configure drivers and modules.
    • Adjust OSDCloud startup behavior in WinPE.
  • Deployment Tools:
    • Create bootable ISO Media for OSDCloud.
    • Create an OSDCloud USB to:
      • Boot to WinPE and download everything from the internet.
      • Support offline deployments with no internet connection required.