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

Document new environment variables for S3 backup (#486)

Browse Source
This commit is contained in:
Pascal Zarrad 2022-10-14 19:23:35 +02:00 committed by GitHub
parent d164684913
commit 7d31df56da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
panel/1.0/additional_configuration.md
View File

@ -39,8 +39,18 @@ AWS_SECRET_ACCESS_KEY=
AWS_BACKUPS_BUCKET= AWS_BACKUPS_BUCKET=
AWS_ENDPOINT= AWS_ENDPOINT=
``` ```
For some configurations, you might have to change your S3 URL from `bucket.domain.com` to `domain.com/bucket`. To accomplish this, add `AWS_USE_PATH_STYLE_ENDPOINT=true` to your `.env` file. For some configurations, you might have to change your S3 URL from `bucket.domain.com` to `domain.com/bucket`. To accomplish this, add `AWS_USE_PATH_STYLE_ENDPOINT=true` to your `.env` file.
The S3 backup is using the S3 multipart upload capabilities. In rare situations, you might want to adjust the size of a single part or the lifespan of the generated pre-signed URLs. The default part size is 5GB, and the default pre-signed URL lifespan is 60 minutes. You can configure the maximal part size using the `BACKUP_MAX_PART_SIZE` environment variable. You must specify the size in bytes. To define the pre-signed URL lifespan, use the `BACKUP_PRESIGNED_URL_LIFESPAN` variable. The expected unit is minutes.
The following `.env` snippet configures 1GB parts and uses 120 minutes as the pre-signed URL lifespan:
```bash
BACKUP_MAX_PART_SIZE=1073741824
BACKUP_PRESIGNED_URL_LIFESPAN=120
```
## Reverse Proxy Setup ## Reverse Proxy Setup
When running Pterodactyl behind a reverse proxy, such as [Cloudflare's Flexible SSL](https://support.cloudflare.com/hc/en-us/articles/200170416-What-do-the-SSL-options-mean-) When running Pterodactyl behind a reverse proxy, such as [Cloudflare's Flexible SSL](https://support.cloudflare.com/hc/en-us/articles/200170416-What-do-the-SSL-options-mean-)
@ -67,6 +77,7 @@ proxy_request_buffering off;
``` ```
### Cloudflare Specific Configuration ### Cloudflare Specific Configuration
If you're using Cloudflare's 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. Below is an example of how to set this.
@ -100,7 +111,6 @@ reCAPTCHA can easily be disabled using the admin panel. In the Settings, select
If you cannot access your panel, you can modify the database directly using the following commands. If you cannot access your panel, you can modify the database directly using the following commands.
```sql ```sql
mysql -u root -p mysql -u root -p
UPDATE panel.settings SET value = 'false' WHERE `key` = 'settings::recaptcha:enabled'; UPDATE panel.settings SET value = 'false' WHERE `key` = 'settings::recaptcha:enabled';