Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make S3 backup configuration clearer #573

Closed
wants to merge 4 commits into from
Closed

Make S3 backup configuration clearer #573

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
02b373c
make s3 backup configuration clearer
Boy132 Feb 19, 2024
54fe923
fix typo
Boy132 Feb 19, 2024
114131e
restart pteroq
Boy132 Feb 19, 2024
6523f75
add info about config cache
Boy132 Feb 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion panel/1.0/additional_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Pterodactyl Panel allows users to create backups of their servers. In order to c

When changing Pterodactyl Panel's backup storage method, users may still download or delete existing backups from the prior storage driver. In the instance of migrating from S3 to local backups, S3 credentials must remain configured after switching to the local backup storage method.

Make sure to clear the config cache (`cd /var/www/pterodactyl && php artisan config:clear`) and to restart the queue worker (`systemctl restart pteroq`) after changing the backup driver to apply the changes.

### Using Local Backups

By default, Pterodactyl Panel uses local storage via Wings for backups. That said, this method of backup storage can be explicitly set with the following configuration in the `.env` file:
Expand All @@ -32,16 +34,34 @@ AWS S3 (or compatible storage) can be used to store remote or cloud-based backup
# Sets your panel to use s3 for backups
APP_BACKUP_DRIVER=s3

# Info to actually use s3
# The default region
AWS_DEFAULT_REGION=

# Your access key id & secret
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=

# The name of the bucket
AWS_BACKUPS_BUCKET=

# The URL of the S3 storage (including https:// or http:// respectively)
# If you use AWS you can leave this empty
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.

Example configuration:
```bash
APP_BACKUP_DRIVER=s3

AWS_DEFAULT_REGION=eu-west-1
AWS_ACCESS_KEY_ID=xxxx
AWS_SECRET_ACCESS_KEY=xxxx
AWS_BACKUPS_BUCKET=pterodactyl-backups
AWS_ENDPOINT=https://pterodactyl-backups.s3.domain.com
```

#### Multipart Upload

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.
Expand Down
Loading