pterodactyl/documentation
1
0
Fork 0
mirror of https://github.com/pterodactyl/documentation.git synced 2025-12-11 14:00:27 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #67 from AlienSteel/patch-1

Browse Source 
New reCaptcha section and some refactoring
This commit is contained in:
Dane Everitt 2019-02-01 22:07:32 -08:00 committed by GitHub
commit 589367c293
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
panel/configuration.md
View File

@ -2,6 +2,34 @@
[[toc]] [[toc]]
Pterodactyl's environment settings are configured and stored in an environment file — `.env` — located in the
installation root directory — generally `/var/www/pterodactyl`. Some of these settings are also stored in the database
and will override settings found in the environment file.
To change this behavior you can edit the `.env` file and change the setting `APP_ENVIRONMENT_ONLY=false` to
`APP_ENVIRONMENT_ONLY=true` which will take effect the next time you refresh a page on the Panel. Generally you will
only need to do this if you severly corrupt a setting in the Panel or are deep in development with the software.
## Reporting All Exceptions
By default Pterodactyl only logs and reports exceptions that are, well, exceptional by nature. There are some exceptions
that we expect to occur such as authentication failures or validation issues. However, in rare instances when developing,
or even on production servers, you might need to have all exceptions logged to detect inconsistent behavior.
To do this, simply set `APP_REPORT_ALL_EXCEPTIONS=true` in your `.env` file. You'll want to turn this off once you've
completed whatever it is you're needing the exceptions for, otherwise your logs will become very large, very quickly.
## Client Databases
By default Pterodactyl ships with the ability for clients to have their own per-server databases. If you wish to disable
this ability, set `PTERODACTYL_CLIENT_DATABASES_ENABLED` to be `false`. Pterodactyl also attempts to create databases
on a database host assigned to the current server's node but will use any host if one can't be found. If you would like
to force a database to be created only on a host belonging to that server's node, set `PTERODACTYL_CLIENT_DATABASES_ALLOW_RANDOM`
to be `false`.
```
PTERODACTYL_CLIENT_DATABASES_ENABLED=true
PTERODACTYL_CLIENT_DATABASES_ALLOW_RANDOM=true
```
## Reverse Proxy Setup ## Reverse Proxy Setup
If you are planning on running Pterodactyl behind a reverse proxy, either using NGINX or because you are using If you are planning on running Pterodactyl behind a reverse proxy, either using NGINX or because you are using
[Cloudflare's Flexible SSL](https://support.cloudflare.com/hc/en-us/articles/200170416-What-do-the-SSL-options-mean-), [Cloudflare's Flexible SSL](https://support.cloudflare.com/hc/en-us/articles/200170416-What-do-the-SSL-options-mean-),
@ -24,7 +52,7 @@ Below is an example of how to set this.
TRUSTED_PROXIES=103.21.244.0/22,103.22.200.0/22,103.31.4.0/22,104.16.0.0/12,108.162.192.0/18,131.0.72.0/22,141.101.64.0/18,162.158.0.0/15,172.64.0.0/13,173.245.48.0/20,188.114.96.0/20,190.93.240.0/20,197.234.240.0/22,198.41.128.0/17 TRUSTED_PROXIES=103.21.244.0/22,103.22.200.0/22,103.31.4.0/22,104.16.0.0/12,108.162.192.0/18,131.0.72.0/22,141.101.64.0/18,162.158.0.0/15,172.64.0.0/13,173.245.48.0/20,188.114.96.0/20,190.93.240.0/20,197.234.240.0/22,198.41.128.0/17
``` ```
## Increasing Editable File Size ## Increasing the Editable File Size
By default the Panel attempts to set a reasonable limit for editing files through the web based file manager. However, By default the Panel attempts to set a reasonable limit for editing files through the web based file manager. However,
some users find it too restrictive and wish to increase the size. This is controlled by a configuration value that can some users find it too restrictive and wish to increase the size. This is controlled by a configuration value that can
also be set using the `.env` file. The default value is `50,000` bytes but this can be increased as you see fit. also be set using the `.env` file. The default value is `50,000` bytes but this can be increased as you see fit.
@ -33,38 +61,20 @@ also be set using the `.env` file. The default value is `50,000` bytes but this
PTERODACTYL_FILES_MAX_EDIT_SIZE=50000 PTERODACTYL_FILES_MAX_EDIT_SIZE=50000
``` ```
## Client Databases ## Disable or Modify ReCaptcha
By default Pterodactyl ships with the ability for clients to have their own per-server databases. If you wish to disable To disable reCAPTCHA on login or password reset, simply set `RECAPTCHA_ENABLED=false` in the environment file. This
this ability, set `PTERODACTYL_CLIENT_DATABASES_ENABLED` to be `false`. Pterodactyl also attempts to create databases change will take effect immediately.
on a database host assigned to the current server's node but will use any host if one can't be found. If you would like
to force a database to be created only on a host belonging to that server's node, set `PTERODACTYL_CLIENT_DATABASES_ALLOW_RANDOM`
to be `false`.
``` ### Using Your Own Keys
PTERODACTYL_CLIENT_DATABASES_ENABLED=true Pterodactyl comes preconfigured using a public set of reCAPTCHA keys but you may wish to use your own site
PTERODACTYL_CLIENT_DATABASES_ALLOW_RANDOM=true specific keys. To do so, follow the instructions below.
```
## Forcing Environment From File 1. Visit [Google's reCAPTCHA Admin Console](https://www.google.com/recaptcha/admin#list).
Out of the box Pterodactyl supports reading certain settings from the database rather than the `.env` file. This is 2. Click "Register New Site" and fill in a name for your keys.
mainly to make configuration easier for administrators, and let you avoid having to SSH into the server to make 3. Choose `reCAPTCHA v2` and ensure that the option for `Invisible` is selected.
changes. However, there are also instances where this behavior might be undesirable — for example, if you lock 4. Include the domain that your panel is located on.
yourself out of the Panel because of a bad reCAPTCHA key. 5. On the next page displayed, locate the "Site Key" and "Secret Key". In Pterodactyl's control panel click on "Settings" and then the "Advanced" tab. Enter the keys in the boxes "Site Key" and "Secret Key", respectively.
If you want to force the Panel to read only from `.env` and not use settings stored in the database, add or edit ::: warning Disabling Domain Verification
`APP_ENVIRONMENT_ONLY` in your `.env` file to be `APP_ENVIRONMENT_ONLY=true`. This will ignore settings in the If you do not want reCAPTCHA to verify the domain making the validation request you can uncheck "Verify the origin of reCaptcha solution" under "Advanced Settings" after generating your key.
database, and read only from the environment file. Once you have resolved whatever issues you might be having :::
you can change it to be `false` to go back to using the database.
### Manually editing the database
If you need to manually edit a setting, you can do so by changing the value in the `settings` table in the Pterodactyl
database. Some values are encrypted however, so you cannot just edit those, you'll either need to provide a new
encrypted value or follow the instructions above for reading from the environment until you fix it manually in the Panel.
## Report All Exceptions
By default Pterodactyl only logs and reports exceptions that are, well, exceptional by nature. There are some exceptions
that we expect to occur such as authentication failures or validation issues. However, in rare instances when developing,
or even on production servers, you might need to have all exceptions logged to detect inconsistent behavior.
To do this, simply set `APP_REPORT_ALL_EXCEPTIONS=true` in your `.env` file. You'll want to turn this off once you've
completed whatever it is you're needing the exceptions for, otherwise your logs will become very large, very quickly.