From 2428f2e97c9c1cd652a95f13f1b8c6a700729b36 Mon Sep 17 00:00:00 2001 From: Natsuhiko Mizutani Date: Tue, 31 Mar 2026 19:06:38 +0900 Subject: [PATCH] updated the documentation on winget-installed WAU > 1. Clarify the installation path for `winget` users (`C:\Program Files\Winget-AutoUpdate`). > 2. **Added details about the Scheduled Task (`\WAU\Winget-AutoUpdate`) that is automatically created upon installation.** > 3. Distinguish between `winget` and manual installation paths in the Configurations and Logs sections. --- README.md | 102 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 90 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7ea7d85d..5c62e15a 100644 --- a/README.md +++ b/README.md @@ -11,30 +11,54 @@ This project uses the Winget tool to daily update apps (with system context) and ![image](https://user-images.githubusercontent.com/96626929/150645599-9460def4-0818-4fe9-819c-dd7081ff8447.png) ## Installation + Just download latest release [WAU.msi](https://github.com/Romanitho/Winget-AutoUpdate/releases/latest): ![image](https://github.com/user-attachments/assets/e6b090ff-9c40-46e1-a04b-9b7437f3e2e7) ![image](https://github.com/user-attachments/assets/2e4af91b-e319-401b-99cd-3c199e21016b) ![image](https://github.com/user-attachments/assets/1b70d77c-4220-4b62-bded-eb1e890e7485) - - - ### Use winget to install WAU + The following command will install WAU through winget itself in the newest version available. ```batch winget install Romanitho.Winget-AutoUpdate ``` + + +### Automation + +When installed, WAU automatically registers a scheduled task to handle updates in the background. + +- **Task Name:** `Winget-AutoUpdate` +- **Location:** `Task Scheduler Library > WAU` +- **Behavior:** It triggers based on the default configuration (typically at logon or on a daily schedule) to keep your applications up to date without manual intervention. + + #### Alternative installation (for home admin users) + You can also download the latest release of the add-on [WAU Settings GUI (for Winget-AutoUpdate)](https://github.com/KnifMelti/WAU-Settings-GUI) and install it (this will install both **WAU** and a **GUI** that provides a user-friendly portable standalone interface to modify every aspect of **Winget-AutoUpdate (WAU)**). ## Configurations + +The configuration files allow you to customize the behavior of WAU. + +**Important:** The file location depends on your installation method: + +- **Installed via winget:** `C:\Program Files\Winget-AutoUpdate\` +- **Installed via .msi installer:** File must be placed in the same folder as WAU.msi + + ### Keep some apps out of Winget-AutoUpdate + - #### BlockList + You can exclude apps from update job (for instance, apps you want to keep at a specific version or apps with built-in auto-update): Add (or remove) the apps' ID you want to disable autoupdate to 'excluded_apps.txt'. (File must be placed in the same folder as WAU.msi). + - #### AllowList + You can update only pre-selected apps. To do so, create an "included_apps.txt" with the apps' ID of the apps you want to auto-update and place it in the same folder as WAU.msi during install. > The lists can contain Wildcard (*). For instance ```Mozilla.Firefox*``` will take care of all Firefox channels. @@ -42,22 +66,30 @@ You can update only pre-selected apps. To do so, create an "included_apps.txt" w List and Mods folder content will be copied to WAU install location: 423074783-a37837b0-b61e-4ce7-b23c-fd8661585e40 - ### Notification Level + You can choose which notification will be displayed: `Full`, `Success only`, `Errors only` or `None`. ### Notification language + You can easily translate toast notifications by creating your locale xml config file (and share it with us 😉). ### When does the script run? + WAU runs ,by default, at logon. You can configure the frequency with options (Daily, BiDaily, Weekly, BiWeekly, Monthly or Never). ### Log location -You can find logs in install location, in logs folder for priviledged executions. For user runs (Winget-Install.ps1) a log file will be created at %AppData%\Winget-AutoUpdate\Logs .
+ +You can find logs in install location, in logs folder for priviledged executions. + +- For user runs (Winget-Install.ps1) a log file will be created at `%AppData%\Winget-AutoUpdate\Logs` .
+- For winget installed users: `C:\Program Files\Winget-AutoUpdate\logs` + If **Intune Management Extension** is installed, a **SymLink** (WAU-updates.log) is created under **C:\ProgramData\Microsoft\IntuneManagementExtension\Logs**
If you are deploying winget Apps with [Winget-Install](https://github.com/Romanitho/Winget-AutoUpdate/blob/main/Sources/Winget-AutoUpdate/Winget-Install.ps1) a **SymLink** (WAU-install.log & WAU-user_%username%.log) is also created under **C:\ProgramData\Microsoft\IntuneManagementExtension\Logs** ### "Unknown" App version + As explained in this [post](https://github.com/microsoft/winget-cli/issues/1255), Winget cannot detect the current version of some installed apps. We decided to skip managing these apps with WAU to avoid retries each time WAU runs: ![image](https://user-images.githubusercontent.com/96626929/155092000-c774979d-2db7-4dc6-8b7c-bd11c7643950.png) @@ -71,35 +103,46 @@ We might want to stop WAU on metered connection (to save cellular data on connec To force WAU to run on metered connections anyway, run new installation with `-RunOnMetered` parameter. ### System & user context + WAU runs with system and user contexts. This way, even apps installed on User's scope are updated. Shorcuts for manually run can also be installed. ### Default install location + By default, scripts and components will be placed in "Program Files" location (inside a Winget-AutoUpdate folder). ## Update WAU + ### Manual Update + Same process as new installation. ### Automatic Update + By default, WAU AutoUpdate is enabled. It will not overwrite the configurations, excluded_apps list,... ## Advanced installation + **Mainly for admins or advanced user installation.**
You can run the `WAU.msi` script with parameters : ### /qn + Install Winget-AutoUpdate and prerequisites silently. ### RUN_WAU + Default value NO. Set `RUN_WAU=YES` to run WAU just after installation. ### DISABLEWAUAUTOUPDATE + Default value 0. Set `DISABLEWAUAUTOUPDATE=1` to disable Winget-AutoUpdate self update checking. By default, WAU auto updates if new version is available on Github. ### USEWHITELIST + Set `USEWHITELIST=1` to force WAU to use WhiteList. During installation, if a whitelist is provided, this setting is automatically set to 1. ### LISTPATH + Get Black/White List from external Path (**URL/UNC/Local/GPO**) - download/copy to Winget-AutoUpdate installation location if external list is newer.
**PATH** must end with a Directory, not a File...
...if the external Path is an **URL** and the web host doesn't respond with a date/time header for the file (i.e **GitHub**) then the file is always downloaded!
@@ -110,13 +153,13 @@ It doesn't work to call Powershell in **CMD** to install **WAU** with the parame Instead you must escape **every** special character (notice the `%` escape too) like:
`-ListPath https://storagesample.blob.core.windows.net/sample-container^?v=2023-11-31^&sr=b^&sig=39Up9jzHkxhUIhFEjEh9594DIxe6cIRCgOVOICGSP%%3A377^&sp=rcw` - If a blacklist or whitelist is configured via Group Policy (GPO), WAU will automatically use these settings. There is no longer a need to specify "GPO" as a value for `ListPath`, detection is automatic as soon as a list is defined in Group Policy. - ### MODSPATH + Get Mods from external Path (**URL/UNC/Local/AzureBlob**) - download/copy to `mods` in Winget-AutoUpdate installation location if external mods are newer.
For **URL**: This requires a site directory with **Directory Listing Enabled** and no index page overriding the listing of files (or an index page with href listing of all the **Mods** to be downloaded): + ```html ``` + Validated on **IIS/Apache**. >**Nota bene IIS** : +> >- The extension **.ps1** must be added as **MIME Types** (text/powershell-script) otherwise it's displayed in the listing but can't be opened >- Files with special characters in the filename can't be opened by default from an IIS server - config must be administrated: **Enable Allow double escaping** in '**Request Filtering**' For **AzureBlob**: This requires the parameter **-AzureBlobURL** to be set with an appropriate Azure Blob Storage URL including the SAS token. See **-AzureBlobURL** for more information. ### AZUREBLOBURL + Used in conjunction with the **-ModsPath** parameter to provide the Azure Storage Blob URL with SAS token. The SAS token must, at a minimum, have 'Read' and 'List' permissions. It is recommended to set the permisions at the container level and rotate the SAS token on a regular basis. Ensure the container reflects the same structure as found under the initial `mods` folder. ### USERCONTEXT + Default value 0. Set `USERCONTEXT=1` to install WAU with system and **user** context executions.
Applications installed in system context will be ignored under user context. ### BYPASSLISTFORUSERS + Default value 0. Set `BYPASSLISTFORUSERS=1` to bypass Black/White list when run in user context. ### DESKTOPSHORTCUT + Set `DESKTOPSHORTCUT=1` to create a shortcut for user interaction on the Desktop to run task `Winget-AutoUpdate` ### STARTMENUSHORTCUT + Set `STARTMENUSHORTCUT=1` to create shortcuts for user interaction in the Start Menu to run task `Winget-AutoUpdate` and open Logs. ### NOTIFICATIONLEVEL + Specify the Notification level: Full (Default, displays all notification), SuccessOnly (Only displays notification for success), ErrorsOnly (Only displays notification for errors) or None (Does not show any popup). ### UPDATESATLOGON + Default value 1. Set `UPDATESATLOGON=0` to disable WAU from running at user logon. ### UPDATESINTERVAL + Default value Never. Specify the update frequency: Daily, BiDaily, Weekly, BiWeekly, Monthly or Never. ### UPDATESATTIME + Default value 6AM (06:00:00). Specify the time of the update interval execution time. Example `UPDATESATTIME="11:00:00"` ### UPDATESATTIMEDELAY + Default value is none (00:00). This setting specifies the delay for the scheduled task. A scheduled task random delay adds a random amount of wait time (up to the specified maximum) before the task starts. This helps prevent many devices from running the task at the exact same time. This is not applicable to "on logon" triggers. ### DONOTRUNONMETERED + Default value 1. Set `DONOTRUNONMETERED=0` to force WAU to run on metered connections. May add cellular data costs on shared connexion from smartphone for example. ### MAXLOGFILES + Specify number of allowed log files.
Default is 3 out of 0-99:
Setting MaxLogFiles to 0 don't delete any old archived log files.
Setting it to 1 keeps the original one and just let it grow. ### MAXLOGSIZE + Specify the size of the log file in bytes before rotating.
Default is 1048576 = 1 MB (ca. 7500 lines) ### INSTALLDIR + Specify Winget-AutoUpdate installation location. Default: `C:\Program Files\Winget-AutoUpdate` (Recommended to leave default). ### Deploy with Intune + You can use [Winget-Install](https://github.com/Romanitho/Winget-AutoUpdate/blob/main/Sources/Winget-AutoUpdate/Winget-Install.ps1) to deploy the package (this example with an override of parameters): + ```batch "%systemroot%\sysnative\WindowsPowerShell\v1.0\powershell.exe" -noprofile -executionpolicy bypass -file "C:\Program Files\Winget-AutoUpdate\Winget-Install.ps1" -AppIDs "Adobe.Acrobat.Reader.64-bit --scope machine --override \"-sfx_nu /sAll /rs /msi EULA_ACCEPT=YES DISABLEDESKTOPSHORTCUT=1"" ``` + ### Deploy with SCCM + You can also use [Winget-Install](https://github.com/Romanitho/Winget-AutoUpdate/blob/main/Sources/Winget-AutoUpdate/Winget-Install.ps1) to deploy the same package in **SCCM**: + ```batch powershell.exe -noprofile -executionpolicy bypass -file "C:\Program Files\Winget-AutoUpdate\Winget-Install.ps1" -AppIDs "Adobe.Acrobat.Reader.64-bit --scope machine --override \"-sfx_nu /sAll /rs /msi EULA_ACCEPT=YES DISABLEDESKTOPSHORTCUT=1"" ``` + Instead of including the override parameters in the install string you can use a **Mod** (**mods\Adobe.Acrobat.Reader.64-bit-override.txt**) with the content: + ```batch "-sfx_nu /sAll /rs /msi EULA_ACCEPT=YES DISABLEDESKTOPSHORTCUT=1" ``` -* A standard single installation: **-AppIDs Notepad++.Notepad++** -* Multiple installations: **-AppIDs "7zip.7zip, Notepad++.Notepad++"** + +- A standard single installation: **-AppIDs Notepad++.Notepad++** + +- Multiple installations: **-AppIDs "7zip.7zip, Notepad++.Notepad++"** As a custom detection script you can download/edit [winget-detect.ps1](Sources/Tools/Detection/winget-detect.ps1) (change app to detect [**Application ID**]) in **Intune**/**SCCM** A nice feature is if you're already using the deprecated standalone script **winget-install.ps1** from the [old repo](https://github.com/Romanitho/Winget-Install) and have placed it somwhere locally on all clients you can make a **SymLink** in its place and keep using the old path (avoiding a lot of work) in your deployed applications (**Winget-Install.ps1** takes care of the SymLink logic). ## GPO / Intune Management -Read more in the [Policies section](https://github.com/Romanitho/Winget-AutoUpdate/tree/main/Sources/Policies). +Read more in the [Policies section](https://github.com/Romanitho/Winget-AutoUpdate/tree/main/Sources/Policies). ## Custom script (Mods for WAU) + **Mods for WAU** allows you to craft a script to do whatever you like via `_WAU-mods.ps1` in the **mods** folder.
This script executes **if the network is active/any version of Winget is installed/WAU is running as SYSTEM**.
If **ExitCode** is **1** from `_WAU-mods.ps1` then **Re-run WAU**. @@ -221,6 +290,7 @@ Likewise `_WAU-mods-postsys.ps1` can be used to do things at the end of the **SY You can find more information in [README Mods for WAU](Sources/Winget-AutoUpdate/mods/README.md) ## Custom scripts (Mods feature for Apps) + The Mods feature allows you to run additional scripts when upgrading or installing an app. Just put the scripts in question with the **AppID** followed by the `-preinstall`, `-upgrade`, `-install`, `-installed` or `-notinstalled` suffix in the **mods** folder. @@ -242,9 +312,11 @@ Share your mods with the community:
### Winget native parameters + You can customize winget behavior per-app using **text files** (.**txt**) placed in the **mods** folder: #### Override (Full installer control) + Use **AppID**`-override.txt` to replace ALL installer arguments (without `-h` silent mode). > Example:
**Adobe.Acrobat.Reader.64-bit-override.txt** with the content `"-sfx_nu /sAll /rs /msi EULA_ACCEPT=YES DISABLEDESKTOPSHORTCUT=1"` @@ -252,6 +324,7 @@ Use **AppID**`-override.txt` to replace ALL installer arguments (without `-h` si This uses the **content** as a native **winget --override** parameter when upgrading. #### Custom (Add installer arguments) + Use **AppID**`-custom.txt` to add extra arguments to the installer (with `-h` silent mode). > Example:
**Adobe.Acrobat.Reader.64-bit-custom.txt** with the content `"DISABLEDESKTOPSHORTCUT=1"` @@ -259,9 +332,11 @@ Use **AppID**`-custom.txt` to add extra arguments to the installer (with `-h` si This uses the **content** as a native **winget --custom** parameter when upgrading. #### Arguments (Winget-level parameters) + Use **AppID**`-arguments.txt` to pass **winget parameters** (not installer arguments, with `-h` silent mode). **Locale Tip:** Many applications revert to English or system default language during WAU upgrades because winget doesn't remember the original installation locale. To prevent this: + - **Best solution:** Use locale-specific package IDs in `included_apps.txt` (e.g., `Mozilla.Firefox.sv-SE` instead of `Mozilla.Firefox`) - **Alternative:** Create `{AppID}-arguments.txt` with `--locale` parameter to force language on every upgrade @@ -277,6 +352,7 @@ Use **AppID**`-arguments.txt` to pass **winget parameters** (not installer argum **Microsoft.VisualStudio.2022.Community-arguments.txt** with the content `--locale en-US --architecture x64` **Common use cases:** + - `--locale ` - Force application language (e.g., `pl-PL`, `en-US`, `de-DE`) - **Recommended alternative:** Use locale-specific package IDs when available (e.g., `Mozilla.Firefox.sv-SE`, `Mozilla.Firefox.de`, `Mozilla.Firefox.ESR.pl`) to get latest versions - `--skip-dependencies` - Skip dependency installations when they conflict @@ -291,6 +367,7 @@ Use **AppID**`-arguments.txt` to pass **winget parameters** (not installer argum **Locale Best Practice:** Search for locale-specific packages with `winget search ` to see if your language has a dedicated package ID (e.g., `Mozilla.Firefox.sv-SE` for Swedish Firefox). These packages are maintained with the latest versions in your preferred language. **Command-line usage:** You can also pass arguments when calling `Winget-Install.ps1`: + ```powershell .\winget-install.ps1 -AppIDs "Mozilla.Firefox --locale sv-SE" .\winget-install.ps1 -AppIDs "7zip.7zip, Notepad++.Notepad++" @@ -301,11 +378,12 @@ Use **AppID**`-arguments.txt` to pass **winget parameters** (not installer argum See [_AppID-arguments-template.txt](Sources/Winget-AutoUpdate/mods/_AppID-arguments-template.txt) for more examples. - ## Known issues -* As reported by [soredake](https://github.com/soredake), Powershell from MsStore is not supported with WAU in system context. See + +- As reported by [soredake](https://github.com/soredake), Powershell from MsStore is not supported with WAU in system context. See ## Optimization + Feel free to give us any suggestions or optimizations in code and support us by adding a star :) ---