S3 Buckets¶
Muppy uses S3 (or S3-compatible) buckets whenever it needs to store data — database backups, database copies, PITR archives.
Buckets are configured from Muppy / Configuration / S3 Buckets.
Supported storage providers¶
The Type field selects the provider, and determines which fields Muppy requires:
| Type | Notes |
|---|---|
| AWS S3 | The only type that does not need an Endpoint URL. |
| Cloudflare R2 | |
| Minio | |
| Infomaniak | See Don't write metadata below. |
| Scaleway Object Storage | See Don't write metadata below. |
| Dell Elastic Cloud Storage | Use default as the REGION. |
| OVH Openstack Object Storage | |
| Generic S3 bucket | Any other S3-compatible storage. |
Creating a bucket¶
| Field | Meaning |
|---|---|
| Bucket Name | The bucket's technical name — the one used in aws commands. |
| Description | Free text. Put the human-readable information here, not in the name. |
| Type | The provider, from the table above. |
| Endpoint URL | Required for everything except pure AWS S3. |
| Console URL | Optional link to whatever admin console you use to browse the bucket. |
| REGION | Required for AWS S3. |
| Company / Qualifier / Is System | Ownership and classification. |
Credentials¶
The Credentials tab takes two sets of keys, and both are required:
- Backup credentials (
ACCESS_KEY_ID/SECRET_ACCESS_KEY) — used for backup and copy operations. - Admin credentials (
ACCESS_KEY_ID (Admin)/SECRET_ACCESS_KEY (Admin)) — used for delete operations.
Splitting them means the credentials that write your backups cannot erase them.
Advanced¶
| Field | Meaning |
|---|---|
| --no-verify-ssl | Adds that flag to every aws invocation. Use it on a private network whose bucket certificate cannot be verified. |
| Don't write metadata | Some buckets restrict S3 metadata size so tightly that Muppy cannot write it (Infomaniak, Scaleway). Check this to stop Muppy trying. Be aware that such a bucket can no longer be reindexed. |
| s3 cmd 'endpoint options' | Computed. The endpoint flags Muppy passes to aws. |
| Backup ENV vars / Admin ENV vars | Computed. The environment-variable form of each credential set. |
| Debug Host | The Host used to run test tasks against this bucket (see below). |
Testing connectivity¶
Set a Debug Host in the Advanced tab, then click Launch ls in the form header.
The task installs the aws CLI on that Host if needed, then runs an aws s3 ls and opens
the resulting Task Run so you can read its output.
AWS CLI command helper¶
The s3 Base Command field holds a complete, ready-to-paste aws command line, with the
credentials and endpoint options already filled in. Copy it with the clipboard button and
use it as the starting point for inspecting the bucket by hand.
Run it on a host that has the aws CLI installed.
Reindexing a bucket¶
Muppy can rebuild its index of the objects stored in a bucket. This is how you recover the database backups (pg_dumps) written by another Muppy server and make them restorable here.
Click Reindex S3 Objects in the form header. The wizard offers:
| Option | Effect |
|---|---|
| Force update | Update objects that Muppy already knows about, instead of skipping them. |
| Prune | Delete the pg_dump objects Muppy still lists but that are no longer on the bucket. |
| Never delete | Set the Never Delete flag on every reindexed object. |
| Don't link | Leave Is Linked false on every reindexed object. |
| S3 objects prefix | Restrict the sweep to one prefix. No leading or trailing /. |
Last Sync on the bucket form records when the last reindex ran.
The Open S3 Objects button opens the objects Muppy has indexed for this bucket.