hfs 0.26.9 → 0.29.0

package/README.md

@@ -34,6 +34,7 @@ You won't find all previous features here (yet), but still we got:
 - search
 - accounts
 - resumable downloads
+- resumable uploads
 - download folders as zip archive
 - simple website serving
 - plug-ins
@@ -64,10 +65,21 @@ If your system is not Windows/Linux/Mac, you can try this alternative version:
 1. execute: `sudo npm -g i hfs`
 2. launch: `hfs`
 
-Configuration and other files will be stored in `USER_HOME_FOLDER/.vfs`
+Configuration and other files will be stored in `%HOME%/.vfs`
 
 With this installation method, you can update with `sudo npm -g update hfs` .
 
+### Service
+
+If you want to run HFS as a service
+- if you installed with `npm` on Windows 
+  - service installation
+      - run `npx qckwinsvc2 install name="HFS" description="HFS" path="%APPDATA%\npm\node_modules\hfs\src\index.js" args="--cwd %HOMEPATH%\.hfs" now`
+  - service update 
+    - run `npx qckwinsvc2 uninstall name="HFS"`
+    - run `npm -g update hfs`
+    - run the service installation again
+
 ## Plug-ins
 
 To install a plugin you just copy its folder inside `plugins` folder.
@@ -133,7 +145,7 @@ an *env* called `HFS_CONFIG`. Any relative path provided is relative to the *cwd
 - `https_port` listen on a specific port. Default is 443.
 - `cert` use this file for https certificate. Minimum to start https is to give a cert and a private_key. Default is none.
 - `private_key` use this file for https private key. Default is none.
-- `allowed_referer` you can decide what domains can link to your files. Wildcards supported. Default is any.
+- `allowed_referer` you can decide what domains can link to your files. Wildcards supported. Default is empty, meaning any.
 - `block` a list of rules that will block connections. E.g.:
     ```
     block:
@@ -145,6 +157,7 @@ an *env* called `HFS_CONFIG`. Any relative path provided is relative to the *cwd
 - `custom_header` provide HTML code to be put at the top of your Frontend. Default is none.
 - `localhost_admin` should Admin be accessed without credentials when on localhost. Default is true.
 - `proxies` number of proxies between server and clients to be trusted about providing clients' IP addresses. Default is 0.
+- `keep_unfinished_uploads` should unfinished uploads be deleted immediately when interrupted. Default is true.
 
 #### Virtual File System (VFS)
 
@@ -166,6 +179,7 @@ Valid keys in a node are:
     - `"*"`: any account can, i.e. anyone who logged in.
     - `[ frank, peter ]`: the list of accounts who can.
 - `can_see`: specify who can see this entry. Even if a user can download you can still make the file not appear in the list.
+- `can_upload` specify who can upload. Applies to folders with a source. Default is none. 
   Remember that to see in the list you must also be able to download, or else you won't see it anyway. Value is a `WhoCan` descriptor, refer above.
 - `masks`: maps a file mask to a set of properties as the one documented in this section. E.g.
   ```
@@ -202,7 +216,7 @@ For each account entries, this is the list of properties you can have:
 
 - `ignore_limits` to ignore speed limits. Default is `false`.
 - `redirect` provide a URL if you want the user to be redirected upon login. Default is none.
-- `admin` set `true` if you want to let this account log in to the Admin interface. Default is `false`.
+- `admin` set `true` if you want to let this account log in to the Admin-panel. Default is `false`.
 - `belongs` an array of usernames of other accounts from which to inherit their permissions. Default is none.
 
 ## License