Update README install instructions #2981
Conversation
|
Nice. I'm currently work on refactoring docs. Every improvement is welcome :) |
|
Sometimes I feel like it's a secret handshake to know how to install magento-lts via composer. 😉 |
| @@ -61,21 +62,59 @@ __Please be aware that although OpenMage is compatible that one or more extensio | |||
|
|
|||
| ## Installation | |||
|
|
|||
| ### Manual Install | |||
|
|
|||
| Download the latest [release archive](https://github.com/OpenMage/magento-lts/releases) and extract it over your existing install. **Important:** you must download the ZIP file from a tagged version on the releases page, otherwise there will be missing dependencies. | |||
There was a problem hiding this comment.
did we have this part before like this? because extracting it over an existing install is only updating/adding files. But files which got deleted or moved will stay in their place, which in some cases might be a security issue.
There was a problem hiding this comment.
@Flyingmana I think it's related to the "composer thing". It is true that just overwriting everything can leave orphaned files, maybe we could write it in a better way. It's still a difficult task since, if people installed everything in the same docroot, how will they be able to "remove everything" and reinstall? They'll for sure have css/js and other stuff in various directories that make everything more difficult.
BTW we have a specific section "Since OpenMage 19.5.0 / 20.1.0" in the readme with a "rm" command, check it out ;-)
There was a problem hiding this comment.
what we could do is updating the migration project https://github.com/OpenMage/migrate/blob/master/create-patches.sh to create diff based patches as in the old days. Also github offers patch files for release upgrades as for example https://github.com/OpenMage/magento-lts/compare/v20.0.17...v20.0.18.patch although thats not covering the composer dependencies, so the migration project which creates and hosts patches might be a valuable approach
There was a problem hiding this comment.
I suppose that this is the "classic" way to install / upgrade Magento. Not the best, but is for people who just use FTP.
I wouldn't personally work on creating diff based patches since simply using composer would be a better approach and we should be encouraging that way intead.
|
merged and v20ed |
|
I'm following the instructions but it seems the ZF1 patches are not applied :-( |
|
What version of magento-lts are you requiring? I did: |
|
But if I do: Then no patches, since it's not in those releases. |
|
you're totally right and I'm sorry, what stupid comment I posted 🤦🏻♂️ |
|
No problem, I have those moments too. 😅 Also nice! Looking forward to it. |
Description (*)
IMO, the install instructions are both unclear and inaccurate. I expanded on the section to explain exactly how to install via composer. I also added in notes about allowing patches which is critical to avoid security vulns.
View formatted README here: https://github.com/justinbeaty/magento-lts/tree/topic-readme-install#installation
Related Pull Requests
OpenMage/OpenMage.github.io#118
Manual testing scenarios (*)
Questions or comments
"openmage/magento-lts":"^19.5.0"to"openmage/magento-lts":"^19.4.0"because 19.5.x doesn't exist. Plus,^19.4.0allows19.5.xwhen it will exist.19.4.18.composer require "openmage/magento-lts":"dev-main"doesn't work for me. I believe there's special consideration when a branch has a numerical name. (Ref)Contribution checklist (*)