Feature: Add one line install script and instructions to README

[kevincobain2000]

Install cli could be more convinient for for users to not guess b/w arm, x86_64 and aarch etc..
Plus it will provide better installation for dev-ops team as one interface.

Verify

╰─$ cat install.sh| sh -
######################################################################## 100.0%
Installed successfully to: /Users/pulkit.kathuria/git/action-coveritup/app/frankenphp

╰─$ ls -lh frankenphp
-rwxr-xr-x  1 user.name  679754705   105M Feb 25 20:15 frankenphp

[withinboredom]

It would be great to only set this if it isn't set, so people can do:

BIN_DIR=/usr/bin curl -sLK https://raw.githubusercontent.com/dunglas/frankenphp/main/install.sh | sh

[kevincobain2000]

Thanks

Added 19c126a and d0962c8 so user can do export BIN_DIR=... however still not setting /usr/bin as default path because it may require sudo as cat install.sh | sudo sh, because not always /usr/bin has the permissions for the user.

And adding extra instructions to set BIN_DIR in the README kind of complicates this simple process. Although added provision so user can install elsewhere too. That is why, pwd keeps things simple and user has a choice to move it to which ever bin dir of user's PATH choice.

Verification as below:

Fail

╰─$ sudo cat install.sh| sh
Password:
Warning: Failed to open the file /usr/local/bin/frankenphp: Permission denied
curl: (23) Failure writing output to destination

Success

╰─$ cat install.sh| sudo sh
Password:
######################################################################## 100.0%
Installed successfully to: /usr/local/bin/frankenphp

[withinboredom]

Overall LGTM and I like it.

[withinboredom]

Looks like some issues with shellcheck in GHA (mostly variables need to be quoted). Can you address that?

[kevincobain2000]

Thanks for the review @withinboredom
I have fixed the lint errors on spellchecker, I think rest of the lint errors are un-related to changes in this pull request. May want to re-run the CI.

[kevincobain2000]

Ideally it'd be also nice to have this script hosted on https://frankenphp.dev/install.sh instead of raw.github... But that is topic for another day - and may depend on how is the docs pipeline structured.

[withinboredom]

There are still remaining issues (double quoting to prevent globbing). The paths should be quoted because if my current pwd is /home/withinboredom/bin*2024 it will fail in fun ways trying to download the file.

[kevincobain2000]

Squashed commits and lints fixed.

[dunglas]

Is this safe?

Composer uses a checksum for instance: https://getcomposer.org/download/

[kevincobain2000]

Is this safe?
Composer uses a checksum for instance: https://getcomposer.org/download/

No comments on this.
I mean I guess you could add this extra layer of security and have checksum. At the same time I also don't see the point as it is not a package manager. Homebrew installation doesn't have similar either and not many other curl shell installations.

[withinboredom]

I also don't see the point

Incomplete downloads, bad actors/broken caches on corporate middle-boxes, and a host of other things can cause checksums to be invalid. It's worth detecting it if we can, if for no other reason than to save people some time when things aren't working as expected.

[kevincobain2000]

It is worth detecting. Yes. Just for this install script it seems over work. And may not have a simple straightforward command for the user. It’s a trade off.

[dunglas]

Ok, that works for me. That would be nice to have an official brew and maybe APT repositories too (easier to update).

[kevincobain2000]

Yes. Given the popularity of this tool it’d be at least wise to reserve the names on brew and/or apt get etc. Publications can be delayed when you have time. Suggestion is to at least own the name before some bots started claiming it. It is just a naive thought.

[SirMishaa]

Hello,

They are remaining tasks to do before merging this PR ? Would be great to have this in the README.md file

[kevincobain2000]

I believe this is ready. All changes from my side have been pushed.

[dunglas]

Why not install directly the binary in /usr/local/bin/? This will simplify the one-liner provided in docs.

[withinboredom]

I think that change makes an assumption that there is a /usr/local/bin to install to or that the user has permissions to do so. I, personally, would be wary of running a random curl'd script with root permissions just to install something.

I think you can probably make the docs more readable by suggesting BIN_DIR:

curl -sLK https://raw.githubusercontent.com/dunglas/frankenphp/main/install.sh | BIN_DIR=/usr/local/bin sh

and modify the script prompt for sudo if it fails to copy.

[withinboredom]

I think that change makes an assumption that there is a /usr/local/bin to install to or that the user has permissions to do so. I, personally, would be wary of running a random curl'd script with root permissions just to install something.

I think you can probably make the docs more readable by suggesting BIN_DIR:

curl -sLK https://raw.githubusercontent.com/dunglas/frankenphp/main/install.sh | BIN_DIR=/usr/local/bin sh

and modify the script prompt for sudo if it fails to copy.

[dunglas]

Thank you @kevincobain2000! I refactored a bit the script.

[kevincobain2000]

Thanks!