.\" (C) Copyright 2014 Marcin Kulisz (kuLa) <marcin@bashton.com>,
.TH APT-TRANSPORT-S3 8 "August 14, 2014"
.SH NAME
.SH DESCRIPTION
apt-transport-s3 \- it's a package which contains apt transport ('plugin')
allowing apt to fetch files stored in private repositories held on AWS S3.

.SH Bucket name
According to the S3 bucket naming convention to make it working with this
transport over TLS bucket name can NOT contain dots in it. More information
about it can be found at
https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html

.SH AWS Credentials
To access repositories held on S3 it is compulsory to have correct permissions
into the bucket where repository is located and those permissions have to be
reflected in at least one of below two places.

.B IAM Roles
default place where S3 transport is looking for credentials allowing for
fetching files from S3 bucket

.B /etc/apt/s3auth.conf
credentials configuration file in ini format without section headers

.SH URI format
URI format is in standard apt format only difference with S3 transport is that
instead of HTTP(s), cdrom or FTP protocol
.B s3
should be used
.br
ex.
.IR "deb [trusted=yes] s3://bucket_name/ testing main contrib non-free"

.PP
.SH EXAMPLE /etc/apt/s3auth.conf
 AccessKeyId = myaccesskey
 SecretAccessKey = mysecrectkey
 Region = eu-west-1
 Endpoint = 'nyc3.digitaloceanspaces.com'