Skip to main content

S3

config
destination:
  s3:
   - endpoint: somewhere:9000
     structured: true
     bucket: your-bucket-name
     region: us-east-1
     use_static_creds: true
     accesskey: your-access-key
     secretkey: your-secret-key
     token: your-token
     usessl: true
     storageclass: ""
     src_repo_url_tag_key: ""
     datecreatedir: true
     zip: true
     lfs: true
  • endpoint: the endpoint of your S3 storage.
  • structured: if set to true, it checks out the repos in a more structured way, like hoster/user|organization/repository.
  • bucket: the name of your bucket.
  • region: the S3 region, for example us-east-1.
  • use_static_creds: if set to true, use accesskey, secretkey and token. If set to false, use IAM instance credentials, for example on AWS EC2 or ECS. Default is true.
  • accesskey: the access key for your bucket. This can be an environment variable, just leave out the $-sign.
  • secretkey: the secret key for your bucket. This can be an environment variable, just leave out the $-sign.
  • token: the token for your bucket. This can be an environment variable, just leave out the $-sign.
  • usessl: whether you use ssl or not.
  • storageclass: the storage class which is applied to all repositories uploaded to this S3 bucket.
  • src_repo_url_tag_key: if set, each uploaded object is tagged with this key and the source repository URL as the value. Leave unset to disable tagging.
  • datecreatedir: If true, gickup will create a directory for backup with the creation date.
  • zip: whether you want to upload it as a zip file or not.
  • lfs: fetch all Git LFS objects into the temporary bare repository before upload. Works with both ZIP archives and individual-file uploads. Defaults to false.

With lfs: true, both git and git-lfs must be installed. Allow enough temporary disk space for the repository and its LFS objects. A failed LFS fetch causes that repository's upload to be skipped.