Cloudcube is a Storage-as-a-Service add-on that provides fast and easy uploading and privacy management for static files on Amazon S3 via an intuitive dashboard.
Table of Contents
- File Privacy
- Connecting within your app
- Migrating Between Plans
- Removing the Add-on
Provisioning the add-on
Cloudcube can also be attached to a Heroku application via the CLI:
$ heroku addons:create cloudcube:PLANNAME -a HEROKU_APPNAME
Upon provisioning, 3 configuration variables (config vars) are set for your project/application automatically. Your app can use these to interact with your cube programmatically via one of the AWS SDKs or the AWS REST API.
CLOUDCUBE_ACCESS_KEY_IDis the AWS Access key for accessing the underlying AWS bucket.
CLOUDCUBE_SECRET_ACCESS_KEYis the AWS Secret that, when paired with the Access Key, allows manipulation of your cube from your app code.
CLOUDCUBE_URLis the base URL root of a cube. All public files have a URL path that begins with this value. For example, if
https://cloudcube.url/mycube, then a public file within the cube (e.g.,
public/example.txt) is accessible from
Custom cube names
Some plans allow a custom name for your cube to be supplied via the Heroku CLI during provision. The command for doing so is:
$ heroku addons:create cloudcube:PLANNAME -a HEROKU_APPNAME --cubename=CUSTOMCUBENAME
E.g. If you are planning to attach a
Cloudcube with plan
prototype to your application (my-startup-dev) and want to give your cube the custom name
my-startup, you would use the following CLI command:
$ heroku addons:create cloudcube:prototype -a my-startup-dev --cubename=my-startup
If the custom cube name is not available, the provision attempt will return an error.
The Cloudcube dashboard is a GUI representation of your cube and its contents. You can use it to upload and search for files, as well as move, rename, and delete them.
You can also reveal your cube's AWS IAM credentials and current storage usage from the side pane:
Cloudcube files can be either public or private. Public files are given a URL that can be shared with others or used from your application code. Private files are not given a URL and cannot be accessed. The privacy of a file is determined by its file path within the cube.
Modify File Privacy
To make a file public, its path must include a directory named
public. All other files are private by default.
For example, the following file is public because its path includes a
The following file is private because its path does not contain a
A directory named
publicanywhere in a file's path will cause the file to be public. For example, the following file is public:
Connecting within your app
Cloudcube provides AWS IAM credentials that you can use to access your cube programmatically.
Take care to NEVER hard-code your credentials into your application. Pushing your code to a public place like Github will expose these hard-coded values to the world and alert us that your account has been compromised. Cloudcube will subsequently rotate your credentials without notice and any code or client relying on the old credentials will lose cube access until the new credentials are used. It is good practice to have your application refer to the Config Vars set on your application rather than the literal values themselves. This keeps them hidden and your account secure.
S3 API and Bucket Name
Your cube is your unique private space within our pre-configured S3 buckets and is implemented as a key prefix to your files within the bucket. When connecting to AWS directly with your IAM credentials, you may need to provide the name of the S3 bucket you are connecting to. The bucket name can be found in the URI provided with your credentials on your dashboard and in your Configuration Variables. The format of the URI is as follows:
E.g. If your URI is
https://cloud-cube-eu.s3.amazonaws.com/mycube, then your bucket name is
When interacting with files, the cube name must appear as the prefix to any key you upload, modify, or delete.
E.g. If you wish to upload a file,
example.pdf, to the
public folder within your cube
mycube, you would specify the key as
Buckets are hosted in different AWS regions and these regions can be determined from the following table.
|Bucket Name||AWS Region|
Connecting from SDK
Migrating between plans
Your Cloudcube plan can be upgraded or downgraded from your platform's dashboard.
It can also be changed on Heroku via the following CLI command:
$ heroku addons:upgrade cloudcube:NEW_PLANNAME -a HEROKU_APPNAME
Removing the add-on
Removing the add-on will result in the permanent loss of all files in your cube!
Cloudcube can be removed from your application via your platform's dashboard page.
It can also be removed from Heroku via the following CLI command:
$ heroku addons:destroy cloudcube -a HEROKU_APPNAME