From 04de933bbe21cfc5a2bc20b728cb913b1942a70a Mon Sep 17 00:00:00 2001 From: Ambrose Chua Date: Sun, 9 Oct 2016 13:55:47 +0800 Subject: [PATCH 1/4] Create README.md --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e7badcb --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ + +# file-manager + +A basic node.js file manager. + +## Features + +- [x] Directory browsing + - [x] Filesize + - [ ] Permissions + - [ ] Owner +- [x] Folder creation +- [x] File uploads + - [ ] Bulk file uploads +- [ ] File/folder renaming +- [x] Bulk file/folder selection + - [x] Delete + - [x] Download archive + - [ ] Change permissions + +## Usage + +```zsh +git clone https://github.com/ambrosechua/file-manager.git ~/path/to/file-manager +node ~/path/to/file-manager/index.js +# or +npm i -g https://github.com/ambrosechua/file-manager.git +file-manager +``` + +## Options + +Options are currently only suppliable via ENV variables. + +### PORT= + +Listen on + +### KEY= + +Setting this variable enables authentication using +TOTP (RFC6238). is a base32 encoded shared +secret. This key is only a weak means of protection +as it is succeptable to brute-force. You can generate +one from [here](http://www.xanxys.net/totp/) or manually. From 783049632225a4027ce2a60346a0d155672e5de3 Mon Sep 17 00:00:00 2001 From: Ambrose Chua Date: Sun, 9 Oct 2016 14:10:38 +0800 Subject: [PATCH 2/4] Update README.md --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e7badcb..8ee3464 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ A basic node.js file manager. ## Features +- [x] [Simple authentication](https://github.com/ambrosechua/file-manager#key) - [x] Directory browsing - [x] Filesize - [ ] Permissions @@ -17,6 +18,18 @@ A basic node.js file manager. - [x] Delete - [x] Download archive - [ ] Change permissions + +## Screenshots + +![](https://ambrose.makerforce.io/file-manager/login.png) + +![](https://ambrose.makerforce.io/file-manager/upl2.png) + +![](https://ambrose.makerforce.io/file-manager/ls1.png) + +![](https://ambrose.makerforce.io/file-manager/rm1.png) + +![](https://ambrose.makerforce.io/file-manager/dl1.png) ## Usage @@ -32,14 +45,14 @@ file-manager Options are currently only suppliable via ENV variables. -### PORT= +### PORT= -Listen on +Listen on $PORT. Default: 8080 -### KEY= +### KEY= Setting this variable enables authentication using -TOTP (RFC6238). is a base32 encoded shared +TOTP (RFC6238). $KEY is a base32 encoded shared secret. This key is only a weak means of protection as it is succeptable to brute-force. You can generate one from [here](http://www.xanxys.net/totp/) or manually. From febcbf565b48c70113159b6c32f6a083b2cacab1 Mon Sep 17 00:00:00 2001 From: Ambrose Chua Date: Sun, 9 Oct 2016 14:25:45 +0800 Subject: [PATCH 3/4] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 8ee3464..568e0a0 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ A basic node.js file manager. - [ ] File/folder renaming - [x] Bulk file/folder selection - [x] Delete + - [ ] Recursive directory delete - [x] Download archive - [ ] Change permissions From e89766a2a277134d0f434f30bd74b71df5cdbbfc Mon Sep 17 00:00:00 2001 From: Ambrose Chua Date: Sun, 9 Oct 2016 14:43:58 +0800 Subject: [PATCH 4/4] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 568e0a0..133f8dd 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ A basic node.js file manager. - [x] Bulk file/folder selection - [x] Delete - [ ] Recursive directory delete + - [ ] Move + - [ ] Copy - [x] Download archive - [ ] Change permissions