doc: better english
Massimo Melina committed
Jan 5, 2026 at 00:10 UTC
beb9be8afc831d4b4495f91da8eda397bcc8bb75
3 files changed
+31
-27
README.md
+20
-16
@@ -2,6 +2,20 @@
2
3
4
5
+## Index
6
+
7
+- [Introduction](#introduction)
8
+- [How does it work](#how-does-it-work)
9
+- [Features](#features)
10
+- [Installation](#installation)
11
+ - [Other systems](#other-systems)
12
+- [Configuration](#configuration)
13
+ - [Where is it stored](#where-is-it-stored)
14
+- [Internationalization](#internationalization)
15
+- [Hidden features](#hidden-features)
16
+- [Contribute](#contribute)
17
+- [More](#more)
18
+
19
## Introduction
20
21
Access your files via web, directly from your disk.
@@ -19,8 +33,8 @@ Runs on: Windows, Linux, macOS, FreeBSD, Android
33
34
## How does it work
35
22
-- run HFS on your computer, administration page automatically shows up
23
-- select what files and folders you want to be accessible
36
+- run HFS on your computer; an administration webpage automatically shows up
37
+- select which files and folders you want to be accessible
38
- access those files from a phone or another computer just using a browser
39
- possibly create accounts and limit access to files
40
@@ -57,6 +71,7 @@ If you need [Docker installation](https://github.com/damienzonly/hfs-docker) or
71
Minimum Windows version required is 10 or Server 2019.
72
73
1. Download the zip file for your operating system from https://github.com/rejetto/hfs/releases
74
+ - ⚠️ Antivirus problems on Windows? [READ THIS](https://github.com/rejetto/hfs/wiki/Antivirus)
75
- ⚠️ If you have Linux ARM or other unlisted/unsupported platforms, please see the [Other systems](#other-systems) section.
76
2. Unzip and launch `hfs` file.
77
- ⚠️ Mac: if you get *"cannot be opened because it is from an unidentified developer"*,
@@ -90,18 +105,7 @@ Configuration and other files will be stored in `%HOME%/.vfs`
105
106
## Configuration
107
93
-For configuration please see [file config.md](config.md).
94
-
95
-### Where is it stored
96
-
97
-Configuration is stored in the file `config.yaml`, exception made for custom HTML which is stored in `custom.html`.
98
-
99
-These files are kept in the Current Working Directory (cwd), which is by default the same folder of `hfs.exe`
100
-if you are using this kind of distribution on Windows, or `USER_FOLDER/.hfs` on other systems.
101
-You can decide a different folder passing `--cwd SOME_FOLDER` parameter at command line.
102
-Any relative path provided is relative to the *cwd*.
103
-
104
-[Check details about config file format](config.md).
108
+For configuration please see [config.md](config.md); it explains also where all configurations are stored.
109
110
## Internationalization
111
@@ -170,6 +174,6 @@ There are several ways to contribute
174
175
- [Build yourself](dev.md)
176
173
-- [License](https://github.com/rejetto/hfs/blob/master/LICENSE.txt)
177
+- [License](LICENSE.txt)
178
175
-- Flag images are public-domain, downloaded from https://flagpedia.net
\ No newline at end of file
179
+- Flag images are public-domain, downloaded from https://flagpedia.net
config.md
+6
-6
@@ -11,17 +11,17 @@ Anyway, the current working directory (CWD) is printed by HFS in the first lines
11
Many things are stored in the CWD, like the plugins you install.
12
You can decide a different CWD passing `--cwd SOME_FOLDER` parameter at command line.
13
14
-If you are not sure what your `cwd` is, look in the console, and you'll see that it is printed in one of the first lines.
14
+If you are not sure what your `cwd` is, look in the console, and you'll see that in first lines of your console.
15
Here is an example, look at the 6th line:
16
```
17
HFS ~ HTTP File Server
18
© Massimo Melina <a@rejetto.com> - License https://www.gnu.org/licenses/gpl-3.0.txt
19
-started 2025-01-03 10:10:00
20
-version 0.55.2
21
-build 2025-01-03T14:14:31.396Z
19
+started 2026-01-03 10:10:00
20
+version 3.0.0
21
+build 2025-12-20T13:20:50.027Z
22
working directory (cwd) /Users/rejetto/.hfs
23
-node v18.20.4
24
-platform darwin arm64 node
23
+node v20.19.6
24
+platform darwin arm64 binary
25
```
26
27
### How to modify configuration
dev-plugins.md
+5
-5
@@ -38,16 +38,16 @@ Frontend files reside in the "public" folder, while all the rest is backend.
38
39
## System icons
40
41
-HFS defines "system icons" that will be used in the frontend, like the icon for the login.
42
-A plugin can customize such icons by creating a folder called "icons" and putting an image file with
43
-its name (excluding extension) matching one of the list:
41
+HFS defines "system icons" that are used in the frontend, like the icon for the login.
42
+They can be customized by creating a folder called "icons" and putting an image file for each icon to be customized;
43
+the filename (excluding extension) will match one of the list:
44
*login, user, filter, search, search_off, close, error, stop, options, archive, logout, home, parent, folder, file,
45
spinner, password, download, upload, reload, lock, admin, check, to_start, to_end, menu, list, play, pause, edit, zoom,
46
delete, comment, link, info, cut, paste, copy, shuffle, repeat, success, warning, audio, video, image, cancel, total*.
47
48
-The list above may become outdated, but you can always find an updated version at https://github.com/rejetto/hfs/blob/main/frontend/src/sysIcons.ts.
48
+For example, put a file "login.png" into "icons" to customize that icon. Stadard web file formats are supported.
49
50
-For example, put a file "login.png" into "icons" to customize that icon.
50
+If the list above becomes outdated, you can always find an updated version at https://github.com/rejetto/hfs/blob/main/frontend/src/sysIcons.ts.
51
52
## Definitions
53