hfs 0.40.1 → 0.41.0

package/README.md

@@ -61,9 +61,9 @@ If you don't like this behavior, disable it in the Admin-panel or enter this con
 
 If your system is not Windows/Linux/Mac, you can try this alternative version:
 
-0. [install node.js](https://nodejs.org)
-1. execute: `sudo npm -g i hfs`
-2. launch: `hfs`
+1. [install node.js](https://nodejs.org)
+2. execute: `sudo npm -g i hfs`
+3. launch: `hfs`
 
 Configuration and other files will be stored in `%HOME%/.vfs`
 
@@ -85,9 +85,10 @@ If you want to run HFS as a service
 It is possible to show the Front-end in other languages.
 In the Languages section of the Admin-panel you'll be able to install lang files.
 You can find some of these files at https://github.com/rejetto/hfs/tree/main/langs
+Files are named `hfs-lang-CODE.json`, where `CODE` is the ISO code for your language (e.g. pt-br for Brazilian).
 To download a file: open it, right-click on the "Raw" button, Save.
 
-Files must be named `hfs-lang-CODE.json` (lowercase), where `CODE` is the ISO code for your language (e.g. pt-br for Brazilian).
+If your language is missing, please consider [translating yourself](#translate-to-your-language). 
 
 Translation is applied automatically based on the configuration of the visitor's browser.
 [Check the language configuration of your browser](https://gtranslate.io/detect-browser-language).
@@ -138,98 +139,7 @@ kind of distribution on Windows, or `USER_FOLDER/.hfs` on other systems.
 You can decide a different file and location by passing `--config SOME_FILE` at command line, or inside
 an *env* called `HFS_CONFIG`. Any relative path provided is relative to the *cwd*.  
 
-### Configuration properties
-- `port` where to accept http connections. Default is 80.
-- `vfs` the files and folders you want to expose. For details see the dedicated following section.
-- `log` path of the log file. Default is `access.log`.
-- `log_rotation` frequency of log rotation. Accepted values are `daily`, `weekly`, `monthly`, or empty string to disable. Default is `weekly`.
-- `error_log` path of the log file for errors. Default is `error.log`.
-- `errors_in_main_log` if you want to use a single file for both kind of entries. Default is false.
-- `accounts` list of accounts. For details see the dedicated following section.
-- `mime` command what mime-type to be returned with some files.
-  E.g.: `"*.jpg": image/jpeg`
-  You can specify multiple entries, or separate multiple file masks with a p|pe.
-  You can use the special value `auto` to attempt automatic detection.
-- `max_kbps` throttle output speed. Default is Infinity.
-- `max_kbps_per_ip` throttle output speed on a per-ip basis. Default is Infinity.
-- `zip_calculate_size_for_seconds` how long should we wait before the zip archive starts streaming, trying to understand its finale size. Default is 1.
-- `open_browser_at_start` should HFS open browser on localhost on start? Default is true.
-- `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 empty, meaning any.
-- `block` a list of rules that will block connections. E.g.:
-    ```
-    block:
-      - ip: 192.168.0.90
-    ```
-  Syntax supports, other than simple address, `*` as wildcard and CIDR format.
-- `plugins_config` this is a generic place where you can find/put configuration for each plugin, at least those that need configuration.
-- `enable_plugins` if a plugin is not present here, it won't run. Defaults is `[ antibrute ]`.
-- `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.
-- `favicon` path to file to be used as favicon. Default is none.
-
-#### Virtual File System (VFS)
-
-The virtual file system is a tree of files and folders, collectively called *nodes*.
-By default, a node is a folder, unless you provide for it a source that's a file.
-Valid keys in a node are:
-- `name`: this is the name we'll use to display this file/folder. If not provided, HFS will infer it from the source. At least `name` or `source` must be provided.
-- `source`: absolute or relative path of where to get the content
-- `children`: just for folders, specify its virtual children.
-  Value is a list and its entries are nodes.
-- `rename`: similar to name, but it's  from the parent node point.
-  Use this to change the name of  entries that are read from the source, not listed in the VFS.
-  Value is a dictionary, where the key is the original name.
-- `mime`: specify what mime to use for this resource. Use "auto" for automatic detection.
-- `default`: to be used with a folder where you want to serve a default html. E.g.: "index.html". Using this will make `mime` default to "auto".
-- `can_read`: specify who can download this entry. Value is a `WhoCan` descriptor, which is one of these values
-    - `true`: anyone can, even people who didn't log in. This is normally the default value.
-    - `false`: no one can.
-    - `"*"`: any account can, i.e. anyone who logged in.
-    - `[ frank, peter ]`: the list of accounts who can.
-- `can_see`: specify who can see this element. Even if a user can download you can still make the file not appear in the list.
-  Value is a `WhoCan` descriptor, refer above.
-- `can_upload` specify who can upload. Applies to folders with a source. Default is none. 
-- `can_delete` specify who can delete. Applies to folders with a source. Default is none.
-- `masks`: maps a file mask to a set of properties as the one documented in this section. E.g.
-  ```
-  "**/*.mp3":
-    can_read: false
-  "*.jpg|*.png": 
-    mime: auto
-  ```
-
-Permissions set on an inner element will override inherited permissions. This means that you can restrict access to folder1,
-and yet decide to give free access to folder1/subfolder2.   
-
-#### Accounts
-
-All accounts go under `accounts:` property, as a dictionary where the key is the username.
-E.g.
-```
-accounts:
-    admin:
-        password: hello123
-        belongs: group1
-    guest:
-        password: guest
-    group1:
-```
-
-As soon as the config is read HFS will encrypt passwords (if necessary) in a non-reversible way. It means that `password` property is replaced with an encrypted property: `srp`.
-
-As you can see in the example, `group1` has no password. This implies that you cannot log in as `group1`, but still `group1` exists and its purpose is to
-gather multiple accounts and refer to them collectively as `group1`, so you can quickly share powers among several accounts.
-
-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-panel. Default is `false`.
-- `belongs` an array of usernames of other accounts from which to inherit their permissions. Default is none.
+[Check details about config file format](https://github.com/rejetto/hfs/blob/main/config.md). 
 
 ## Reverse proxy
 
@@ -254,7 +164,36 @@ This is enough, but you may want to configure generated links accordingly:
 - go to Admin-panel > Shared files > Home > Link
 - click the change button (right side of the field)
 - enter the final URL of your proxy including the location
-    
-## License
 
-[GPLv3](https://github.com/rejetto/hfs/blob/master/LICENSE.txt)
+## Contribute
+
+There are several ways to contribute
+
+- [Report bugs](https://github.com/rejetto/hfs/issues/new?labels=bug&template=bug_report.md)
+
+  It's very important to report bugs, and if you are not so sure about it, don't worry, we'll discuss it.
+  If you find important security problems, please [contact us privately](mailto:a@rejetto.com) so that we can publish a fix before
+  the problem is disclosed, for the safety of other users.  
+
+- [Translate to your language](https://github.com/rejetto/hfs/wiki/Translation).
+
+- [Suggest ideas](https://github.com/rejetto/hfs/discussions)
+
+  While the project should not become too complex, yours may be an idea for a plugin.
+
+- Submit your code
+
+  If you'd like to make a change yourself in the code, please first open an "issue" or "discussion" about it,
+  so we'll try to cooperate and understand what's the best path for it.
+
+- [Make a plugin](https://github.com/rejetto/hfs/blob/main/dev-plugins.md)
+
+  A plugin can change the look (a theme), and/or introduce a new functionality.
+
+## More
+
+- [Build yourself](https://github.com/rejetto/hfs/blob/main/dev.md)
+
+- [License](https://github.com/rejetto/hfs/blob/master/LICENSE.txt)
+
+- [To-do list](https://github.com/rejetto/hfs/blob/main/todo.md)