@samitouri / QOSami-HFS-2 / commits / 99071365

doc: better english

Massimo Melina committed Sep 16, 2025 at 00:40 UTC 990713652928cdfff32ebd315e85113cfab466ad
1 file changed +25 -27
README.md
+25 -27
@@ -6,13 +6,13 @@
6
7 Access via web your files directly from your disk.
8
9 -- You be the server, share files **fresh from your disk**, with **unlimited** space and bandwidth.
9 +- Be your own server, share files **fresh from your disk**, with **unlimited** space and bandwidth.
10 - **Fast!** Try zipping 100GB, download starts immediately!
11 -- **Intelligent**. HFS tries to detect problems and suggest solutions.
11 +- **Smart**. HFS tries to detect problems and suggest solutions.
12 - Share **even a single file** with our *virtual file system*, even with a different name, all without touching the real file. Present things the way you want!
13 -- **Watch** all activities in real-time.
14 -- **Control bandwidth**, decide how much to give.
15 -- **No intermediaries**, give a huge file to your friend without waiting for it to be uploaded on a server first.
13 +- **Monitor** all activities in real-time.
14 +- **Bandwidth throttling**, decide how much to give.
15 +- **Direct transfers**, share large files with friends without having to upload them first.
16
17 This is a full rewrite of [the Delphi version](https://github.com/rejetto/hfs2).
18
@@ -60,10 +60,10 @@ Minimum Windows version required is 10 or Server 2019. If you have a previous ve
60 3. **download** the right version for your system, unzip and launch `hfs` file.
61 - Mac: if you get *"cannot be opened because it is from an unidentified developer"*,
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).
63 + - If your system isn't listed, please see the [Other systems](#other-systems) section.
64 4. the browser should automatically open on `localhost` address, so you can configure the rest in the Admin-panel.
65
66 -Got problems?
66 +Troubleshooting
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),
@@ -72,7 +72,7 @@ Got problems?
72
73 `echo "create-admin: PASSWORD" > config.yaml`
74
75 -If you access *Admin-panel* via localhost, by default HFS **won't** require you to login.
75 +By default, HFS does not require a login when you access the *Admin-panel* from localhost.
76 If you don't like this behavior, disable it in the Admin-panel or enter this console command `config localhost_admin false`.
77
78 ### Other systems
@@ -88,10 +88,6 @@ If this procedure fails, it may be that you are missing one of [these requiremen
88
89 Configuration and other files will be stored in `%HOME%/.vfs`
90
91 -## Console commands
92 -
93 -If you have full access to HFS' console, you can enter commands. Start with `help` to have a full list.
94 -
91 ## Configuration
92
93 For configuration please see [file config.md](config.md).
@@ -119,21 +115,23 @@ If your language is missing, please consider [translating yourself](https://gith
115
116 ## Hidden features
117
122 -- Appending `#LOGIN` to address will bring up the login dialog
123 -- Appending ?lang=CODE to address will force a specific language
124 -- Right-click on toggle-all checkbox will invert each checkbox state
125 -- Appending `?login=USER:PASSWORD` will automatically log in the browser
126 -- Appending `?overwrite` on uploads, will override the dont_overwrite_uploading configuration, provided you also have *delete* permission
127 -- Appending `?search=PATTERN` will trigger search at start
128 -- Appending `?onlyFiles` or `?onlyFolders` will limit type of results
129 -- Appending `?get=basic` will show an elementary web interface, meant for old/basic browsers. This is automatic if a basic browser is detected.
130 -- Appending `?autoplay=shuffle` will trigger show & play; `?autoplay` will not shuffle, but also will not start until the list is complete
131 -- Right-click on "check for updates" will let you input a URL of a version to install
132 -- Shift+click on a file will show & play
133 -- Type the name of a file/folder to focus it, and ctrl+backspace to go to parent folder
134 -- `--consoleFile PATH` will output all stdout and stderr also to a file
135 -- env `DISABLE_UPDATE=1` (for containers)
136 -- launch with `--debug` or env `HFS_DEBUG=1` to produce additional logs in console
118 +- Append `#LOGIN` to the URL to open the login dialog
119 +- Append `?lang=CODE` to the URL to force a specific language
120 +- `Right-click` on toggle-all checkbox to *invert* the state of all checkboxes
121 +- Append `?login=USER:PASSWORD` to automatically log in to the browser
122 +- Append `?overwrite` when uploading to override the `dont_overwrite_uploading` configuration, provided you also have *delete* permission
123 +- Append `?search=PATTERN` to trigger a search on startup
124 +- Append `?onlyFiles` or `?onlyFolders` to limit the type of results
125 +- Append `?get=basic` to display a basic web interface, intended for older/simpler browsers
126 + - This is automatic if a basic browser is detected.
127 +- Append `?autoplay=shuffle` to trigger show & play; `?autoplay` will not shuffle, but also will not start until the list is complete
128 +- `Right-click` on "check for updates" to enter a URL of a version to install
129 +- `Shift+click` on a file to *show* and play
130 +- `Ctrl+backspace` to navigate to the parent folder
131 +- Start typing a filename to focus it in the list
132 +- `--consoleFile PATH` to also output all stdout/stderr to a file
133 +- Set env.var. `DISABLE_UPDATE=1` (for containers)
134 +- Launch with `--debug` or env.var. `HFS_DEBUG=1` to generate additional console logs
135
136 ## Contribute
137