How to use file browsers with Cloud Storage
UKCloud's Cloud Storage service is an object storage solution based on Dell EMC Elastic Cloud Storage (ECS). Access is via a RESTful application programming interface (API).
Web applications can easily interact with the API, but the ability to browse the contents of the storage using a graphical client can be useful, as it provides a user friendly interface to the storage. This enables, for example:
Verification by developers that their applications or scripts work as intended with the storage
Bulk import or export of content by users
Easy maintenance and housekeeping of the objects in the storage system
ECS provides two APIs that you can use to manage Cloud Storage: the S3 compatible API and the EMC ECS Atmos API.
If you write content to Cloud Storage using one of the APIs, you cannot subsequently access that content using the other API. Choose carefully which API you want to use before beginning a project, as it will be difficult to move between them.
In this article, we'll look at some of the many applications that enable you to browse an object storage system. We'll look at two categories:
The inclusion of applications in this article should not be taken as an endorsement or recommendation of them by UKCloud. However, we have tested them with our Cloud Storage service and verified that they work correctly.
Cloud Storage provides different API endpoints to access your storage, depending on the UKCloud site and connectivity type you are using. Make sure you use the correct endpoint to ensure the best possible performance for your solution.
S3 API endpoints:
If you're using the ENHANCED option (geo-resilient storage), you can use either the Corsham or Farnborough endpoints. In the event of a site failure, there will be an outage to objects created on the failed site. UKCloud will bring these objects online in the other site within about 15 minutes.
Contact UKCloud support if you are unsure which endpoint to use.
This section takes you through installing and configuring two applications: Cyberduck and S3 Browser.
Cyberduck is an open source cross platform file browser for HTTP based object storage solutions. It utilises the S3 endpoints to establish connectivity with the ECS platform over HTTPS.
To install and configure Cyberduck:
Install Cyberduck using either the default settings or specifying your own configuration.
Download the Cloud Storage Cyberduck profile.
If you download this profile using a browser, ensure the file name is
Browse to the downloaded file and double click to open it.
Complete the fields in the new connection dialog box:
Ensure you enter the correct endpoint in the Server field, as shown in API endpoints
The Access Key ID is your User ID, which you can find in the Storage section of the UKCloud Portal
When you're done, click the x icon to close the dialog box
You can see the new connection in the Cyberduck UI.
Right-click the connection and select Connect to server.
In the Login dialog box, in the Secret Access Key field, enter your Cloud Storage secret key.
If you've forgotten or don't know your secret key, you can reset it in the Storage section of the Portal.
Unless you want the password to be saved, deselect the Save password check box.
After you've authenticated yourself with your secret key, you can view, upload and download files as normal.
For additional information, see Connecting to ECS with Cyberduck.
S3 Browser is a Windows client for Amazon S3 that you can easily configure to work with the S3 compatible API on Cloud Storage. It’s free for personal use; a licence fee is payable for business use.
To install and configure S3 Browser:
Download S3 Browser.
Execute the installer and follow the prompts in the wizard to complete the installation.
The first time you launch S3 Browser, you'll be prompted for your account credentials. Fill in the form with your Cloud Storage credentials:
a. From the Account Type list, select S3 Compatible Storage.
b. Ensure you enter the correct endpoint in the REST Endpoint field, as shown in API endpoints.
c. The Access Key ID is your User ID, which you can find in the Storage section of the Portal.
d. The Secret Access Key is your secret key. If you've forgotten or don't know your secret key, you can reset it in the Storage section of the Portal.
e. If you're using version 6.x.x of the browser, be sure to select Use secure transfer (SSL/TLS). This option is not available or necessary for version 5.x.x.
When you're done, click Save changes. The application automatically connects to Cloud Storage and displays your buckets (if you have any).
For detailed usage instructions, see the documentation available on the S3 Browser web site.
Not all S3 features are implemented by the ECS S3 compatible API, so some functionality may not work. However, common file operations (create, read, write and delete) all work well.
Internet browser access
This section takes you through installing and configuring browser access that enables users to browse the contents of Cloud Storage using a web browser.
EMC provides an HTML5 application that you can install in your Atmos bucket to generate a URL that enables you to share the bucket with other users who require access to cloud storage.
If you have multiple buckets under the same endpoint, you can provide access to them all from a single URL. However, if you have multiple buckets hosted in both Cloud Storage regions, you'll need to install the application in both regions and access is via a different URL for each region.
S3 extensions are also available for browsers, but none of them include the functionality to customise the server host name, which is a requirement for connecting to Cloud Storage. If we find S3 browser extensions that offer this functionality in the future, we'll update this article.
Atmos HTML5 application
For installation and initial configuration of the Atmos HTML5 application, you will need the following Prerequisite information:
Atmos Access Key - in the form of SubtennantID/User
Atmos Secret Key - Shared Secret Key
A folder within an existing bucket or new bucket to host the GUI files, for example /<bucket_name>/HTML5UI/ or /HTML5UI/
To install and configure the Atmos HTML5 application:
Download and extract the Atmos HTML5 application.
On Windows: Open a command prompt, navigate to the extracted files and run the following command:
upload.bat WebContent\main.html /<bucket_name>/<optional_path>/.
On Linux: Open a terminal prompt, or from the CLI, navigate to the extracted files and run the following command:
upload.sh WebContent\main.html /<bucket_name>/<optional_path>/.
The installer script will run and prompt for the following information:
Atmos host name, which is the UKCloud endpoint URL for your selected storage bucket for example
Atmos port - Enter 443.
Atmos UID - Enter your selected storage bucket's Atmos access key for example
Atmos secret - Enter your selected storage bucket's shared secret key.
When you have provided all the required information, the installer will connect to the bucket and upload the files to the requested folder. Once the script has finished, it will output a URL that you should copy to your clipboard and then keep somewhere safe.
Enter the generated URL into your browser and, when connecting for the first time, the application will prompt you to specify an account UID and shared secret for the account that you want to access. After you enter the UID and secret, you can test the credentials using the test button. If the test is successful, click OK to add the credentials to the application and you can then access the bucket.
If you want to add more cloud storage accounts that are located at the same Cloud Storage endpoint, you can add them to the application using the cog icon in the top right-hand corner.
You can now:
Browse the buckets and files stored in your account
Use the toolbar buttons to upload files
Double-click items to download them
Access other operations for selected items through the toolbar buttons
This article has shown you how to browse Cloud Storage buckets using various different applications. For more information about how to use the service, see the following articles:
Cloud Storage Gateways
If you find an issue with this article, click Improve this Doc to suggest a change. If you have an idea for how we could improve any of our services, visit UKCloud Ideas. Alternatively, you can contact us at email@example.com.