diff --git a/README.md b/README.md index 4fb6f5999..4981d71c5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Nook Theme NookTheme is a free and open source [Pterodactyl theme](https://pterodactyl.io) designed to be simple, clean, and modern. -![Image](https://i.imgur.com/IflRtEX.png) +![Image](https://i.imgur.com/AFjHGBr.png)
View Screnshots @@ -14,33 +14,99 @@ NookTheme is a free and open source [Pterodactyl theme](https://pterodactyl.io) ## Installation -### First go to the panel route and set the panel as under maintenance -```sh +This will update your panel to the latest version of NookTheme panel is based.
+You can see the version in the current branch name. +### 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. + +```bash cd /var/www/pterodactyl php artisan down ``` -### Download the update +### Download the theme -```sh +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. + +```bash curl -L https://github.com/Nookure/NookTheme/releases/latest/download/panel.tar.gz | tar -xzv ``` -### Once all of the files are downloaded we need to set the correct permissions on the cache and storage directories to avoid any webserver related errors. -```sh +Once all of the files are downloaded we need to set the correct permissions on the cache and storage directories to avoid +any webserver related errors. + +```bash chmod -R 755 storage/* bootstrap/cache ``` -### Update the dependencies -```sh +### 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. + +```bash composer install --no-dev --optimize-autoloader ``` -### Clear the blade templates cache -```sh + +### 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. + +```bash php artisan view:clear php artisan config:clear ``` + +### 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. + +```bash +php artisan migrate --seed --force +``` + +### 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`. + +```bash +# If using NGINX or Apache (not on CentOS): +chown -R www-data:www-data /var/www/pterodactyl/* + +# If using NGINX on CentOS: +chown -R nginx:nginx /var/www/pterodactyl/* + +# If using Apache on CentOS +chown -R apache:apache /var/www/pterodactyl/* +``` + +### 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 + +Now that everything has been updated you need to exit maintenance mode so that the Panel can resume accepting +connections. + +```bash +php artisan up +``` + ## Documentation * [Panel Documentation](https://pterodactyl.io/panel/1.0/getting_started.html)