Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
WouterVanNifterick committed Jan 7, 2024
1 parent 5af903c commit 0fed35d
Showing 1 changed file with 74 additions and 16 deletions.
90 changes: 74 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,27 @@
# wfx-s3
# WFX-S3 : Total Commander S3 plugin

[![GitHub releases](https://img.shields.io/github/downloads/woutervannifterick/wfx-s3-wvn/total.svg)](https://github.com/woutervannifterick/wfx-s3-wvn/releases)
[![Issues open](https://img.shields.io/github/issues/woutervannifterick/wfx-s3-wvn.svg)](https://github.com/woutervannifterick/wfx-s3-wvn/issues)
[![Issues closed](https://img.shields.io/github/issues-closed/woutervannifterick/wfx-s3-wvn.svg)](https://github.com/woutervannifterick/wfx-s3-wvn/issues?q=is%3Aissue+is%3Aclosed)
[![License](https://img.shields.io/github/license/woutervannifterick/wfx-s3-wvn.svg)](https://github.com/woutervannifterick/wfx-s3-wvn/blob/master/LICENSE)

![AWS](https://img.shields.io/badge/S3-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white)
![WFX](https://img.shields.io/badge/WFX-%23666688.svg?style=for-the-badge)
![Delphi](https://img.shields.io/badge/Delphi-%23EE1F35.svg?style=for-the-badge&logo=delphi&logoColor=white)

### What is this?
This is a free [Total Commander](https://www.ghisler.com/) FileSystem (WFX) plugin.

It lets you browse and manage files in your [Amazon S3 buckets](https://aws.amazon.com/s3/).
It lets you browse and manage files in your [Amazon S3 buckets](https://aws.amazon.com/s3/).



#### What is S3?
S3 is a cloud storage service provided by Amazon Web Services (AWS).
For small amounts of data, it's free. For larger amounts, it's very cheap. It can be used to store backups, or to host static websites.

#### What is Total Commander?
Total Commander is a file manager for Windows. It's a great tool for power users, and it's highly customizable.


# Features
Expand All @@ -18,13 +31,30 @@ It lets you browse and manage files in your [Amazon S3 buckets](https://aws.ama
* Pick an AWS account
* Directly copy/move files between two S3 buckets

### Why use this plugin?
This plugin is:
* **Free**, open source, has no ads or tracking, and doesn't try to sell you anything.
* It's a native plugin, so it's fast, lightweight, and doesn't need any frameworks or additional software to be installed.
* It doesn't only let you browse, but also lets you create, delete, upload, download, rename, copy, and move files and folders.
* It's easy to use. You can use it without having to learn any new commands.

And of course, it's awesome being able to browse your S3 buckets from within Total Commander. 😎

# Installation
#### Automatic (recommended)

### Prerequisites
* This plugin. [See downloads](https://github.com/WouterVanNifterick/wfx-s3-wvn/tags)
* [Total Commander](https://www.ghisler.com/)
* [An Amazon Web Services (AWS) account](https://aws.amazon.com/). <br>
*Note: having S3 buckets are optional, as you can create them from within the plugin.*


#### Automatic installation (recommended)

Using Total Commander, locate the downloaded .zip file and open it.<br />
Total Commander will ask you if you want to install the plugin.

#### Manual
#### Manual installation
<details><summary><i>In case you want more control: (click to expand)</i></summary>
1. Extract the contents of the .zip file to a folder of your choice.
2. In Total Commander, open the Options dialog (menu Configuration -> Options).
Expand All @@ -39,14 +69,16 @@ It lets you browse and manage files in your [Amazon S3 buckets](https://aws.ama
# Usage

### Start using the plugin
1. In Total Commander, open the Network Neighborhood.
- Using keyboard: <kbd>Alt+F1</kbd>, then <kbd> \ </kbd>
2. Select "S3" from the list.
3. The plugin will automatically attempt to use your default AWS credentials.
- If you have multiple AWS accounts, you can select the account to use from the list.
4. You'll now see a list of your S3 buckets.
5. Select a bucket to browse its contents.
6. You can now browse, create, delete, upload, download, rename, copy, and move files and folders.
1. Installed the plugin. [See installation](#installation)
2. Open the plugin:
- <kbd>Alt+F1</kbd>, then <kbd> \ </kbd>. (Network Neighborhood)
- Select "S3" from the list.
3. Connect to S3
- The plugin will automatically attempt to use your default AWS credentials.
- If you have multiple AWS accounts, you can select the account to use from the list.
4. Pick one of your buckets from the list.

5. You can now browse, create, delete, upload, download, rename, copy, and move files and folders.

### Copy/move files between two S3 buckets
To copy/move files between two S3 buckets, open another instance of the plugin on the other pane and select the other bucket.
Expand All @@ -70,7 +102,33 @@ For now, if you want to change the permissions, you'll have to do that in the [A
To delete a bucket, go up to the parent folder, and press <kbd>F8</kbd>.
It'll ask you to confirm the deletion. Watch out, because this is irreversible!

### Prerequisites
* Total Commander
* An Amazon Web Services (AWS) account
* An S3 bucket
# Roadmap
* [x] Browsing a bucket
* [x] Picking from a list of **buckets**
* [x] Picking from a list of **AWS accounts**
* [x] **Uploading/downloading** files
* [x] Creating/deleting **buckets**
* [x] Renaming files
* [x] Copying/moving files between **two S3 buckets**
* [x] Deleting files
* [ ] Deleting folders
* [ ] Setting permissions
* [ ] Setting / Viewing metadata
* [ ] Viewing object version history

# Support
This plugin was mainly built to scratch my own itch, in my spare time.
I'm sharing it for free because I thought somebody else might find it useful.

The more positive feedback I get, the more motivated I am to improve it.

### Found a bug, or want to request a feature?

1. Preferred option:
1. Fork this repository
1. Fix the bug/implement the improvement
1. Create a pull request
1. Alternative:
1. Create an issue on GitHub.
1. Wait for me to fix it/implement it.
1. To speed things up: [convince](https://patreon.com/WoutervanNifterick) my wife that I should spend more time on this, and less on social activities and household chores. 😅

0 comments on commit 0fed35d

Please sign in to comment.