Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@gdiaz384
gdiaz384 committed May 13, 2016
1 parent ddb00ca commit 3e24064
Showing 1 changed file with 53 additions and 41 deletions.
94 changes: 53 additions & 41 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ The development emphasis is on zero-configuration "just works" software.

## Screenshots:

![Screenshot1](debug\AutoImage.png)
![Screenshot2](debug\WindowsBootMgr.png)
![Screenshot1](debug/AutoImage.png)
![Screenshot2](debug/WindowsBootMgr.png)

## Features:

Expand All @@ -31,62 +31,63 @@ The development emphasis is on zero-configuration "just works" software.
- Stage AriaDeploy
- Stage AutoImage (Automatically detect and install WIM/ESD images)
- Provide a CLI frontend for DISM to help capture/deploy WIM images manually
- Note: GImageX is also included.
- Note: GImageX is also included as a gooey front-end.
- Creates a WinPE workspace to easily make changes to WIM images.

## Use Cases:

- The "How do I Clean Install?" problem solved. Forever.
- Upgrade to Win 7 or downgrade to Win 10 at leasure.
- Use predefined images on computers that need fixing (OEM style)
1. The "How do I Clean Install?" problem solved. Forever.
2. Upgrade to Win 7 or downgrade to Win 10 at leasure.
3. Use predefined images on computers that need fixing (OEM style)
- Recovery tools (can) include DaRT+WindowsRE and a boot menu at startup
- Run arbitary windows software in a temporary (WinPE) environment
- Compare arbitary Windows versions (such as Windows 10 Enterprise LTSB vs RTM Home)
- Quickly regenerate WinPE images when minor changes need to be made.
- Configure WinPE multiboot scenarios on either USB or on target systems (i.e. boot WinRE or DaRT for recovery purposes)
- Save time when installing arbitary Windows versions in VM enviornments (especially when compiling software)
- Create a .wim backup of the current OS (image.bat or GImageX) for either restoration or deployment
- Can be used with "hard disk swap" scenarios
- Can be used with "hardware transfer" scenarios
- Create ESDs and deploy MS downloaded ESDs directly
- Stage AriaDeploy
4. Run arbitary windows software in a temporary (WinPE) environment
5. Compare arbitary Windows versions (such as Windows 10 Enterprise LTSB vs RTM Home)
6. Quickly regenerate WinPE images when minor changes need to be made.
7. Configure WinPE multiboot scenarios on either USB or on target systems (i.e. boot WinRE or DaRT for recovery purposes)
8. Save time when installing arbitary Windows versions in VM enviornments (especially when compiling software)
9. Create a .wim backup of the current OS (image.bat or GImageX) for either restoration or deployment
10. Can be used with "hard disk swap" scenarios
11. Can be used with "hardware transfer" scenarios
12. Create ESDs and deploy MS downloaded ESDs directly
13. Stage AriaDeploy

