@samitouri / QOSami-HFS / commits / 41edce32

doc: better english

Massimo Melina committed Mar 9, 2025 at 12:30 UTC 41edce3288564efee9f35c91ec98382b61076d65
2 files changed +15 -13
README.md
+4 -4
@@ -51,11 +51,9 @@ This is a full rewrite of [the Delphi version](https://github.com/rejetto/hfs2).
51
52 ## Installation
53
54 -For service installation instructions, [see our wiki](https://github.com/rejetto/hfs/wiki/Service-installation).
54 +If you need [Docker installation](https://github.com/damienzonly/hfs-docker) or [Service installation](https://github.com/rejetto/hfs/wiki/Service-installation), click the links.
55
56 -For Docker installation, [see dedicated repo](https://github.com/damienzonly/hfs-docker).
57 -
58 -NB: minimum Windows version required is 8.1 , Windows Server 2012 R2 (because of Node.js 18)
56 +NB: minimum Windows version required is 8.1 , Windows Server 2012 R2
57
58 1. go to https://github.com/rejetto/hfs/releases
59 2. click on `Assets`
@@ -64,6 +62,8 @@ NB: minimum Windows version required is 8.1 , Windows Server 2012 R2 (because of
62 you can hold `control` key while clicking, then click `open`.
63 - If you cannot find your system in the list, see next section [Other systems](#other-systems).
64 4. the browser should automatically open on `localhost` address, so you can configure the rest in the Admin-panel.
65 +
66 +Got problems?
67 - if a browser cannot be opened on the computer where you are installing HFS,
68 you should enter this command in the HFS console: `create-admin <PASSWORD>`
69 - if you cannot access the console (like when you are running as a service),
config.md
+11 -9
@@ -63,7 +63,7 @@ Configuration can be done in several ways
63 - `https_port` listen on a specific port. Default is 443.
64 - `cert` use this file for https certificate. Minimum to start https is to give a cert and a private_key. Default is none.
65 - `private_key` use this file for https private key. Default is none.
66 -- `allowed_referer` you can decide what domains can link to your files. Wildcards supported. Default is empty, meaning any.
66 +- `allowed_referer` you can decide what domains can link to your files. Wildcards supported. Default is any.
67 - `block` a list of rules that will block connections. E.g.:
68 ```
69 block:
@@ -114,13 +114,13 @@ Configuration can be done in several ways
114 - `max_downloads_per_account` limit the number of concurrent downloads for each account. This is enforced only for connections that are logged in, and will override other similar settings. Default is unlimited.
115 - `geo_enable` when enabled, country is determined for each request/connection. Necessary database will be downloaded every month (2MB).
116 - `geo_allow` set true if `geo_list` should be treated as white-list, set false for black-list. Default will ignore the list.
117 -- `geo_list` list of country codes to be used as white-list or black-list. Default is empty.
117 +- `geo_list` list of country codes to be used as white-list or black-list. Default is none.
118 - `geo_allow_unknown` set false to disconnect connections for which country cannot be determined. Works only if `geo_allow` is set. Default is true.
119 - `dynamic_dns_url` URL to be requested to keep a domain updated with your latest IP address.
120 Optionally, you can append “>” followed by a regular expression to determine a successful answer, otherwise status code will be used.
121 - Multiple URLs are supported and you can specify one for each line.
122 -- `outbound_proxy` if you need outgoing http(s) requests to pass through an http proxy. Default is none.
123 -- `auto_basic` automatically detect (based on user-agent) when the basic web inteface should be served, to support legacy browsers. Default is true. No UI.
121 + Multiple URLs are supported, and you can specify one for each line.
122 +- `outbound_proxy` if you need outgoing http(s) requests to pass through an HTTP proxy. Default is none.
123 +- `auto_basic` automatically detect (based on user-agent) when the basic web interface should be served, to support legacy browsers. Default is true. No UI.
124 - `allow_session_ip_change` should requests of the same login session be allowed from different IP addresses. Default is false, to prevent cookie stealing. You can set it `true` to always allow it, or `https` to allow only on https, where stealing the cookie is harder. No UI.
125 - `authorization_header` support Authentication HTTP header. Default is true. No UI.
126 - `cache_control_disk_files` number of seconds after which the browser should bypass the cache and check the server for an updated version of the file. Default is 5. No UI.
@@ -145,8 +145,10 @@ Valid keys in a node are:
145 A positive number for the top, negative for the bottom. If you set "1" for an entry and "2" for another, the "2" will be the topmost.
146 - `target`: optional, for links only, used to [open the link in a new browser](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target). E.g. `_blank`
147 - `accept`: valid only on upload folders, used to restrict the type of files you can upload. E.g. `.zip,.rar`
148 -- `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".
149 - The value must be an absolute or relative path in the VFS, not a path on disk. It works also with other type of files.
148 +- `default`: use this with a folder where you want to serve a file, instead of the standard page with the list of files.
149 + The value must be the name of the file to serve. E.g.: `index.html`.
150 + The value must be an absolute or relative path in the VFS, not a path on disk. It works also with other type of files.
151 + Using this will make `mime` default to "auto".
152 - `can_read`: specify who can download this entry. Value is a `WhoCan` descriptor, which is one of these values
153 - `true`: anyone can, even people who didn't log in. This is normally the default value.
154 - `false`: no one can.
@@ -211,8 +213,8 @@ For each account entries, this is the list of properties you can have:
213 - `redirect` provide a URL if you want the user to be redirected upon login. Default is none.
214 - `admin` set `true` if you want to let this account log in to the Admin-panel. Default is `false`.
215 - `belongs` an array of usernames of other accounts from which to inherit their permissions. Default is none.
214 -- `srp` encrypted password
215 -- `password` a temporary unencrypted password, transformed into `srp` ASAP
216 +- `password` a temporary unencrypted password, transformed into `srp` ASAP (and removed).
217 +- `srp` encrypted password. Don't modify this, HFS will create it from `password` field.
218 - `disabled` prevents using this account. Default is false.
219 - `expire` account won't work once the time has passed this timestamp. Use JSON timestamp syntax. Default is none.
220 - `days_to_live` used to set `expire` on first login. Default is none.