Felix Cloud Storage
Last updated June 17, 2020
The Felix Cloud Storage add-on is currently in beta.
Felix Cloud Storage is an Amazon S3-based cloud storage add-ons, dedicated to providing Heroku users with simple and efficient storage services. No need to sign up for a separate Amazon account in order to use Felix Cloud Storage, Felix will automatically generate access credentials for you. Users can easily manipulate their files through the Felix dashboard, and Felix can also dynamically generate the code snippets you need.
Provisioning the add-on
Felix Cloud Storage can be attached to a Heroku application via the CLI:
A list of all plans available can be found here.
$ heroku addons:create felix:PLANNAME
Config vars
Upon provisioning, Felix will add 5 config vars for your application. FELIX_USER_EMAIL, FELIX_USER_PASSWORD, FELIX_AWS_USER_ARN, FELIX_AWS_ACCESS_KEY_ID, and FELIX_AWS_SECRET_ACCESS_KEY
| Name | Description |
|---|---|
| FELIX_USER_EMAIL | Email is used to log in to the Felix dashboard. |
| FELIX_USER_PASSWORD | Password is used to log in to the Felix dashboard. |
| FELIX_AWS_USER_ARN | Amazon Resource Names (ARNs) of your Amazon user. |
| FELIX_AWS_ACCESS_KEY_ID | Access Key Id is used for programmatic (API) access to AWS services. |
| FELIX_AWS_SECRET_ACCESS_KEY | Secret Access Key is used for programmatic (API) access to AWS services. |
Dashboard
The Felix dashboard is used to manage your S3 buckets and files. You can access the dashboard from App homepage, or visit our website and log in using FELIX_USER_EMAIL andFELIX_USER_PASSWORD in Config Vars.
Space
To upload files to Felix, you must have at least one Space. Space defines a piece of storage space on Amazon S3. When you create a Dedicated Space, we will create a separate S3 Bucket for you. You can upload and download files to this bucket through the dashboard or programmatically. You can also create a Shared Space, and we will create a folder for you in a specific S3 bucket. There is no separate quota for Shared Space. You will share the quota of this bucket with others. Please use it in testing and evaluation.
Shared space is a special storage mode. Felix will create a directory in the S3 bucket for each space to store all files. The creator of Space has read and write permissions to this directory. This Space has no independent quota. All Spaces related to this bucket share the quota of this bucket (such as 100GB-Mo storage). When the bucket usage exceeds the quota, all bucket-related spaces will be closed. So please use a shared space with caution.
Full Control
You can turn on or turn off the Full Control option for Space to decide how to operate your bucket or folder.
- when you turn on Full Control
- you CAN upload, download, and delete files through the Amazon S3 API
- you CANNOT manipulate the files in this space through the dashboard
- when you turn off Full Control
- you CAN upload, download, and delete files through the dashboard
- you CAN ONLY download files through the Amazon S3 API
Use-in-code Button
Felix provides Use-in-code buttons for various resources in the dashboard.
By clicking the Use-in-code button, the user can quickly obtain the programming instructions and dynamically generated code fragments of the resource.
Migrating between plans
Your Felix Cloud Storage plan can be upgraded or downgraded from your Heroku application’s dashboard under Resources by choosing Edit Plan.
It can also be changed via the following CLI command:
$ heroku addons:upgrade felix:new-plan-name
All plan names can be found at Heroku Elements
Removing the add-on
Removing the add-on will result in the permanent loss of all files in your space!
Felix Cloud Storage can be removed from your application via the Heroku Dashboard under ‘Resources’.
It can also be removed via the following CLI command:
$ heroku addons:destroy felix
Support
All Felix Cloud Storage support and runtime issues should be submitted via one of the Heroku Support channels.
