Skip to main content

AWS S3

Connect your own Amazon S3 bucket to store GitSec backups.

Prerequisites

  • An AWS account with access to S3.
  • An S3 bucket created in your desired region.
  • An IAM user or role with read/write access to the bucket.
  • The Access Key ID and Secret Access Key for the IAM user.

Setup Steps

  1. Navigate to Storage in the sidebar.
  2. Click Add Storage Provider.
  3. Select the AWS S3 card.
  4. Fill in the connection form:
FieldDescription
Connection NameA label to identify this storage connection (e.g., "Production S3 Backup").
Bucket NameThe name of your S3 bucket.
RegionThe AWS region where the bucket is located (e.g., eu-west-1).
Access Key IDThe AWS access key for authentication.
Secret Access KeyThe AWS secret key for authentication.
  1. Click Test Connection to verify GitSec can access the bucket.
  2. If the test succeeds, click Save to complete the setup.
tip

Click Show Instructions on the form for detailed guidance on creating the required IAM policy and bucket configuration.

Required IAM Permissions

Your IAM user or role needs the following S3 permissions on the target bucket:

{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:GetObject",
"s3:ListBucket",
"s3:DeleteObject"
],
"Resource": [
"arn:aws:s3:::your-bucket-name",
"arn:aws:s3:::your-bucket-name/*"
]
}
]
}

Replace your-bucket-name with your actual bucket name.

Security Recommendations

  • Use a dedicated IAM user with only the permissions listed above.
  • Enable bucket versioning for additional protection.
  • Consider enabling server-side encryption (SSE-S3 or SSE-KMS) on the bucket.
  • Restrict bucket access to only the GitSec IAM user.