wingetautoupdate/README.md

244 lines
16 KiB
Markdown
Raw Normal View History

<div align="center">
2023-12-11 21:54:49 +00:00
![image](https://github.com/Romanitho/Winget-AutoUpdate/assets/96626929/0e738c7a-cbe4-4010-94f6-1e9165bc0d49)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Romanitho/Winget-AutoUpdate?label=Latest%20Stable%20Release&style=flat-square)](https://github.com/Romanitho/Winget-AutoUpdate/releases/latest)
2023-12-12 23:15:54 +00:00
[![GitHub release (by tag)](https://img.shields.io/github/downloads/Romanitho/Winget-AutoUpdate/latest/WAU-Configurator.zip?label=Downloads&style=flat-square)](https://github.com/Romanitho/Winget-AutoUpdate/releases/latest)
2023-12-12 23:17:16 +00:00
[![GitHub release (by tag)](https://img.shields.io/github/downloads/Romanitho/Winget-AutoUpdate/latest/WAU.zip?label=Downloads&style=flat-square)](https://github.com/Romanitho/Winget-AutoUpdate/releases/latest)
2023-12-11 10:27:34 +00:00
[![GitHub release (by tag)](https://img.shields.io/github/downloads/Romanitho/Winget-AutoUpdate/latest/WAU_InstallCounter?label=Installations&style=flat-square)](https://github.com/Romanitho/Winget-AutoUpdate/releases/latest)
</div>
2023-12-11 21:54:49 +00:00
---
2022-02-02 07:14:19 +00:00
This project uses the Winget tool to daily update apps (with system context) and notify users when updates are available and installed.
2022-01-22 15:58:44 +00:00
![image](https://user-images.githubusercontent.com/96626929/150645599-9460def4-0818-4fe9-819c-dd7081ff8447.png)
2022-01-21 08:36:07 +00:00
## Intallation
Just [download latest release (WAU-Configurator.zip)](https://github.com/Romanitho/Winget-AutoUpdate/releases/latest/download/WAU-Configurator.zip), unzip, run "WAU Configurator":
2022-01-18 08:53:53 +00:00
2023-12-11 10:31:34 +00:00
![WAU Configurator Screenshot](https://github.com/Romanitho/Winget-AutoUpdate/assets/96626929/e3c3a331-1c49-40c5-8f70-e39cf9fc7fd1)
2022-02-02 07:13:39 +00:00
## Configurations
2022-01-22 08:04:18 +00:00
### Keep some apps out of Winget-AutoUpdate
2022-04-25 07:27:59 +00:00
- #### BlockList
2022-01-22 08:48:33 +00:00
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):
2022-06-03 08:12:01 +00:00
Add (or remove) the apps' ID you want to disable autoupdate to 'excluded_apps.txt'. (File must be placed in WAU's installation folder, or re-run install.bat).
2022-04-25 07:27:59 +00:00
- #### Or 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 run the `Winget-AutoUpdate-Install.ps1` with `-UseWhiteList` parameter. Related post: <https://github.com/Romanitho/Winget-AutoUpdate/issues/36>
2022-04-24 10:04:14 +00:00
2024-03-25 13:36:39 +00:00
> The lists can contain Wildcard (*). For instance ```Mozilla.Firefox*``` will take care of all Firefox channels. (From v1.20.0)
2022-04-25 14:48:12 +00:00
2022-04-24 10:04:14 +00:00
### Notification Level
2023-12-11 10:27:34 +00:00
You can choose which notification will be displayed: Full, Success only or none. Use `-NotificationLevel` parameter when you run `Winget-AutoUpdate-Install.ps1`.
2022-04-24 10:04:14 +00:00
2022-01-22 08:08:06 +00:00
### Notification language
2022-01-22 09:02:13 +00:00
You can easily translate toast notifications by creating your locale xml config file (and share it with us :) ).
2022-04-24 10:04:14 +00:00
2022-01-22 08:48:33 +00:00
### When does the script run?
2024-03-25 18:02:06 +00:00
WAU runs everyday at 6AM. You can now configure the frequency with `-UpdatesInterval` option (Daily, BiDaily, Weekly, BiWeekly, Monthly or Never). You can also add `-UpdatesAtLogon` parameter to run at user logon (recommended).
2022-04-30 10:22:38 +00:00
2022-01-22 09:02:13 +00:00
### Log location
2023-05-04 09:02:56 +00:00
You can find logs in install location, in logs folder.<br>
If **Intune Management Extension** is installed, a **SymLink** (WAU-updates.log) is created under **C:\ProgramData\Microsoft\IntuneManagementExtension\Logs**<br>
If you are deploying winget Apps with [Winget-Install](https://github.com/Romanitho/Winget-Install) a **SymLink** (WAU-install.log) is also created under **C:\ProgramData\Microsoft\IntuneManagementExtension\Logs**
2022-04-24 10:04:14 +00:00
2022-02-22 08:29:49 +00:00
### "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)
Eventually, try to reinstall or update app manually to see if new version is detected.
2022-01-21 08:36:07 +00:00
2022-07-02 06:49:44 +00:00
### Handle metered connections
2023-12-11 10:27:34 +00:00
We might want to stop WAU on metered connection (to save cellular data on connection sharing for instance). The default behavior will detect and stop WAU on limited connections (only for fresh install).
2022-07-02 06:49:44 +00:00
To force WAU to run on metered connections anyway, run new installation with `-RunOnMetered` parameter.
2022-10-12 11:07:46 +00:00
### System & user context
2023-12-11 10:27:34 +00:00
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.
2022-10-12 11:07:46 +00:00
### Default install location
By default, scripts and components will be placed in ProgramData location (inside a Winget-AutoUpdate folder). You can change this with script argument (Not Recommended).
2022-02-21 14:10:46 +00:00
## Update WAU
2022-03-07 11:04:14 +00:00
### Manual Update
2023-12-11 10:27:34 +00:00
Same process as new installation.
2022-02-21 13:48:27 +00:00
2022-03-07 11:04:14 +00:00
### Automatic Update
2023-12-11 10:27:34 +00:00
By default, WAU AutoUpdate is enabled. It will not overwrite the configurations, icons (if personalised), excluded_apps list,...
2023-01-06 09:11:49 +00:00
To disable WAU AutoUpdate, run the `Winget-AutoUpdate-Install.ps1` with `-DisableWAUAutoUpdate` parameter.
2022-03-07 11:04:14 +00:00
2022-05-29 16:04:54 +00:00
## Uninstall WAU
2023-05-04 08:42:42 +00:00
Simply uninstall it from your programs:
2022-05-29 16:04:54 +00:00
![image](https://user-images.githubusercontent.com/96626929/170879336-ef034956-4778-41f0-b8fd-d307b77b70a9.png)
2022-04-05 17:57:39 +00:00
## Advanced installation
2023-12-11 10:27:34 +00:00
**Mainly for admins or advanced user installation.**<br>
2022-10-13 23:09:06 +00:00
You can run the `Winget-AutoUpdate-Install.ps1` script with parameters :
2022-04-05 17:57:39 +00:00
2023-05-04 08:57:10 +00:00
**-Silent**<br>
2023-01-06 09:11:49 +00:00
Install Winget-AutoUpdate and prerequisites silently.
2022-04-05 17:57:39 +00:00
2023-05-04 08:57:10 +00:00
**-DoNotUpdate**<br>
2022-04-05 17:57:39 +00:00
Do not run Winget-AutoUpdate after installation. By default, Winget-AutoUpdate is run just after installation.
2023-05-04 08:57:10 +00:00
**-DisableWAUAutoUpdate**<br>
2022-04-13 15:42:55 +00:00
Disable Winget-AutoUpdate update checking. By default, WAU auto updates if new version is available on Github.
2022-04-05 17:57:39 +00:00
2023-05-04 08:57:10 +00:00
**-UseWhiteList**<br>
2023-01-06 09:11:49 +00:00
Use White List instead of Black List. This setting will not create the "excluded_apps.txt" but "included_apps.txt".
2022-09-20 19:44:38 +00:00
2023-05-04 08:57:10 +00:00
**-ListPath**<br>
2023-05-04 09:10:53 +00:00
Get Black/White List from external Path (**URL/UNC/Local/GPO**) - download/copy to Winget-AutoUpdate installation location if external list is newer.<br>
**PATH** must end with a Directory, not a File...<br>
...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!<br>
2024-04-14 05:21:29 +00:00
If the external Path is a Private Azure Container protected by a SAS token (**resourceURI?sasToken**), every special character should be escaped at installation time.<br>
It doesn't work to call Powershell in **CMD** to install **WAU** with the parameter:<br>
`-ListPath https://storagesample.blob.core.windows.net/sample-container?v=2023-11-31&sr=b&sig=39Up9jzHkxhUIhFEjEh9594DIxe6cIRCgOVOICGSP%3A377&sp=rcw`<br>
Instead you must escape **every** special character (notice the `%` escape too) like:<br>
`-ListPath https://storagesample.blob.core.windows.net/sample-container^?v=2023-11-31^&sr=b^&sig=39Up9jzHkxhUIhFEjEh9594DIxe6cIRCgOVOICGSP%%3A377^&sp=rcw`
2023-05-04 12:26:36 +00:00
2023-05-04 09:26:33 +00:00
If `-ListPath` is set to **GPO** the Black/White List can be managed from within the GPO itself under **Application GPO Blacklist**/**Application GPO Whitelist**. Thanks to [Weatherlights](https://github.com/Weatherlights) in [#256 (reply in thread)](https://github.com/Romanitho/Winget-AutoUpdate/discussions/256#discussioncomment-4710599)!
2022-11-02 17:47:21 +00:00
2023-05-04 08:57:10 +00:00
**-ModsPath**<br>
2023-05-04 09:10:53 +00:00
Get Mods from external Path (**URL/UNC/Local/AzureBlob**) - download/copy to `mods` in Winget-AutoUpdate installation location if external mods are newer.<br>
2023-05-04 08:42:42 +00:00
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):
2022-11-05 16:55:14 +00:00
```
2022-11-05 17:22:55 +00:00
<ul>
2023-01-06 08:25:30 +00:00
<li><a href="Adobe.Acrobat.Reader.32-bit-installed.ps1">Adobe.Acrobat.Reader.32-bit-installed.ps1</a></li>
<li><a href="Adobe.Acrobat.Reader.64-bit-override.txt">Adobe.Acrobat.Reader.64-bit-override.txt</a></li>
<li><a href="Notepad++.Notepad++-installed.ps1">Notepad++.Notepad++-installed.ps1</a></li>
<li><a href="Notepad++.Notepad++-uninstalled.ps1">Notepad++.Notepad++-uninstalled.ps1</a></li>
2022-11-05 16:55:14 +00:00
</ul>
```
2023-05-04 09:26:33 +00:00
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**'
2022-04-05 17:57:39 +00:00
2023-03-07 15:17:40 +00:00
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.
2023-05-04 08:57:10 +00:00
**-AzureBlobURL**<br>
2023-12-11 10:27:34 +00:00
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.
2023-03-07 15:17:40 +00:00
2023-05-04 08:57:10 +00:00
**-InstallUserContext**<br>
2023-12-11 10:27:34 +00:00
Install WAU with system and **user** context executions.<br>
2023-05-04 12:26:36 +00:00
Applications installed in system context will be ignored under user context.
2022-10-25 15:58:53 +00:00
2023-05-04 08:57:10 +00:00
**-BypassListForUsers**<br>
2023-12-11 10:27:34 +00:00
Bypass Black/White list when run in user context.
2022-10-11 16:03:28 +00:00
2023-05-04 08:57:10 +00:00
**-NoClean**<br>
2022-09-20 19:44:38 +00:00
Keep critical files when installing/uninstalling. This setting will keep "excluded_apps.txt", "included_apps.txt", "mods" and "logs" as they were.
2022-08-10 10:36:26 +00:00
2023-05-04 08:57:10 +00:00
**-DesktopShortcut**<br>
2023-12-11 10:27:34 +00:00
Create a shortcut for user interaction on the Desktop to run task `Winget-AutoUpdate`
2022-10-11 14:03:57 +00:00
2023-05-04 08:57:10 +00:00
**-StartMenuShortcut**<br>
2023-12-11 10:27:34 +00:00
Create shortcuts for user interaction in the Start Menu to run task `Winget-AutoUpdate`, open Logs and Web Help.
2022-10-11 14:03:57 +00:00
2023-05-04 08:57:10 +00:00
**-NotificationLevel**<br>
2022-04-24 10:04:14 +00:00
Specify the Notification level: Full (Default, displays all notification), SuccessOnly (Only displays notification for success) or None (Does not show any popup).
2023-05-04 08:57:10 +00:00
**-UpdatesAtLogon**<br>
2022-04-30 10:22:38 +00:00
Set WAU to run at user logon.
2023-05-04 08:57:10 +00:00
**-UpdatesInterval**<br>
2023-01-06 09:11:49 +00:00
Specify the update frequency: Daily (Default), BiDaily, Weekly, BiWeekly, Monthly or Never. Can be set to 'Never' in combination with '-UpdatesAtLogon' for instance.
2023-05-04 08:57:10 +00:00
**-UpdatesAtTime**<br>
2023-12-11 10:27:34 +00:00
Specify the time of the update interval execution time. Default 6AM.
2022-04-30 10:22:38 +00:00
2023-05-04 08:57:10 +00:00
**-RunOnMetered**<br>
Force WAU to run on metered connections. May add cellular data costs on shared connexion from smartphone for example.
**-MaxLogFiles**<br>
Specify number of allowed log files.<br>
Default is 3 out of 0-99:<br>
Setting MaxLogFiles to 0 don't delete any old archived log files.<br>
Setting it to 1 keeps the original one and just let it grow.
**-MaxLogSize**<br>
Specify the size of the log file in bytes before rotating.<br>
Default is 1048576 = 1 MB (ca. 7500 lines)
2023-10-30 17:42:58 +00:00
**-WAUinstallPath**<br>
Specify Winget-AutoUpdate installation location. Default: `C:\ProgramData\Winget-AutoUpdate` (Recommended to leave default).
2022-04-30 10:22:38 +00:00
2023-05-04 08:57:10 +00:00
**-Uninstall**<br>
2022-04-05 17:57:39 +00:00
Remove scheduled tasks and scripts.
2022-05-30 14:53:21 +00:00
## Intune/SCCM use
See <https://github.com/Romanitho/Winget-AutoUpdate/discussions/88>
2022-05-30 14:53:21 +00:00
2023-09-02 03:49:26 +00:00
## Custom script (Mods for WAU)
2023-10-11 23:01:33 +00:00
**Mods for WAU** allows you to craft a script to do whatever you like via `_WAU-mods.ps1` in the **mods** folder.<br>
This script executes **if the network is active/any version of Winget is installed/WAU is running as SYSTEM**.<br>
2023-09-02 03:48:01 +00:00
If **ExitCode** is **1** from `_WAU-mods.ps1` then **Re-run WAU**.
## Custom scripts (Mods feature for Apps)
2023-12-11 10:27:34 +00:00
The Mods feature allows you to run additional scripts when upgrading or installing an app.
2023-11-24 18:42:20 +00:00
Just put the scripts in question with the **AppID** followed by the `-preinstall`, `-upgrade`, `-install`, `-installed` or `-notinstalled` suffix in the **mods** folder.
2023-05-04 09:10:53 +00:00
2023-11-24 18:42:20 +00:00
>- Runs before upgrade/install: `AppID-preinstall.ps1`
>- Runs during upgrade/install (before install check): `AppID-upgrade.ps1`/`AppID-install.ps1`
>- Runs after upgrade/install has been confirmed: `AppID-installed.ps1`
>- Runs after a failed upgrade/install: `AppID-notinstalled.ps1`
2023-11-25 21:39:37 +00:00
>- Runs after a failed upgrade/install: `_WAU-notinstalled.ps1` (any individual `AppID-notinstalled.ps1` overrides this global one)
2022-04-23 16:59:16 +00:00
2023-05-04 08:57:10 +00:00
The **-install** mod will be used for upgrades too if **-upgrade** doesn't exist (**WAU** first tries `& $Winget upgrade --id` and if the app isn't detected after that `& $Winget install --id` is tried).<br>
2023-05-04 08:42:42 +00:00
`AppID-install.ps1` is recommended because it's used in **both** scenarios.
2022-12-04 03:05:16 +00:00
2023-05-04 08:57:10 +00:00
> Example:<br>
2023-05-04 09:10:53 +00:00
If you want to run a script that removes the shortcut from **%PUBLIC%\Desktop** (we don't want to fill the desktop with shortcuts our users can't delete) just after installing **Acrobat Reader DC** (32-bit), prepare a powershell script that removes the Public Desktop shortcut **Acrobat Reader DC.lnk** and name your script like this: `Adobe.Acrobat.Reader.32-bit-installed.ps1` and put it in the **mods** folder.
2022-04-23 16:59:16 +00:00
2023-05-04 08:57:10 +00:00
You can find more information on [Winget-Install Repo](https://github.com/Romanitho/Winget-Install#custom-mods), as it's a related feature.<br>
2023-01-06 09:11:49 +00:00
Read more in the `README.md` under the directory **mods**.
2022-04-23 16:59:16 +00:00
2023-05-04 08:57:10 +00:00
Share your mods with the community:<br>
<https://github.com/Romanitho/Winget-AutoUpdate/discussions/categories/mods>
2023-01-31 13:04:27 +00:00
2022-12-09 02:16:33 +00:00
### Winget native parameters
2023-02-01 01:54:58 +00:00
Another finess is the **AppID** followed by the `-override` suffix as a **text file** (.**txt**) that you can place under the **mods** folder.
2023-05-04 08:57:10 +00:00
> Example:<br>
2023-05-04 09:10:53 +00:00
**Canneverbe.CDBurnerXP-override.txt** with the content `ADDLOCAL=All REMOVE=Desktop_Shortcut /qn`
2022-12-08 17:27:45 +00:00
2023-05-04 08:42:42 +00:00
This will use the **content** of the text file as a native **winget --override** parameter when upgrading (as proposed by [JonNesovic](https://github.com/JonNesovic) in [Mod for --override argument #244](https://github.com/Romanitho/Winget-AutoUpdate/discussions/244#discussion-4637666)).
2022-12-31 11:00:04 +00:00
2022-12-30 20:44:41 +00:00
## GPO Management
2023-05-04 08:57:10 +00:00
In an enterprise environment it's crucial that different groups can have different settings in applications etc. or to implement other mandatory settings, i.e for security/management reasons.<br>
**WAU** doesn't have any setting that can be changed except for when installing (or editing the registry/the task `Winget-AutoUpdate` as **Admin**).<br>
With the use of **ADML/ADMX** files you can manage every **WAU** setting from within **GPO**.<br>
2023-10-10 15:30:34 +00:00
They will be detected/evaluated on a daily basis.<br>
2023-05-04 08:57:10 +00:00
The **GPO ADMX/ADML** validated with: [Windows 10 - Validate ADMX for Ingestion](https://developer.vmware.com/samples/7115/windows-10---validate-admx-for-ingestion)<br>
2023-01-06 09:11:49 +00:00
Read more in the `README.md` under the directory **Policies**.
2022-12-08 17:27:45 +00:00
![image](https://user-images.githubusercontent.com/102996177/213920242-7ff8e2b4-d926-4407-b860-1e5922e29c3e.png)
2022-12-30 20:56:04 +00:00
2022-02-21 13:48:27 +00:00
## Help
2022-07-02 06:49:44 +00:00
In some cases, you need to "unblock" the `install.bat` file (Windows Defender SmartScreen). Right click, properties and unblock. Then, you'll be able to run it.
2022-02-21 14:10:46 +00:00
2022-07-04 12:49:12 +00:00
## Known issues
* As reported by [soredake](https://github.com/soredake), Powershell from MsStore is not supported with WAU in system context. See <https://github.com/Romanitho/Winget-AutoUpdate/issues/113>
2022-07-04 12:49:12 +00:00
2022-02-21 14:10:46 +00:00
## Optimization
2023-05-04 08:57:10 +00:00
Feel free to give us any suggestions or optimizations in code and support us by adding a star :)
---
<div align="center">
#### WAU - GitHub
[![GitHub release (release name instead of tag name)](https://img.shields.io/github/v/release/Romanitho/Winget-AutoUpdate?display_name=release&include_prereleases&label=Latest%20Release&style=flat-square)](https://github.com/Romanitho/Winget-AutoUpdate/releases/)
2023-12-13 16:49:44 +00:00
[![GitHub release (latest by SemVer including pre-releases)](https://img.shields.io/github/downloads-pre/Romanitho/Winget-AutoUpdate/latest/WAU-Configurator.zip?label=Downloads&style=flat-square)](https://github.com/Romanitho/Winget-AutoUpdate/releases/)
[![GitHub release (latest by SemVer including pre-releases)](https://img.shields.io/github/downloads-pre/Romanitho/Winget-AutoUpdate/latest/WAU.zip?label=Downloads&style=flat-square)](https://github.com/Romanitho/Winget-AutoUpdate/releases/)
[![GitHub release (latest by SemVer including pre-releases)](https://img.shields.io/github/downloads-pre/Romanitho/Winget-AutoUpdate/latest/WAU_InstallCounter?label=Installations&style=flat-square)](https://github.com/Romanitho/Winget-AutoUpdate/releases/)
</div>