Skip to content

Commit 92a89a8

Browse files
committed
docs(readme): update the services shipped and emergency uninstall docs.
- Update Services shipped: - Remove `Acrylic` from the services shipped with valet table. - Add `Acrylic` to the auto-downloaded services table. - Update all auto-downloaded services versions to the latest versions and change the date using the ISO 8601 date format. - Update emergency uninstall: - Change all paths to use the new "Emergency Uninstall" directory. - Add an important note in the section for the Ansicon `The system cannot find the path specified` error. - Add descriptions of the new "Emergency Uninstall" directory.
1 parent 64c4451 commit 92a89a8

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

README.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -152,10 +152,9 @@ This is 3.0 of Valet Windows, branded under the name _Laravel Valet Windows 3_,
152152

153153
Valet ships with and installs these services:
154154

155-
| Service | Version |
156-
| ----------------------------------------------------------------------------: | ------- |
157-
| [Acrylic DNS Proxy](https://mayakron.altervista.org/support/acrylic/Home.htm) | 2.1.0 |
158-
| [ngrok](https://ngrok.com/) | 3.3.1 |
155+
| Service | Version |
156+
| --------------------------: | ------- |
157+
| [ngrok](https://ngrok.com/) | 3.3.1 |
159158

160159
> [!IMPORTANT]
161160
> ngrok may error out that it is "too old" when running it for some accounts. In the upcoming v3.2.0 release, Valet will ship with the latest version of ngrok.
@@ -166,14 +165,15 @@ Valet ships with and installs these services:
166165
>
167166
> For both commands, valet automatically appends the config file location as a flag to the command, so ngrok will already know where the config file is.
168167
169-
As of v3.2.0, Valet no longer ships with the executables for the following services, instead they will be downloaded and installed automatically from GitHub's API. This is so that the latest versions with bug fixes and security updates can be installed.
168+
As of v3.2.0 and v3.3.0, Valet no longer ships with the executables for the following services, instead they will be downloaded and installed automatically from it's online source (GitHub, SourceForge, etc.). This is so that the latest versions with bug fixes and security updates can be installed.
170169

171-
| Service | Latest Version as of 13/05/2025 |
172-
| ------------------------------------------: | ------------------------------- |
173-
| [Ansicon](https://github.com/adoxa/ansicon) | 1.89 |
174-
| [gsudo](https://github.com/gerardog/gsudo) | 2.6.0 |
175-
| [nginx](https://nginx.org/) | 1.28.0 |
176-
| [WinSW](https://github.com/winsw/winsw) | 2.12.0 |
170+
| Service | Latest Version as of 2025-10-22 |
171+
| ----------------------------------------------------------------------------: | ------------------------------- |
172+
| [Ansicon](https://github.com/adoxa/ansicon) | 1.89 |
173+
| [gsudo](https://github.com/gerardog/gsudo) | 2.6.1 |
174+
| [nginx](https://nginx.org/) | 1.29.2 |
175+
| [WinSW](https://github.com/winsw/winsw) | 2.12.0 |
176+
| [Acrylic DNS Proxy](https://mayakron.altervista.org/support/acrylic/Home.htm) | 2.2.1 |
177177

178178
> [!IMPORTANT]
179179
>
@@ -1537,17 +1537,25 @@ Doesn't affect valet functionality.
15371537
15381538
## Emergency Stop and Uninstall Services
15391539
1540-
As of v3.1.6, Valet has an emergency stop and uninstall services script. This script is copied to the `/.config/valet` directory for safe keeping.
1540+
As of v3.1.6, Valet has an emergency stop and uninstall services script. This script is copied to the `/.config/valet/Emergency Uninstall` directory for safe keeping.
15411541
15421542
So if `composer global update` is ran before valet is uninstalled, and several running services prevent composer from removing the files and updating valet, then you can run the `emergency_uninstall_services.bat` file to stop and uninstall the services.
15431543
15441544
To run, open a CMD terminal with Admin privileges and run this:
15451545
15461546
```sh
1547-
> %UserProfile%\.config\valet\emergency_uninstall_services.bat
1547+
> "%UserProfile%\.config\valet\Emergency Uninstall\emergency_uninstall_services.bat"
15481548
```
15491549

1550-
All services will have been stopped and you can then be able to run `composer global update`.
1550+
Alternatively, find it in the File Explorer and double clicking the file will also run it.
1551+
1552+
All services will have been stopped and removed and you can then be able to run `composer global update`.
1553+
1554+
> [!IMPORTANT]
1555+
>
1556+
> If you receive the `The system cannot find the path specified` error or similar while installing valet, then usually it's to do with Ansicon leaving it's path in the registry after uninstalling, which then fails Valet's installation.
1557+
>
1558+
> The emergency uninstall script can help to uninstall Ansicon again and hopefully fully removing it from the registry.
15511559
15521560
## Valet Directories
15531561

@@ -1595,7 +1603,13 @@ Upon installation, Valet creates the following directories and config files:
15951603
- `~/.config/valet/config.json`
15961604
This is the main Valet config file.
15971605

1598-
- `~/.config/valet/emergency_uninstall_services.bat`
1606+
- `~/.config/valet/Emergency Uninstall`
1607+
Contains the emergency uninstall files.
1608+
1609+
- `~/.config/valet/Emergency Uninstall/ansicon`
1610+
Contains the Ansicon files and executable to help uninstall it.
1611+
1612+
- `~/.config/valet/Emergency Uninstall/emergency_uninstall_services.bat`
15991613
This is an batch file to do an emergency stop and uninstall of all services. See the [Emergency Stop and Uninstall Services section](#emergency-stop-and-uninstall-services).
16001614

16011615
> [!WARNING]
@@ -1657,7 +1671,9 @@ Upon installation, Valet creates the following directories and config files:
16571671

16581672
- If there is a large error and it's file trace output to the terminal, the top of the error may be cut off/overwritten. Apparently Symfony can only write to the terminal that is viewable, if it goes outside of the viewable area (ie. you need to scroll up to view) then the output is overwritten and the most important part of the error, the description at the start is cut off. (See https://github.com/symfony/symfony/issues/35012). If this happens, make the terminal larger in height and try the command again to try and view the full error.
16591673

1660-
- When trying to install Valet after updating via Composer, and you receive this error or similiar: `The system cannot find the path specified`; it could be that Ansicon hasn't uninstalled properly and left it's path in the registry. Because it happens unpredictably, there is no way of debugging or fixing it. The only "workaround" is to use the emergency uninstall script (`emergency_uninstall_services.bat`) in the `C:\Users\Stuart\.config\valet\Emergency Uninstall` directory to allow Ansicon another chance to uninstall itself properly. (See [issue 28](https://github.com/yCodeTech/valet-windows/issues/28)).
1674+
- When trying to install Valet after updating via Composer, and you receive this error or similiar: `The system cannot find the path specified`; it could be that Ansicon hasn't uninstalled properly and left it's path in the registry. Because it happens unpredictably, there is no way of debugging or fixing it.
1675+
1676+
The only "workaround" is to use the emergency uninstall script (`emergency_uninstall_services.bat`) in the `~/.config/valet/Emergency Uninstall` directory to allow Ansicon another chance to uninstall itself properly. (See [issue 28](https://github.com/yCodeTech/valet-windows/issues/28)). See the [Emergency Stop and Uninstall Services section](#emergency-stop-and-uninstall-services).
16611677

16621678
## Xdebug Installation
16631679

0 commit comments

Comments
 (0)