Setup Instructions: =======

Just follow the following simple steps and setup the plugin in 5 minutes:

- Create a Digital Ocean Space Bucket
- Create your Access Key and Secret Key ID

Note: You can follow this simple tutorial to setup the above mentioned: ( https://www.digitalocean.com/community/tutorials/how-to-create-a-digitalocean-space-and-api-key )

Add the following information to your plugin configuration page:

- AccessKeyID - your digital ocean access key
- SecretKeyID - Your digital ocean secret key
- Region - Your digital ocean space region. Can be found in your endpoint url. For example: If your endpoint url is (  https://[Your Bucket Name].nyc3.digitaloceanspaces.com ) then: nyc3 is your region.
- BucketName - Your digital ocean bucket name, can also be extracted from your endpoint. Like: If your endpoint is ( https://mybubblebucket.nyc3.digitaloceanspaces.com ) then: mybubblebucket is your bucketName.
- Endpoint Url - This should be the endpoint url of digital ocean, Remember to remove your bucketName from your endpoint url if its included in the url already, for example: https://mybubblebucket.nyc3.digitaloceanspaces.com should become https://nyc3.digitaloceanspaces.com after remove the "mybubblebucket" name from the url.



Usage Instructions
=======

The plugin provide you 4 Workflow actions:

1. Upload file
2. List Files
3. Get File
4. Get file Url

Details:
======

1. Upload File:
====

Requires 3 values:
   1. filename: The name of the file to be saved in the cloud storage.
   2. access_permission: The permission settings for your files based on how accessible you want them to be.
   3. file : The File iteself served through the bubble's file upload element.


After a successful upload, it returns the following information:

   1. file_url : The digital ocean space url of the uploaded file.
   2. filename : the filename of the stored file.
   3. bucket : bucket name the file is uploaded to.
   4. error: yes/no - Will be yes if there is an error with the upload, otherwise no.
   5. error_message: Contains the error message if the error is yes, otherwise empty.



2. List Files:
====

Requires 1 value:
   1. search_key: The value to search matching files for.


It returns the following information:

   1. files (list of text) - Filenames of the returned results.
   2. count (number) - The total number of files found
   3. etags (list of text) - ETags of the returned results.
   4. error (yes/no) - Will be yes if there is an error with the operation, otherwise no.
   5. error_message: Contains the error message if the error is yes, otherwise empty.



3. Get File:
====

Requires 1 value:
   1. key: The name of the file to get.


It returns the following information:

   1. last_modified (date) - time and date the file was last modified
   2. content_length (number) - file size in kb.
   3. etag  (text) - ETags of the returned file.
   4. is_error (yes/no) - Will be yes if there is an error with the operation, otherwise no.
   5. error_message: Contains the error message if the error is yes, otherwise empty.



3. Get File Url:
====
Its a helper functio which Create accessible file url, without connecting to Digital ocean, and thats why its faster.


Requires 1 value:
   1. filename: The name of the file to get.


It returns the following information:

   1. file_url (text) : the file url for digital ocean spaces.