Move docs over. (#3760)

* Docs * Update docs.yaml * Delete docs/LICENCE * Delete docs/README.md * Update module path in go.mod
2026-02-05 15:30:09 +00:00 · 2026-01-07 19:55:35 +00:00
parent 63eeab0b19
commit 69d8649986
165 changed files with 13532 additions and 0 deletions
--- a/docs/content/dev/tweaks/Essential-Tweaks/RestorePoint.md
+++ b/docs/content/dev/tweaks/Essential-Tweaks/RestorePoint.md
@@ -0,0 +1,139 @@
+# Create Restore Point
+
+Last Updated: 2024-08-07
+
+
+> [!NOTE]
+     The Development Documentation is auto generated for every compilation of Winutil, meaning a part of it will always stay up-to-date. **Developers do have the ability to add custom content, which won't be updated automatically.**
+## Description
+
+Creates a restore point at runtime in case a revert is needed from Winutil modifications
+
+<!-- BEGIN CUSTOM CONTENT -->
+
+<!-- END CUSTOM CONTENT -->
+
+<details>
+<summary>Preview Code</summary>
+
+```json
+{
+  "Content": "Create Restore Point",
+  "Description": "Creates a restore point at runtime in case a revert is needed from Winutil modifications",
+  "category": "Essential Tweaks",
+  "panel": "1",
+  "Checked": "False",
+  "Order": "a001_",
+  "InvokeScript": [
+    "
+        # Check if the user has administrative privileges
+        if (-Not ([Security.Principal.WindowsPrincipal][Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)) {
+            Write-Host \"Please run this script as an administrator.\"
+            return
+        }
+
+        # Check if System Restore is enabled for the main drive
+        try {
+            # Try getting restore points to check if System Restore is enabled
+            Enable-ComputerRestore -Drive \"$env:SystemDrive\"
+        } catch {
+            Write-Host \"An error occurred while enabling System Restore: $_\"
+        }
+
+        # Check if the SystemRestorePointCreationFrequency value exists
+        $exists = Get-ItemProperty -path \"HKLM:\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\SystemRestore\" -Name \"SystemRestorePointCreationFrequency\" -ErrorAction SilentlyContinue
+        if($null -eq $exists) {
+            write-host 'Changing system to allow multiple restore points per day'
+            Set-ItemProperty -Path \"HKLM:\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\SystemRestore\" -Name \"SystemRestorePointCreationFrequency\" -Value \"0\" -Type DWord -Force -ErrorAction Stop | Out-Null
+        }
+
+        # Attempt to load the required module for Get-ComputerRestorePoint
+        try {
+            Import-Module Microsoft.PowerShell.Management -ErrorAction Stop
+        } catch {
+            Write-Host \"Failed to load the Microsoft.PowerShell.Management module: $_\"
+            return
+        }
+
+        # Get all the restore points for the current day
+        try {
+            $existingRestorePoints = Get-ComputerRestorePoint | Where-Object { $_.CreationTime.Date -eq (Get-Date).Date }
+        } catch {
+            Write-Host \"Failed to retrieve restore points: $_\"
+            return
+        }
+
+        # Check if there is already a restore point created today
+        if ($existingRestorePoints.Count -eq 0) {
+            $description = \"System Restore Point created by Winutil\"
+
+            Checkpoint-Computer -Description $description -RestorePointType \"MODIFY_SETTINGS\"
+            Write-Host -ForegroundColor Green \"System Restore Point Created Successfully\"
+        }
+      "
+  ],
+  "link": "https://christitustech.github.io/Winutil/dev/tweaks/Essential-Tweaks/RestorePoint"
+}
+```
+
+</details>
+
+## Invoke Script
+
+```powershell
+
+        # Check if the user has administrative privileges
+        if (-Not ([Security.Principal.WindowsPrincipal][Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)) {
+            Write-Host "Please run this script as an administrator."
+            return
+        }
+
+        # Check if System Restore is enabled for the main drive
+        try {
+            # Try getting restore points to check if System Restore is enabled
+            Enable-ComputerRestore -Drive "$env:SystemDrive"
+        } catch {
+            Write-Host "An error occurred while enabling System Restore: $_"
+        }
+
+        # Check if the SystemRestorePointCreationFrequency value exists
+        $exists = Get-ItemProperty -path "HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion\SystemRestore" -Name "SystemRestorePointCreationFrequency" -ErrorAction SilentlyContinue
+        if($null -eq $exists) {
+            write-host 'Changing system to allow multiple restore points per day'
+            Set-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion\SystemRestore" -Name "SystemRestorePointCreationFrequency" -Value "0" -Type DWord -Force -ErrorAction Stop | Out-Null
+        }
+
+        # Attempt to load the required module for Get-ComputerRestorePoint
+        try {
+            Import-Module Microsoft.PowerShell.Management -ErrorAction Stop
+        } catch {
+            Write-Host "Failed to load the Microsoft.PowerShell.Management module: $_"
+            return
+        }
+
+        # Get all the restore points for the current day
+        try {
+            $existingRestorePoints = Get-ComputerRestorePoint | Where-Object { $_.CreationTime.Date -eq (Get-Date).Date }
+        } catch {
+            Write-Host "Failed to retrieve restore points: $_"
+            return
+        }
+
+        # Check if there is already a restore point created today
+        if ($existingRestorePoints.Count -eq 0) {
+            $description = "System Restore Point created by Winutil"
+
+            Checkpoint-Computer -Description $description -RestorePointType "MODIFY_SETTINGS"
+            Write-Host -ForegroundColor Green "System Restore Point Created Successfully"
+        }
+
+
+```
+
+<!-- BEGIN SECOND CUSTOM CONTENT -->
+
+<!-- END SECOND CUSTOM CONTENT -->
+
+
+[View the JSON file](https://github.com/ChrisTitusTech/Winutil/tree/main/config/tweaks.json)
+