## Download:
```
Latest Version: none
In Development: 0.1.0-beta
Latest Version: 0.1.0-beta
In Development: 0.1.0-rc1
```
Click [here](//github.com/gdiaz384/ADKTools/releases) or on "releases" at the top to download the latest version.

## Typical Usage Guide:

1. Obtain a 32GB (minimum) or 64GB (recommended) flash drive
2. In a VM, download ADKTools from [url] and extract.
3. Check to make sure it will not sleep when idle (control panel->power options->change plan settings)
1. Obtain a 32GB (minimum) or 64GB (recommended) flash drive [Ebay Search](//www.ebay.com/sch/i.html?_odkw=usb+64+3.0&Brand=ADATA|Kingston|Patriot%2520Memory|Samsung&_sop=15&LH_ItemCondition=3&_dcat=51071&_osacat=51071&_from=R40&_trksid=p2045573.m570.l1313.TR0.TRC0.H0.Xusb+64+3.0+newegg.TRS0&_nkw=usb+64+3.0+newegg&_sacat=51071)
2. In a VM, download ADKTools from [here](//github.com/gdiaz384/ADKTools/releases) and extract.
3. Check to make sure the VM will not sleep when idle (control panel->power options->change plan settings)
4. Start an administrative cmd prompt (or disable UAC) and navigate to ADKTools\
5. Run installADK.bat to install at least one of the ADKs (AIK != ADK). All 3 (AIK + ADKs x2) are preferred.
6. Wait to install AIK manually (next->next->next)
7. Run createWinPE.bat to generate updated WinPE.wim files
- Note: WDS can PXE boot these WinPE.wim files (WDS 2012+ does both BIOS PXE and UEFI PXE)
- Note: Windows Deployment Services (WDS) can PXE boot these WinPE.wim files (WDS 2012+ does both BIOS PXE and UEFI PXE)
8. If not using WDS: Use a Deployment Prompt and run "convertWim" or "massupdate" to generate ISO files from WinPE.wim. (massupdate export)
- Note: It is possible to burn these ISO files to optical media.
9. Obtain installer.wim files (or ISOs) for the versions/architectures/editions of windows to install. MS links:
- [Windows 7](//www.microsoft.com/en-us/software-download/windows7), [Windows 8.1](//www.microsoft.com/en-us/software-download/windows8), [Windows 10](//www.microsoft.com/en-us/software-download/windows10)
Note: With ISOs (win7x64.iso) look for sources\install.wim, (not boot.wim). Extract out and rename them appropriately.
- Note: With ISOs, look for sources\install.wim, (not boot.wim). Extract out and rename them appropriately.
- "dism /get-wiminfo /wimfile:c:\install.wim" to check the included editions
10. Copy any WIM images (install.wim\win7x64.wim) to ADKTools\WININSTALLER\sources
11. Download [Rufus](//rufus.akeo.ie) and insert USB drive from step #1
12. Launch Rufus, Alt+E, and then make a USB drive bootable with the following settings:
![RufusSettings](debug\RufusSettings.png)
![RufusSettings](debug/RufusSettings.png)
13. After formating completes, copy WININSTALLER\ contents to flash drive.
14. Safely eject the USB drive.
15. Boot the target system from USB drive. Consult manufactuer's documentation for this.
16. Follow the onscreen menus.
15. Boot the target system from USB drive. Consult the manufacturer's documentation for this.
16. Follow the onscreen menus provided by autoImage.bat

## Advanced Usage Notes:

### To automatically map network drives (SMB) to image systems over the network:
### To automatically map drives to image over the network:

1. Install and configure an FTP server (FileZilla)[//sourceforge.net/projects/filezilla/files/FileZilla%20Server/0.9.57/FileZilla_Server-0_9_57.exe/download]
1. Install and configure an FTP server [FileZilla](//sourceforge.net/projects/filezilla/files/FileZilla%20Server/0.9.57/FileZilla_Server-0_9_57.exe/download)
2. create a text file named "credentialsForNetworkDrive.txt" with the following contents:
```
clientDriveLetter=Y
Expand All @@ -105,7 +106,7 @@ deployClientPathAndExe=AriaDeploy\client\AriaDeployClient.bat
Example Path:
```
C:\Users\User\Desktop\winPEWorkspace\Images\Win7\Win7Sp1_x64_RTM.wim
net share myshare$=C:\Users\User\Desktop\winPEWorkspace /grant:user,READ
net share myshare$=C:\Users\User\Desktop\winPEWorkspace /grant:limitedAccount,READ
```
7. Allow ICMP echo requests through the local firewall
8. Disable FTP server when not in use to limit exposure.
Expand Down Expand Up @@ -137,52 +138,63 @@ Note: Drivers from winPEWorkspace\Updates\drivers\3_x\x86 will be installed auto
### To facilitate a post-imaging boot menu that includes DaRT/WinRE/WinPE (normal install):

Place the following files in "WININSTALLER\sources\Win7\winPETools":
```
DaRT7_x86.wim, DaRT7_x64.wim
WinRE31_x86.wim, WinRE31_x64.wim
WinPE31_x86.wim, WinPE31_x64.wim
```

Place the following files in "WININSTALLER\sources\Win81\winPETools":
```
DaRT81_x86.wim, DaRT81_x64.wim
WinRE51_x86.wim, WinRE51_x64.wim
WinPE51_x86.wim, WinPE51_x64.wim
```

Place the following files in "WININSTALLER\sources\Win10\winPETools":
```
DaRT10_x86.wim, DaRT10_x64.wim
WinRE10_x86.wim, WinRE10_x64.wim
WinPE10_x86.wim, WinPE10_x64.wim
```

To reduce the user prompt duration: "bcdedit /timeout 3"
On Win8-10, the legacy boot menu is also recommended: "bcdedit /set {default} bootmenupolicy legacy"
- To reduce the user prompt duration: "bcdedit /timeout 3"
- On Win8-10, the legacy boot menu is also recommended: "bcdedit /set {default} bootmenupolicy legacy"
- For more information on Microsoft's Diagnostics and Recovery Toolset: ([DaRT](//technet.microsoft.com/en-us/windows/hh826071))
- For additional information on Windows Recovery Enviornment: ([WinRE](//technet.microsoft.com/en-us/library/cc765966%28v=ws.10%29.aspx))

### To add additional DaRT/WinRE/WinPE.wim images to the USB boot menu:

TODO: put stuff here (bcdaddpe.bat)

### To automate the Windows Out-of-the-Box Experience (OOBE):

- Unattend.xml files are used to automate the OOBE and are Windows Version (7-10) Architecture (x86/x64/ia64) and Edition (Home/Pro/Ent) specific.
- Templates for them, without product keys, can be found at ADKTools\resources\archives\unattendXml_nokeys.zip
- Please insert the product key purchased from Microsoft in the appropriate .xml file and place at scripts\peRuntime\scripts\unattendxml
- Enter the key purchased from Microsoft in the appropriate xml file and place at scripts\peRuntime\scripts\unattendxml
- If your organization's deployment strategy updates windows licenses post deployment (via slmgr or KMS) then these keys are available for use to automate OOBE: [KMS Client Setup Keys](//technet.microsoft.com/en-us/library/jj612867.aspx)

## Release Notes:

- This is "beta" quality-level software.
- If downloading from github manually (instead of using an official release.zip) remember to change the line ending format from Unix back to Windows using Notepad++.
- This is "beta" quality-level software. Some of the scripts could use "touch ups" and additional testing.
- When setting up a complicated partition layout (more than the default wipe/reload on disk 0 with an RE tools partition), refer to the [documentation on diskpart](//technet.microsoft.com/en-us/library/cc766118%28v=ws.10%29.aspx) and use "image.bat" with the "/noformat" switch. image /? for additional information.
- If downloading from github manually (instead of using an official release.zip) remember to change the line ending format from Unix back to Windows using [Notepad++](//notepad-plus-plus.org/download).
- MUI versions of WinPE and other ADKTools aspects are not currently supported.
- I am still tweaking on the scripts to automatically install drivers on install.wim deployments. In the meantime, they can be manually installed via the DISM tool. Type "help" in the WinPE enviornment or "dism /online /add-driver /?" for the exact syntax.
- ADKTools is not developed, tested against or designed to work with UAC enabled.
- WinPEx64 versions have Miku Mode enabled by default.
- To disable Miku Mode: ADKTools\resources\scripts\wimMgmt\update.bat->set MikuModeEnabled=false and then reset the image (massupdate reset).
- For USB multiboot scenarios, the windows binaries for booting purposes (bootmgr/bootmgr.efi) are version specific (although 8-10 should be cross compatible) and need to be swapped if needing to boot Windows 7 (e.g. WinPE3+ derivates) and vice versa.
- For USB multiboot scenarios, the windows binaries for booting purposes (bootmgr/bootmgr.efi) are version specific (although 8-10 should be cross compatible) and need to be swapped (from sources\WinPEBootFiles\bootmanager) when booting Windows 7 (e.g. WinPE3+ derivatives) and vice versa.

## Hardware Notes:

- Remember that when not using a Compatability Support Module (CSM) boot mode, the native UEFI architecture must still match the running OS version. This applies both to the PE and installed OS.
- If a hardware manufactuer implemented the UEFI API in a weird way (most do), then bcdboot cannot add the boot entry reliably.
- Expect to add UEFI boot entries manually to the NVRAM boot menu (NVRAM boot menu != windows boot manager) [more](//homepage.ntlworld.com/jonathan.deboynepollard/FGA/efi-boot-process.html) (information)[//www.happyassassin.net/2014/01/25/uefi-boot-how-does-that-actually-work-then/] or instead consider using CSM/BIOS boot mode.
- The manufactuer of Hardware X did not make drivers for Windows Version Y.
- Remember that when not using a Compatability Support Module (CSM), the native UEFI architecture must match the running OS version. This applies both to the PE and installed OS.
- If a hardware manufacturer implemented the UEFI API in a weird way (most do), then bcdboot cannot add the boot entry reliably.
- Expect to add UEFI boot entries manually to the NVRAM boot menu (NVRAM boot menu != windows boot manager) [more](http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/efi-boot-process.html) [information](//www.happyassassin.net/2014/01/25/uefi-boot-how-does-that-actually-work-then) or instead consider using CSM/BIOS boot mode.
- Hardware manufacturer X did not make drivers for Windows Version Y for Model Z.
- Please consult the system unit's OEM website to see which OSs and in what configurations they support. Not following the OEM's advice can mean drivers may become an issue.
- Also check if a driver pack is available: [Dell](//en.community.dell.com/techcenter/enterprise-client/w/wiki/2065.dell-command-deploy-driver-packs-for-enterprise-client-os-deployment), [HP](//www8.hp.com/us/en/ads/clientmanagement/drivers-pack.html), [Lenovo](//support.lenovo.com/us/en/documents/ht074984)
- For single deployments of non-RTM images, the only important driver to install after the imaging process but before booting is the storage driver (SATA/AHCI/RAID). The rest can be installed after windows setup completes.
- For single deployments of non-RTM images, the only important driver to install after the imaging process (but before booting) is the storage driver (SATA/AHCI/RAID). The rest can be installed after windows setup completes.

## Dependencies:

Expand All @@ -193,6 +205,6 @@ On Win8-10, the legacy boot menu is also recommended: "bcdedit /set {default} bo
- ~2 hours to download + install.

## License:
- I am not responsible for you deleting your data, messing up your flashdrive, windows install, activation status or anything ever period.
- I am not responsible for you deleting your data, messing up your flashdrive, OS install, activation or anything ever period.
- I make no claim that said software is "fit" to perform any particular purpose and provide no warranty or assurance of quality any kind. Neither is implied nor given.
- For additional licensing information, pick your License: GPL (any) or BSD (any) or MIT/Apache

0 comments on commit 3e24064

Please sign in to comment.