aws

Documentation

Index

• Constants
• func AddBucketName(file *models.File)
• func DeleteObject(file models.File) (bool, error)
• func Download(writer io.WriterAt, file models.File) (int64, error)
• func FileExists(file models.File) (bool, int64, error)
• func GetDefaultBucketName() string
• func Init(config models.AwsConfig) bool
• func IsAvailable() bool
• func IsCorsCorrectlySet(bucket, gokapiUrl string) (bool, error)
• func IsValidLogin(config models.AwsConfig) (bool, error)
• func LogOut()
• func ServeFile(w http.ResponseWriter, r *http.Request, file models.File, forceDownload bool) (bool, error)
• func Upload(input io.Reader, file models.File) (string, error)

Constants

const IsIncludedInBuild = true

IsIncludedInBuild is true if Gokapi has been compiled with AWS support or the API is being mocked

const IsMockApi = false

IsMockApi is true if the API is being mocked and therefore can only be used for testing purposes

Functions

func AddBucketName

func AddBucketName(file *models.File)

AddBucketName adds the bucket name to the file to be stored

func DeleteObject

func DeleteObject(file models.File) (bool, error)

DeleteObject deletes a file from S3

func Download

func Download(writer io.WriterAt, file models.File) (int64, error)

Download downloads a file from AWS, used for encrypted files and testing

func FileExists

func FileExists(file models.File) (bool, int64, error)

FileExists returns true if the object is stored in S3

func GetDefaultBucketName

func GetDefaultBucketName() string

GetDefaultBucketName returns the default bucketname where new files are stored

func Init

func Init(config models.AwsConfig) bool

Init reads the credentials for AWS. Returns true if valid

func IsAvailable

func IsAvailable() bool

IsAvailable returns true if valid credentials have been passed

func IsCorsCorrectlySet

func IsCorsCorrectlySet(bucket, gokapiUrl string) (bool, error)

IsCorsCorrectlySet returns true if CORS rules allow download from Gokapi

func IsValidLogin

func IsValidLogin(config models.AwsConfig) (bool, error)

IsValidLogin checks if a valid login was provided

func LogOut

func LogOut()

LogOut resets the credentials

func ServeFile

func ServeFile(w http.ResponseWriter, r *http.Request, file models.File, forceDownload bool) (bool, error)

ServeFile either redirects the user to a pre-signed download url (default) or downloads the file and serves it as a proxy (depending on configuration). Returns true if blocking operation (in order to set download status) or false if non-blocking.

func Upload

func Upload(input io.Reader, file models.File) (string, error)

Upload uploads a file to AWS