From 6dc74e94aa52dd47216f790ccf3c26728a6a21ae Mon Sep 17 00:00:00 2001 From: Nico Verbruggen Date: Tue, 4 Jan 2022 02:51:33 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Document=20functionality=20in=20?= =?UTF-8?q?README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 19 +++++++++++++++++++ SECURITY.md | 3 ++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b24cfba..79e0fdc 100644 --- a/README.md +++ b/README.md @@ -296,6 +296,7 @@ While I did make this application during my own free time, I have been lucky eno * Everyone in the Laravel community who shared the app (thanks!) * Various folks who [reached](https://twitter.com/stauffermatt) [out](https://twitter.com/marcelpociot) * Everyone who left feedback via issues +* Everyone who donated to keep the project up and running Thank you very much for your contributions, kind words and support. @@ -313,6 +314,24 @@ This utility will detect which PHP versions you have installed via Homebrew, and The switcher will disable all PHP-FPM services not belonging to the version you wish to use, and link the desired version of PHP. Then, it'll restart your desired PHP version's FPM process. This all happens in parallel, so this should be much faster than Valet’s switcher. +### Config change detection + +PHP Monitor watches your filesystem in the relevant `conf.d` directory for the currently linked PHP version. + +Whenever an .ini file is modified, PHP Monitor will attempt to reload the current information about the active PHP installation. + +If an extension or other process writes to a single file a bunch of times in a short span of time (< 1 sec), PHP Monitor will only reload the active configuration information after a while (with a slight delay). + +### Site detection + +PHP Monitor uses the Valet configuration file to determine which folders to look into. Each folder is scanned and then PHP Monitor will validate if a composer.json file exists to determine the desired PHP version. + +If the app has been secured by checking if a matching certificate exists under Valet's `Certificates` directory. + +PHP Monitor also runs `valet which` to determine which driver is currently in use for each individual site. This command is executed once for each site whenever the site list is refreshed. + +*Note*: If you have linked a folder in Documents, Desktop or Downloads you might need to grant PHP Monitor access to those directories for PHP Monitor to work correctly. + ### Want to know more? If you want to know more about how this works, I recommend you check out the source code. diff --git a/SECURITY.md b/SECURITY.md index c0a3e75..9477f1e 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,7 +6,7 @@ Generally speaking, only the latest version of **PHP Monitor** is supported, exc | Version | Apple silicon | Supported | Supported macOS | Deployment Target | Detected PHP Versions | Minimum Required Valet Version | | ------- | ------------- | ------------------ | ----- | ----- | ----- | ---- -| 4.1 | ✅ Universal binary | ✅ Yes | Big Sur (11.0) and Monterey (12.0) | macOS 11+ | PHP 5.6—PHP 8.2 | 2.16.2 | +| 5.x | ✅ Universal binary | ✅ Yes | Big Sur (11.0) and Monterey (12.0) | macOS 11+ | PHP 5.6—PHP 8.2 | TBD | ## Legacy versions @@ -14,6 +14,7 @@ These versions of PHP Monitor are no longer supported, but if you’re using an | Version | Apple silicon | Supported | Supported macOS | Deployment Target | Detected PHP Versions | Minimum Required Valet Version | | ------- | ------------- | ------------------ | ----- | ----- | ----- | ---- +| 4.1 | ✅ Universal binary | ❌ | Big Sur (11.0) and Monterey (12.0) | macOS 11+ | PHP 5.6—PHP 8.2 | 2.16.2 | | 4.0 | ✅ Universal binary | ❌ | Big Sur (11.0) and Monterey (12.0) | macOS 10.14+ | PHP 5.6—PHP 8.2 | 2.13 | | 3.5 | ✅ Universal binary | ❌ | Big Sur (11.0) and Monterey (12.0) | macOS 10.14+ | PHP 5.6—PHP 8.2 | 2.13 | | 3.0—3.4 | ✅ Universal binary | ❌ | Big Sur (11.0) | macOS 10.14+ | PHP 5.6—PHP 8.1 | 2.13 |