Orion-S3 is a plugin for Eclipse Orion that provides access to an Amazon S3 bucket as a filesystem.
The plugin is hosted from an S3 bucket that is configured as a website. The plugin makes REST requests (to read and write files) against a second bucket. You must have the appropriate credentials to access both buckets.
The first time you use the plugin, it prompts for 3 pieces of information:
- A passphrase: used to encrypt your AWS keys before persisting them.
- Your AWS Access Key: used to sign S3 requests.
- Your AWS Secret Access Key: used to sign S3 requests.
Your Secret Access Key is not transmitted over the wire. However, both AWS keys are encrypted and persisted in your browser's localStorage for the s3.amazonaws.com domain. This saves you from having to type in your keys every time the plugin loads. The passphrase is kept only in memory, so you'll have to re-enter it whenever the plugin loads (eg. when opening a new window or after closing the browser). Do not reveal the passphrase to anyone, because with it a malicious page on the s3.amazonaws.com domain could potentially retrieve and decrypt your encrypted keys from localStorage.
Please consider the security implications of using this plugin, and examine its source code to your satisfaction before using. Never type or paste your secret key into a web page that you do not control. Never install a plugin from an untrusted source.
- Checkout the source from Github.
- Edit the source code of
s3FilePlugin.html. SettargetBucketto the URL of the bucket that will hold your Orion files. The URL must be given using the AWS path-style syntax, so the host is s3.amazonaws.com and the bucket name is the path component of the URL. For example: http://s3.amazonaws.com/myorionfiles - Upload the modified plugin source code to a second S3 bucket that you control. The bucket must be configured to serve static web content. For configuration help, see Hosting Websites on Amazon S3. Ensure all the plugin files are publicly readable, or you'll get 403 errors later.
- Load the plugin's URL to verify that it can be accessed. For example, if your website bucket is "mywebsite", the URL should look something like this: http://s3.amazonaws.com/mywebsite/s3FilePlugin.html
- Log in to Orion. Install the plugin using the URL from the previous step.
- Your target bucket should appear as an additional filesystem in the Orion navigator. Browse into it to view and edit files. The first time you try to access the bucket, you'll be prompted for your passphrase and keys. (See Security, above.)
Note that both targetBucket and the plugin URL use s3.amazonaws.com as the hostname. These hostnames must match exactly, so that
the plugin can make AWS API calls using XMLHttpRequest without violating the same origin policy.
- Create file/folder
- Delete file/folder
- Read and write files
The following features are not implemented:
- Binary data support
- Copy a file/folder
- Rename/move a file/folder
- Remote import/export