Object storage (S3)

Purpose — An S3 destination is an S3-compatible object storage target that Notploy uses to store backups and restore from them. You configure a destination once, then reference it when scheduling database and volume backups.

How it fits into Notploy

An S3 destination is a resource: it is not tied to a single service. Multiple databases and volumes can back up to the same destination, and restores read from it. This makes the destination part of your disaster-recovery path — if it is misconfigured, you find out when you try to restore.

Database / Named volume  ──scheduled backup──►  S3 destination (bucket)
                                                  │
                          restore  ◄──────────────┘

Supported destinations

Notploy works with any S3-compatible provider. Guides are available for the common ones:

Multiple destinations are supported, so you can separate production and staging backups.

Prerequisites

• An S3-compatible account with a bucket you control.
• An access key and secret with permission to read and write objects in that bucket.
• Network access from the Notploy host to the provider's endpoint.

Configuration

Configure destinations under Settings → S3 Destinations, providing the endpoint, region, bucket and credentials. Then select the destination when you create a backup schedule on a database or volume.

Verification

Create a manual backup to the destination and confirm the object appears in the bucket. Then — before you rely on it — perform a restore in a safe environment.

Security and limitations

• Never put real credentials in examples or repositories; store them in Notploy's settings, which are encrypted.
• Volume Backups only cover Docker named volumes, not bind mounts (../files).
• Restoring overwrites current data — always confirm the snapshot.

Related

• Backups
• Volume backups
• Restore