Merge pull request #8248 from open-sausages/pull/4/doc-alternative-upgrader-installation

DOCS Document how to install upgrader as a phar
This commit is contained in:
Luke Edwards 2018-07-10 16:06:25 +12:00 committed by GitHub
commit 3ad000466e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -92,7 +92,7 @@ through the [Step 1 - Upgrade your dependencies](#step1) section.
### Install the upgrader tool (optional) ### Install the upgrader tool (optional)
Using the upgrader is not mandatory, but it can speed up the process. Using the upgrader is not mandatory, but it can speed up the process.
Although SilverStripe 4 can run in both PHP 5.6 and PHP 7, the upgrader itself requires PHP 7. Although SilverStripe 4 can run in both PHP 5.6 and PHP 7, the upgrader itself requires PHP 7.1.
To install the upgrader globally run this command. To install the upgrader globally run this command.
```bash ```bash
@ -119,6 +119,16 @@ You can run `upgrade-code help` to get more information about the upgrader or `u
Sample upgrader commands in this guide assume your working directory is the root of your SilverStripe project. You'll need to use the `--root-dir` flag if that's not the case. Sample upgrader commands in this guide assume your working directory is the root of your SilverStripe project. You'll need to use the `--root-dir` flag if that's not the case.
</div> </div>
#### Install the upgrader as a PHAR executable
The upgrader is also available as a phar executable. This can be helpful if installing the upgrader globally through composer conflicts with other libraries.
To install the PHAR executable:
1. [Download the upgrader as a PHAR executable](https://silverstripe.github.io/silverstripe-upgrader/upgrade-code.phar) or `wget https://silverstripe.github.io/silverstripe-upgrader/upgrade-code.phar`
2. Make the file executable `chmod +x upgrade-code.phar`
3. Move the file to a folder in your path, for example `sudo mv upgrade-code.phar /usr/local/bin/upgrade-code`
### Running all the upgrader commands in this guide in on line ### Running all the upgrader commands in this guide in on line
The upgrader comes with an `all` command. This command will attempt to run all the upgrader commands in the same order as this guide. This is unlikely to work on your first try, but can be a good way to get started without going through this entire guide. The upgrader comes with an `all` command. This command will attempt to run all the upgrader commands in the same order as this guide. This is unlikely to work on your first try, but can be a good way to get started without going through this entire guide.