mirror of
https://github.com/ChrisTitusTech/winutil
synced 2026-02-04 23:10:10 +00:00
Move docs over. (#3760)
* Docs * Update docs.yaml * Delete docs/LICENCE * Delete docs/README.md * Update module path in go.mod
This commit is contained in:
Real-MullaC
7
docs/content/userguide/_index.md
Normal file
7
docs/content/userguide/_index.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: User Guide
|
||||
weight: 1
|
||||
---
|
||||
|
||||
Welcome to the official User Guide for **Winutil**, your all-in-one Windows toolkit.
|
||||
This document will walk you through installation, configuration, and usage of Winutil’s powerful features.
|
||||
23
docs/content/userguide/automation/_index.md
Normal file
23
docs/content/userguide/automation/_index.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Automation
|
||||
weight: 7
|
||||
---
|
||||
|
||||
* Some features are available through automation. This allows you to save your config file, pass it to Winutil, walk away and come back to a finished system. Here is how you can set it up currently with Winutil >24.01.15
|
||||
|
||||
* On the Install Tab, click "Get Installed", this will get all installed apps **supported by Winutil** on the system.
|
||||
{{< image src="images/Get-Installed" alt="GetInstalled" >}}
|
||||
|
||||
* Click on the Settings cog in the upper right corner and choose Export. Choose file file and location; this will export the setting file.
|
||||
{{< image src="images/Settings-Export" alt="SettingsExport" >}}
|
||||
|
||||
* Copy this file to a USB or somewhere you can use it after Windows installation.
|
||||
|
||||
> [!TIP]
|
||||
> Use the Microwin tab to create a custom Windows image & install the Windows image.
|
||||
|
||||
* On any supported Windows machine, open PowerShell **as Admin** and run the following command to automatically apply tweaks and install apps from the config file.
|
||||
```
|
||||
iex "& { $(irm https://christitus.com/win) } -Config [path-to-your-config] -Run"
|
||||
```
|
||||
* Have a cup of coffee! Come back when it's done.
|
||||
44
docs/content/userguide/features/_index.md
Normal file
44
docs/content/userguide/features/_index.md
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: Features
|
||||
weight: 4
|
||||
---
|
||||
|
||||
* Install the most used **Windows Features** by checking the checkbox and clicking "Install Features" to install them.
|
||||
|
||||
* All .Net Frameworks (2, 3, 4)
|
||||
* HyperV Virtualization
|
||||
* Legacy Media (WMP, DirectPlay)
|
||||
* NFS - Network File System
|
||||
* Enable Search Box Web Suggestions in Registry (explorer restart)
|
||||
* Disables Search Box Web Suggestions in Registry (explorer restart)
|
||||
* Enable Daily Registry Backup Task 12:30am
|
||||
* Enable Legacy F8 Boot Recovery
|
||||
* Disable Legacy F8 Boot Recovery
|
||||
* Windows Subsystem for Linux
|
||||
* Windows Sandbox
|
||||
|
||||
### Fixes
|
||||
* Quick fixes for your system if you are having issues.
|
||||
|
||||
* Set Up Autologin
|
||||
* Reset Windows Update
|
||||
* Reset Network
|
||||
* System Corruption Scan
|
||||
* WinGet Reinstall
|
||||
* Remove Adobe Creative Cloud
|
||||
|
||||
### Legacy Windows Panels
|
||||
|
||||
Open old-school Windows panels directly from Winutil. Following Panels are available:
|
||||
|
||||
* Control Panel
|
||||
* Network Connections
|
||||
* Power Panel
|
||||
* Region
|
||||
* Sound Settings
|
||||
* System Properties
|
||||
* User Accounts
|
||||
|
||||
### Remote Access
|
||||
|
||||
Enables OpenSSH server on your windows machine.
|
||||
159
docs/content/userguide/microwin/_index.md
Normal file
159
docs/content/userguide/microwin/_index.md
Normal file
@@ -0,0 +1,159 @@
|
||||
---
|
||||
title: Microwin
|
||||
weight: 6
|
||||
---
|
||||
|
||||
MicroWin is our in-house solution for customized and debloated Windows images. With MicroWin, you can create images that have minimal bloat and no interruptions. This has an upside: you can get more done and use Windows the way **you** want.
|
||||
|
||||
Due to MicroWin using standard Windows system administration tools, such as DISM (Deployment Image Servicing and Management), advanced Windows users (system administrators and tech enthusiasts) can continue making changes so that they can have their own set of customizations with their ISO files.
|
||||
|
||||
If you're excited to try this out, let's go through how to use it. You'll be done in a short time!
|
||||
|
||||
## Basic usage
|
||||
|
||||
To start with MicroWin, go to its tab. You will see the following:
|
||||
|
||||
{{< image src="images/microwin/microwin-screen" >}}
|
||||
|
||||
From this screen, you'll have to do one of the following:
|
||||
|
||||
- **Select the ISO file:** if you have already downloaded a Windows ISO file, select it and click OK
|
||||
- **Get an ISO file automatically:** if you don't have an ISO file ready, and don't want to waste time going to the download page, you can grab the latest versions of Windows easily. Select your preferred version and the language of the ISO file, and its destination, and you will have an ISO file in no time.
|
||||
|
||||
{{< image src="images/microwin/microwin-downloader" >}}
|
||||
|
||||
> [!NOTE]
|
||||
When downloading your ISO file, network conditions (such as speed and location) can affect the time you have to wait for the download to complete and the availability of such download.
|
||||
|
||||
### Compatibility
|
||||
|
||||
You may be wondering if your Windows image is compatible with the MicroWin process. Because of this, we present to you a compatibility list:
|
||||
|
||||
| Version | Compatible? |
|
||||
|:--|:--|
|
||||
| Windows 7 | ❌ Not supported |
|
||||
| Windows 8 | ❌ Not supported |
|
||||
| Windows 8.1 | ❌ Not supported |
|
||||
| Windows 10 | ℹ️ Only the latest versions are supported, and you will not get the full experience |
|
||||
| Windows 11 | 👍 Supported (21H2-24H2) |
|
||||
|
||||
After getting information about your ISO file, you will see the following screen:
|
||||
|
||||
{{< image src="images/microwin/microwin-screen-full" >}}
|
||||
|
||||
### Requirements
|
||||
|
||||
To successfully use MicroWin with your Windows image, you need the following:
|
||||
|
||||
- **The latest versions of Windows 10, or Windows 11**
|
||||
- **Enough space**. We recommend having, at least, double the size of your ISO file. However, you may need more if you want to inject drivers
|
||||
|
||||
## Options
|
||||
|
||||
### Choosing your index
|
||||
|
||||
By default, MicroWin will target the Pro edition of Windows. The Pro edition is a good baseline for IT administrators **and** end-users, due to the inclusion of Group Policy, the ability to join domains, and more things that you can't find with the Home edition. For more information, check out [this comparison chart](https://en.wikipedia.org/wiki/Windows_10_editions#Comparison_chart).
|
||||
|
||||
Obviously, you should pick the edition of Windows for which you have a license. To change the edition to process, select the drop-down menu under "Choose Windows SKU" and select your edition.
|
||||
|
||||
{{< image src="images/microwin/microwin-skuselect" >}}
|
||||
|
||||
### Injecting drivers
|
||||
|
||||
If you want to use MicroWin on a real system, you may want to include the drivers for it, to avoid setting them up after OS installation. That's where the options to inject drivers come in handy.
|
||||
|
||||
- **Injecting drivers:** if you want to install MicroWin on another system, simply check this option. Prepare a folder with the drivers of your system and specify it in the UI. To learn more about how to export the drivers, read the section "Exporting drivers"
|
||||
- **Importing drivers:** if you want to install MicroWin on **your** system, you can apply the drivers of your system to the image by importing them. Combine that with the former option, and you can have your driver files stored permanently on your preferred location
|
||||
- **Injecting VirtIO drivers:** if you plan on using the target Windows image with QEMU/Proxmox VE, or any UI that uses it (like `virt-manager` on Linux), you can automatically download the VirtIO driver ISO and put its contents into your ISO file
|
||||
|
||||
> [!NOTE]
|
||||
Injecting VirtIO drivers is only supported on v25.01.11 and later
|
||||
|
||||
Of course, you can continue without setting up drivers. Simply leave the options blank and continue with the process.
|
||||
|
||||
#### How do I export drivers?
|
||||
|
||||
To export the drivers, you can do the following on many utilities:
|
||||
|
||||
##### DISM
|
||||
|
||||
To export the drivers using DISM (via the command-line), do the following:
|
||||
|
||||
1. Launch the command-line interpreter you want (`cmd`, PowerShell...) **as an administrator**
|
||||
2. Go to where you want to place the drivers with `cd`, and create a directory called "drivers" (`md drivers`)
|
||||
3. Run the following command: `dism /online /export-driver /destination="<path-to-folder>"`
|
||||
4. Wait for the drivers to be exported
|
||||
|
||||
##### Driver Store Explorer (RAPR)
|
||||
|
||||
To export the drivers using [Driver Store Explorer (RAPR)](https://github.com/lostindark/DriverStoreExplorer/), do the following:
|
||||
|
||||
1. Go to "File > Export All Drivers"
|
||||
|
||||
{{< image src="images/microwin/rapr_menu" >}}
|
||||
|
||||
2. Choose the folder to export all the drivers to and click OK
|
||||
|
||||
{{< image src="images/microwin/rapr_folderpicker" >}}
|
||||
|
||||
##### DISM++
|
||||
|
||||
To export the drivers using [DISM++](https://github.com/Chuyu-Team/Dism-Multi-language), do the following:
|
||||
|
||||
1. Select your active installation if you haven't (it's the first item)
|
||||
2. Go to "Drivers", select "All" and select "Export"
|
||||
|
||||
{{< image src="images/microwin/dism++_drivercontrol" >}}
|
||||
|
||||
3. Choose the folder to export all the drivers to and click OK
|
||||
|
||||
{{< image src="images/microwin/dism++_driverexport" >}}
|
||||
|
||||
##### DISMTools
|
||||
|
||||
To export the drivers using [DISMTools](https://github.com/CodingWonders/DISMTools), do the following:
|
||||
|
||||
1. Select "Manage online installation" in the home screen and accept the warning
|
||||
|
||||
{{< image src="images/microwin/dt_activeinst" >}}
|
||||
|
||||
2. Go to "Commands > Drivers > Export driver packages..."
|
||||
|
||||
{{< image src="images/microwin/dt_exportdrvs" >}}
|
||||
|
||||
3. Choose the path to export the drivers to ("Export target") and click OK
|
||||
|
||||
{{< image src="images/microwin/dt_exporttarget" >}}
|
||||
|
||||
##### Other UIs
|
||||
|
||||
To export the drivers using another UI, read its documentation.
|
||||
|
||||
#### Using VirtIO drivers
|
||||
|
||||
After the drivers from the Ventoy ISO are copied, do the following if you can't see any drives on your QEMU VM:
|
||||
|
||||
1. In the disk selection screen, select "Load driver"
|
||||
2. Click "Browse" and select `D:\VirtIO\vioscsi\w11\amd64` (replace `amd64` with `ARM64` if you want to use Windows on ARM)
|
||||
3. Select all drivers in the list and click OK
|
||||
|
||||
You should be able to see your disks now.
|
||||
|
||||
### Copying to Ventoy
|
||||
|
||||
If you have a Ventoy drive, you can copy your ISO file to it quickly and easily. This is done after it has been created. To do this, simply check "Copy to Ventoy".
|
||||
|
||||
You can learn more about Ventoy drives [here](https://www.ventoy.net/en/index.html).
|
||||
|
||||
### Setting up a custom user
|
||||
|
||||
If you want to set up a custom user, effectively creating a completely unattended installation, you can set up a user name and password:
|
||||
|
||||
{{< image src="images/microwin/microwin-customuser" >}}
|
||||
|
||||
> [!NOTE]
|
||||
To set up a custom user, you need to specify its name, which cannot surpass 20 characters. Otherwise, a user named "User" will be created. However, you don't need to set up a password. If you leave the password box blank, you can take advantage of auto-logons, but **do what you think it's best for your use case**.
|
||||
|
||||
After configuring all your desired settings, click "Start the process" and specify the location of your ISO file.
|
||||
|
||||
Now, you have to wait for the magic to happen. This can take between 5-10 minutes, but it depends on the performance of your computer.
|
||||
39
docs/content/userguide/store/_index.md
Normal file
39
docs/content/userguide/store/_index.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Store
|
||||
weight: 2
|
||||
---
|
||||
|
||||
{{< tabs items="Installation & Updates,Upgrade All,Uninstall,Get Installed,Clear Selection" defaultIndex="0" >}}
|
||||
|
||||
{{< tab >}}
|
||||
* Choose the programs you want to install or upgrade.
|
||||
* For programs not currently installed, this action will install them.
|
||||
* For programs already installed, this action will update them to the latest version.
|
||||
* Click the `Install/Upgrade Selected` button to start the installation or upgrade process.
|
||||
{{< /tab >}}
|
||||
|
||||
{{< tab >}}
|
||||
* Simply press the `Upgrade All` button.
|
||||
* This will upgrade all applicable programs that are installed without the need for individual selection.
|
||||
{{< /tab >}}
|
||||
|
||||
{{< tab >}}
|
||||
* Select the programs you wish to uninstall.
|
||||
* Click the `Uninstall Selected` button to remove the selected programs.
|
||||
{{< /tab >}}
|
||||
|
||||
{{< tab >}}
|
||||
* Click the `Get Installed` button.
|
||||
* This will scan for and select all installed programs in Winutil that WinGet supports.
|
||||
{{< /tab >}}
|
||||
|
||||
{{< tab >}}
|
||||
* Click the `Clear Selection` button.
|
||||
* This will unselect all checked programs.
|
||||
{{< /tab >}}
|
||||
{{< /tabs >}}
|
||||
|
||||
{{< image src="images/Install-Tab" alt="Install Image" >}}
|
||||
|
||||
> [!TIP]
|
||||
> If you have trouble finding an application, press `ctrl + f` and search the name of it. Applications will filter depending on your input.
|
||||
65
docs/content/userguide/tweaks/_index.md
Normal file
65
docs/content/userguide/tweaks/_index.md
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
title: Tweaks
|
||||
weight: 3
|
||||
---
|
||||
|
||||
{{< image src="images/Tweaks-Tab" alt="Image of Tweaks Tab" >}}
|
||||
|
||||
### Run Tweaks
|
||||
* **Open Tweaks Tab**: Navigate to the 'Tweaks' tab in the application.
|
||||
* **Select Tweaks**: Choose the tweaks you want to apply. You can use the presets available at the top for convenience.
|
||||
* **Run Tweaks**: After selecting the desired tweaks, click the 'Run Tweaks' button at the bottom of the screen.
|
||||
|
||||
### Undo Tweaks
|
||||
* **Open Tweaks Tab**: Go to the 'Tweaks' tab located next to 'Install'.
|
||||
* **Select Tweaks to Remove**: Choose the tweaks you want to disable or remove.
|
||||
* **Undo Tweaks**: Click the 'Undo Selected Tweaks' button at the bottom of the screen to apply the changes.
|
||||
|
||||
### Essential Tweaks
|
||||
Essential Tweaks are modifications and optimizations that are generally safe for most users to implement. These tweaks are designed to enhance system performance, improve privacy, and reduce unnecessary system activities. They are considered low-risk and are recommended for users who want to ensure their system runs smoothly and efficiently without delving too deeply into complex configurations. The goal of Essential Tweaks is to provide noticeable improvements with minimal risk, making them suitable for a wide range of users, including those who may not have advanced technical knowledge.
|
||||
|
||||
### Advanced Tweaks (CAUTION)
|
||||
Advanced Tweaks are intended for experienced users who have a solid understanding of their system and the potential implications of making deep-level changes. These tweaks involve more significant alterations to the operating system and can provide substantial customization. However, they also carry a higher risk of causing system instability or unintended side effects if not implemented correctly. Users who choose to apply Advanced Tweaks should proceed with caution, ensuring they have adequate knowledge and backups in place to recover if something goes wrong. These tweaks are not recommended for novice users or those unfamiliar with the inner workings of their operating system.
|
||||
|
||||
### O&O Shutup
|
||||
|
||||
|
||||
[O&O ShutUp10++](https://www.oo-software.com/en/shutup10) can be launched from Winutil with only one button click. It is a free privacy tool for Windows that lets users easily manage their privacy settings. It disables telemetry, controls updates, and manages app permissions to enhance security and privacy. The tool offers recommended settings for optimal privacy with just a few clicks.
|
||||
|
||||
{{< youtube id=3HvNr8eMcv0 loading=lazy >}}
|
||||
|
||||
|
||||
### DNS
|
||||
|
||||
The utility provides a convenient DNS selection feature, allowing users to choose between various DNS providers for both IPv4 and IPv6. This enables users to optimize their internet connection for speed, security, and privacy according to their specific needs. Here are the available options:
|
||||
|
||||
* **Default**: Uses the default DNS settings configured by your ISP or network.
|
||||
* **DHCP**: Automatically acquires DNS settings from the DHCP server.
|
||||
* [**Google**](https://developers.google.com/speed/public-dns?hl=en): A reliable and fast DNS service provided by Google.
|
||||
* [**Cloudflare**](https://developers.cloudflare.com/1.1.1.1/): Known for speed and privacy, Cloudflare DNS is a popular choice for enhancing internet performance.
|
||||
* [**Cloudflare_Malware**](https://developers.cloudflare.com/1.1.1.1/setup/#:~:text=Use%20the%20following%20DNS%20resolvers%20to%20block%20malicious%20content%3A): Provides additional protection by blocking malware sites.
|
||||
* [**Cloudflare_Malware_Adult**](https://developers.cloudflare.com/1.1.1.1/setup/#:~:text=Use%20the%20following%20DNS%20resolvers%20to%20block%20malware%20and%20adult%20content%3A): Blocks both malware and adult content, offering more comprehensive filtering.
|
||||
* [**Open_DNS**](https://www.opendns.com/setupguide/#familyshield): Offers customizable filtering and enhanced security features.
|
||||
* [**Quad9**](https://quad9.net/): Focuses on security by blocking known malicious domains.
|
||||
* [**AdGuard_Ads_Trackers**](https://adguard-dns.io/en/welcome.html) AdGuard DNS will block ads, trackers, or any other DNS requests. Visit website and login for a dashboard, statistics and customize your experience in the server settings.
|
||||
* [**AdGuard_Ads_Trackers_Malware_Adult**](https://adguard-dns.io/en/welcome.html) AdGuard DNS will block ads, trackers, adult content, and enable Safe Search and Safe Mode, where possible.
|
||||
* [**dns0.eu_Open**](https://www.dns0.eu/) The European public DNS that makes your Internet safer. Offers general-purpose filtering to block malware, phishing, and tracking domains for enhanced privacy and security.
|
||||
* [**dns0.eu_ZERO**](https://www.dns0.eu/zero) Provides advanced security with robust filters for highly sensitive environments, blocking high-risk domains using threat intelligence and sophisticated heuristics like Newly Registered Domains (NRD) and Domain Generation Algorithms (DGA).
|
||||
* [**dns0.eu_KIDS**](https://www.dns0.eu/kids) A child-safe DNS that blocks adult content, explicit search results, mature videos, dating sites, piracy, and ads, creating a secure internet experience for children on any device or network.
|
||||
|
||||
### Customize Preferences
|
||||
|
||||
The Customize Preferences section allows users to personalize their Windows experience by toggling various visual and functional features. These preferences are designed to enhance usability and tailor the system to the user’s specific needs and preferences.
|
||||
|
||||
### Performance Plans
|
||||
|
||||
The Performance Plans section allows users to manage the Ultimate Performance Profile on their system. This feature is designed to optimize the system for maximum performance.
|
||||
|
||||
#### Add and activate the Ultimate Performance Profile:
|
||||
* Enables and activates the Ultimate Performance Profile to enhance system performance by minimizing latency and increasing efficiency.
|
||||
#### Remove Ultimate Performance Profile:
|
||||
* Deactivates the Ultimate Performance Profile, changing the system to the Balanced Profile.
|
||||
|
||||
### Shortcuts
|
||||
|
||||
The utility includes a feature to easily create a desktop shortcut, providing quick access to the script.
|
||||
29
docs/content/userguide/updates/_index.md
Normal file
29
docs/content/userguide/updates/_index.md
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
title: Updates
|
||||
weight: 5
|
||||
---
|
||||
|
||||
> [!CAUTION]
|
||||
> The Updates tab is currently non-functional. We are actively working on a resolution to restore its functionality.
|
||||
|
||||
The utility provides three distinct settings for managing Windows updates: Default (Out of Box) Settings, Security (Recommended) Settings, and Disable ALL Updates (NOT RECOMMENDED!). Each setting offers a different approach to handling updates, catering to various user needs and preferences.
|
||||
|
||||
### Default (Out of Box) Settings
|
||||
- **Description**: This setting retains the default configurations that come with Windows, ensuring no modifications are made.
|
||||
- **Functionality**: It will remove any custom Windows update settings previously applied.
|
||||
- **Note**: If update errors persist, reset all updates in the configuration tab to restore all Microsoft Update Services to their default settings, reinstalling them from their servers.
|
||||
|
||||
### Security (Recommended) Settings
|
||||
- **Description**: This is the recommended setting for all computers.
|
||||
- **Update Schedule**:
|
||||
- **Feature Updates**: Delays feature updates by 2 years to avoid potential bugs and instability.
|
||||
- **Security Updates**: Installs security updates 4 days after their release to ensure system protection against pressing security flaws.
|
||||
- **Rationale**:
|
||||
- **Feature Updates**: Often introduce new features and bugs; delaying these updates minimizes the risk of system disruptions.
|
||||
- **Security Updates**: Essential for patching critical security vulnerabilities. Delaying them by a few days allows for verification of stability and compatibility without leaving the system exposed for extended periods.
|
||||
|
||||
### Disable ALL Updates (NOT RECOMMENDED!)
|
||||
- **Description**: This setting completely disables all Windows updates.
|
||||
- **Suitability**: May be appropriate for systems used for specific purposes that do not require active internet browsing.
|
||||
- **Warning**: Disabling updates significantly increases the risk of the system being hacked or infected due to the lack of security patches.
|
||||
- **Note**: It is strongly advised against using this setting due to the heightened security risks.
|
||||
Reference in New Issue
Block a user