diff --git a/ops/publish_release.md b/ops/publish_release.md index 6b0b4fea..6a94d31d 100644 --- a/ops/publish_release.md +++ b/ops/publish_release.md @@ -11,13 +11,13 @@ day-to-day basis. ## Pick a Codename If this is going to be a major version release `0.X` or `1.X` (not `0.0.X`), you will need to have a codename picked out for the release. This should be some type of rhyme or otherwise creative name, ideally using some type of Pterodactyl -releated species name. +related species name. ## Create the Release Branch Releases should be created as their own branch on Github, following the GitFlow model. This means you'll need to create a `release/vX.X.X` branch. Once the branch is created you need to update the version number for the software. For the Panel -this requires editing `config/app.php` and setting the specific `APP_VERSION` _without_ a preceeding `v`. For the Daemon, -you need to edit `package.json` and set the `version` field, again _without_ a preceeding `v`. +this requires editing `config/app.php` and setting the specific `APP_VERSION` _without_ a preceding `v`. For the Daemon, +you need to edit `package.json` and set the `version` field, again _without_ a preceding `v`. Once you've created the branch and update the relevant file publish the branch to Github to begin the next steps. diff --git a/panel/configuration.md b/panel/configuration.md index bc7692e9..34400c59 100644 --- a/panel/configuration.md +++ b/panel/configuration.md @@ -12,12 +12,12 @@ is because the internal logic the Panel is using to determine how links should b HTTP, and not over HTTPS. You will need to edit the `.env` file in the Panel's root directory to contain `TRUSTED_PROXIES=*` at minimum. We -highly suggest providing a specific IP address (or comma seperated list of IPs) rather than allowing `*`. For example, +highly suggest providing a specific IP address (or comma separated list of IPs) rather than allowing `*`. For example, if your proxy is running on the same machine as the server, chances are that something like `TRUSTED_PROXIES=127.0.0.1` will work for you. ### Cloudflare Specific Configuration -If you're using Cloudflares Flexible SSL you should set `TRUSTED_PROXIES` to contain [their IP addresses](https://www.cloudflare.com/ips/). +If you're using Cloudflare's Flexible SSL you should set `TRUSTED_PROXIES` to contain [their IP addresses](https://www.cloudflare.com/ips/). Below is an example of how to set this. ``` diff --git a/panel/troubleshooting.md b/panel/troubleshooting.md index 88f2dc42..6f600c4d 100644 --- a/panel/troubleshooting.md +++ b/panel/troubleshooting.md @@ -44,7 +44,7 @@ local.ERROR: ErrorException: file_put_contents(...): failed to open stream: Perm From this error we can determine that there was an error performing a [file_put_contents()](http://php.net/manual/en/function.file-put-contents.php) call, and the error was that we couldn't open the file because permissions were denied. Its okay if you don't understand the error at all, but it does help you get faster support if you're able to provide these logs, and at least find the source of the error. -Sometimes the errors are pretty strightforward and will tell you exactly what went wrong, such as a `ConnectionException` +Sometimes the errors are pretty straightforward and will tell you exactly what went wrong, such as a `ConnectionException` being thrown when the Panel can't connect to the Daemon. ### Utilizing GREP @@ -116,7 +116,7 @@ installation of the Panel. When restoring backups you should _always_ restore the `.env` file! ::: -Sometimes when using the Panel you'll unexpectely encounter a broken page, and upon checking the logs you'll see +Sometimes when using the Panel you'll unexpectedly encounter a broken page, and upon checking the logs you'll see an exception mentioning an invalid MAC when decrypting. This error is caused by mismatched `APP_KEY`s in your `.env` file when the data was encrypted versus decrypted. diff --git a/tutorials/creating_ssl_certificates.md b/tutorials/creating_ssl_certificates.md index 7035e6eb..8c4391b1 100644 --- a/tutorials/creating_ssl_certificates.md +++ b/tutorials/creating_ssl_certificates.md @@ -34,3 +34,25 @@ which provides more options, and is much more powerful than certbot. ``` text certbot renew ``` + +## Troubleshooting +If you get a `Insecure Connection` or related when trying to access your panel, it is likely that the SSL has expired. +This can be easily fixed by renewing the SSL certificate, although using the command +``` text +certbot renew +``` +Wont do the job. As it'll give a error such as `Error: Attempting to renew cert (domain) from /etc/letsencrypt/renew/domain.conf produced an unexpected error`. +This will happen especially if your running NGINX instead of Apache, the solution for this is to stop NGINX, renew the certificate then start NGINX once again. +You can do this by running, +```bash +systemctl stop NGINX +``` +To stop the NGINX service. Now you need to renew the certificate, you can do this by running, +```bash +certbot renew +``` +Wait for the process to complete. +Once it has, you may now re-start the NGINX service using, +```bash +systemctl start NGINX +``` diff --git a/tutorials/mysql_setup.md b/tutorials/mysql_setup.md index 778f4f5b..958c61e1 100644 --- a/tutorials/mysql_setup.md +++ b/tutorials/mysql_setup.md @@ -25,7 +25,7 @@ to `somePassword`. ``` sql USE mysql; -# Remeber to change 'somePassword' below to be a unique password specific to this account. +# Remember to change 'somePassword' below to be a unique password specific to this account. CREATE USER 'pterodactyl'@'127.0.0.1' IDENTIFIED BY 'somePassword'; ```