mirror of
https://github.com/pterodactyl/documentation.git
synced 2025-12-11 05:44:45 -06:00
Document self-upgrade procedure
This commit is contained in:
Dane Everitt
parent
fa1328e71b
commit
42db99da46
@ -7,17 +7,18 @@ Each version of Pterodactyl Panel also has a corresponding minimum version of Wi
|
||||
is required for it to run. Please see the chart below for how these versions line up. In
|
||||
most cases your base Wings version should match that of your Panel.
|
||||
|
||||
| Panel Version | Wings Version | Supported |
|
||||
| ------------- | ------------- | --------- |
|
||||
| 1.0.x | 1.0.x | |
|
||||
| 1.1.x | 1.1.x | |
|
||||
| 1.2.x | 1.2.x | |
|
||||
| 1.3.x | 1.3.x | |
|
||||
| **1.4.x** | **1.4.x** | ✅ |
|
||||
| Panel Version | Wings Version | Supported | PHP Versions |
|
||||
| ------------- | ------------- | --------- | ------------ |
|
||||
| 1.0.x | 1.0.x | | 7.3, 7.4 |
|
||||
| 1.1.x | 1.1.x | | 7.3, 7.4 |
|
||||
| 1.2.x | 1.2.x | | 7.3, 7.4 |
|
||||
| 1.3.x | 1.3.x | | 7.4, **8.0** |
|
||||
| **1.4.x** | **1.4.x** | ✅ | 7.4, **8.0** |
|
||||
|
||||
## Update Dependencies
|
||||
::: warning Minimum PHP Version Changed
|
||||
The latest versions of Pterodactyl Panel — including the `1.3` release — require a **minimum version of PHP 7.4** and
|
||||
If you are upgrading from a version of Pterodactyl _prior to_ `1.3.x` you'll need to update your PHP
|
||||
dependencies. The latest versions of Pterodactyl Panel require a **minimum version of PHP 7.4** and
|
||||
Composer v2.
|
||||
:::
|
||||
|
||||
@ -42,8 +43,29 @@ vagrant@pterodactyl:~/app$ composer --version
|
||||
Composer version 2.0.8 2020-12-03 17:20:38
|
||||
```
|
||||
|
||||
## Fetch Updated Files
|
||||
### Enter Maintenance Mode
|
||||
## Self Upgrade
|
||||
If your version of Pterodactyl Panel is `1.3.2` or higher you can simply run the following command to perform a
|
||||
self-upgrade of the Panel. This will download all of the necessary files and perform all of the actions listed
|
||||
in this upgrade documentation.
|
||||
|
||||
```bash
|
||||
php artisan down
|
||||
php artisan p:self-upgrade
|
||||
php artisan up
|
||||
```
|
||||
|
||||
[Final Step: Upgrade Wings](/wings/1.0/upgrading.md)
|
||||
|
||||
## Manual Upgrade
|
||||
If you prefer not to perform the automatic self-upgrade, or need to reference any upgrade steps you can follow
|
||||
the documentation below.
|
||||
|
||||
::: warning
|
||||
If you've already performed the self-upgrade successfully you do not need to do anything else on this page.
|
||||
:::
|
||||
|
||||
### Fetch Updated Files
|
||||
#### Enter Maintenance Mode
|
||||
Whenever you are performing an update you should be sure to place your Panel into maintenance mode. This will prevent
|
||||
users from encountering unexpected errors and ensure everything can be updated before users encounter
|
||||
potentially new features. Now is a good time to ensure that you're in the `/var/www/pterodactyl` directory.
|
||||
@ -52,7 +74,7 @@ potentially new features. Now is a good time to ensure that you're in the `/var/
|
||||
php artisan down
|
||||
```
|
||||
|
||||
### Download the Update
|
||||
#### Download the Update
|
||||
The first step in the update process is to download the new panel files from GitHub. The command below will download
|
||||
the release archive for the most recent version of Pterodactyl, save it in the current directory and will automatically
|
||||
unpack the archive into your current folder.
|
||||
@ -68,7 +90,7 @@ any webserver related errors.
|
||||
chmod -R 755 storage/* bootstrap/cache
|
||||
```
|
||||
|
||||
## Update Dependencies
|
||||
### Update Dependencies
|
||||
After you've downloaded all of the new files you will need to upgrade the core components of the panel. To do this,
|
||||
simply run the commands below and follow any prompts.
|
||||
|
||||
@ -76,7 +98,7 @@ simply run the commands below and follow any prompts.
|
||||
composer install --no-dev --optimize-autoloader
|
||||
```
|
||||
|
||||
## Clear Compiled Template Cache
|
||||
### Clear Compiled Template Cache
|
||||
You'll also want to clear the compiled template cache to ensure that new and modified templates show up correctly for
|
||||
users.
|
||||
|
||||
@ -85,7 +107,7 @@ php artisan view:clear
|
||||
php artisan config:clear
|
||||
```
|
||||
|
||||
## Database Updates
|
||||
### Database Updates
|
||||
You'll also need to update your database schema for the newest version of Pterodactyl. Running the command below
|
||||
will update the schema and ensure the default eggs we ship are up to date (and add any new ones we might have). Just
|
||||
remember, _never edit core eggs we ship_! They will be overwritten by this update process.
|
||||
@ -94,7 +116,7 @@ remember, _never edit core eggs we ship_! They will be overwritten by this updat
|
||||
php artisan migrate --seed --force
|
||||
```
|
||||
|
||||
## Set Permissions
|
||||
### Set Permissions
|
||||
The last step is to set the proper owner of the files to be the user that runs your webserver. In most cases this
|
||||
is `www-data` but can vary from system to system — sometimes being `nginx`, `caddy`, `apache`, or even `nobody`.
|
||||
|
||||
@ -109,14 +131,14 @@ chown -R nginx:nginx /var/www/pterodactyl/*
|
||||
chown -R apache:apache /var/www/pterodactyl/*
|
||||
```
|
||||
|
||||
## Restarting Queue Workers
|
||||
### Restarting Queue Workers
|
||||
After _every_ update you should restart the queue worker to ensure that the new code is loaded in and used.
|
||||
|
||||
``` bash
|
||||
php artisan queue:restart
|
||||
```
|
||||
|
||||
### Exit Maintenance Mode
|
||||
#### Exit Maintenance Mode
|
||||
Now that everything has been updated you need to exit maintenance mode so that the Panel can resume accepting
|
||||
connections.
|
||||
|
||||
@ -124,4 +146,4 @@ connections.
|
||||
php artisan up
|
||||
```
|
||||
|
||||
#### [Final Step: Upgrade Wings](/wings/1.0/upgrading.md)
|
||||
[Final Step: Upgrade Wings](/wings/1.0/upgrading.md)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user