You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Bump version to 2.5.0 in setup.py and Makefile
- README: fix S3 section - credentials are nested under credentials object, not top-level
- README: fix GS section - remove boto2/.boto references, reflect actual gcs_creds_path config
- README: replace real-looking AWS key placeholders with YOUR_ACCESS_KEY_ID style
- README: update source/destination overview lists to include all new drivers
@@ -465,68 +465,68 @@ You can specify an S3 bucket to back up to.
465
465
466
466
```json
467
467
{
468
-
"bucket": "backups-123456789",
468
+
"id": "s3-backup",
469
+
"type": "s3",
470
+
"bucket": "my-backup-bucket",
471
+
"region": "eu-west-1",
472
+
"credentials": {
473
+
"aws_access_key_id": "YOUR_ACCESS_KEY_ID",
474
+
"aws_secret_access_key": "YOUR_SECRET_ACCESS_KEY"
475
+
},
476
+
"retention_copies": 7,
477
+
"retention_days": 30
469
478
}
470
479
```
471
480
472
-
The 'aws' CLI client gets it's authentication credentials and other configuration from the 'backups' user's '~/.aws/config' file. This needs to be configured as per instructions in the AWS CLI documentation.
481
+
If `credentials` are omitted, the AWS CLI will fall back to the standard credential chain (`~/.aws/credentials`, IAM instance role, environment variables, etc.).
482
+
483
+
For S3-compatible services (e.g. MinIO, Wasabi), supply `endpoint_url`:
473
484
474
-
Additionally, the S3 destination provides some simple backup rotation options. After a successful backup, the backup files are listed and the 'retention_copies' and 'retention_days' options, if present, are applied to identify and remove any backups that are no longer required.
The 'gs' destination module uses the boto library in conjunction with 'gsutil.' The 'gsutil' CLI client gets it's authentication credentials and other configuration from the 'backups' user's '~/.boto' file.
501
-
502
-
The GS module requires a GCP service account to be created with appropriate permissions to write and delete from GS buckets. The key file needs to be in P12 format. IMPORTANT: Properly secure this file and related information.
503
-
504
-
More information on configuring gsutil and boto as well as preparing a service account can be found at https://cloud.google.com/storage/docs/boto-plugin.
AWS and GCP credential data can happily share the same section.
517
-
518
-
Additionally, the GS destination provides some simple backup rotation options. After a successful backup, the backup files are listed and the 'retention_copies' and 'retention_days' options, if present, are applied to identify and remove any backups that are no longer required.
520
+
Create a GCP service account with Storage Object Admin on the target bucket, download the JSON key file, and place it on the backup host. Ensure `gsutil` is authenticated with the same service account (e.g. via `GOOGLE_APPLICATION_CREDENTIALS` or `gcloud auth activate-service-account`).
519
521
520
522
Parameters available in 'gs':
521
523
522
524
| Config key | Purpose |
523
525
|------------|---------|
524
-
| bucket | GS bucket to dump files to. |
525
-
| gs_service_client_id | GCP service account. |
526
-
| gs_service_key_file | Location of service account file (in P12 format). |
527
-
| gs_service_key_file_password | Password for service account file. |
526
+
| bucket | GCS bucket name. |
527
+
| gcs_creds_path | Path to the GCP service account JSON key file. |
528
528
| retention_copies | How many copies of older backups to keep. |
529
-
| retention_days |How many days of backups to keep. |
529
+
| retention_days | How many days of backups to keep. |
530
530
531
531
532
532
Destination - Samba
@@ -981,8 +981,8 @@ This simple example backs up some folders and a database, and deposits them to a
0 commit comments