installation instructions
Massimo Melina committed
Jan 21, 2022 at 15:36 UTC
b5f6ffb1e068f8bc989eb80704ed62e2d64b1923
2 files changed
+19
-7
README.md
+17
-5
@@ -11,7 +11,7 @@ This project is in an early stage and distribution will be made easier.
11
This is a full rewrite of [the Delphi version](https://github.com/rejetto/hfs2).
12
You won't find all previous features here (yet), but still we got:
13
14
-# Features
14
+## Features
15
- https
16
- unicode
17
- virtual file system
@@ -25,12 +25,24 @@ You won't find all previous features here (yet), but still we got:
25
- log file
26
- speed throttler
27
28
-# Configuration
28
+# Installation
29
+
30
+## Windows
31
30
-At the moment there's no administration UI. You must edit configuration files.
32
+1. go on https://github.com/rejetto/hfs/releases
33
+2. pick your version
34
+3. among the zip files, we suggest the one with "exe" in the name
35
+4. download and unzip somewhere on your computer
36
+5. first time you should rename `config-example` to `config`.
37
+ Future upgrades you may probably want to keep your existing config, and possibly use the example as an inspiration.
38
+ You should edit config to suite your needs. Surely you want at least to change what files and folders are accessible
39
+ by the browser, and you'll find that under the `vfs` entry. For further details please check the `Configuration` section below.
40
32
-## Config
41
+We suggest the other distribution, without the "exe" in the name.
42
+
43
+# Configuration
44
45
+At the moment there's no administration UI. You must edit the configuration file, that basically a structured text file.
46
General configuration is read by default from file `config.yaml`.
47
When not specified, default values will be used.
48
Supported entries are:
@@ -51,7 +63,7 @@ Supported entries are:
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.
54
-- `plugins_config`
66
+- `plugins_config` this is a generic place where you can find/put configuration for each plugin, at least those that need configuration.
67
68
## Virtual File System (VFS)
69
package.json
+2
-2
@@ -13,8 +13,8 @@
13
"watch-server": "nodemon --ignore tests/ --watch src -e ts,tsx --exec ts-node src/index.ts",
14
"start-frontend": "cd frontend && npm run start",
15
"start": "node dist",
16
- "build": "npm install && tsc --target es2018 && cp -v -r package*.json config.yaml accounts.yaml READ* plugins tests dist && cd dist && npm ci --production && cd .. && node afterbuild",
17
- "build-all": "rm -rf dist && npm run build && cd frontend && npm install && npm run build && echo COMPLETED",
16
+ "build": "npm install && tsc --target es2018 && cp -v -r package*.json accounts.yaml READ* plugins tests dist && cp config.yaml dist/config-example.yaml && cd dist && npm ci --production && cd .. && node afterbuild",
17
+ "build-all": "rm -rf dist && npm run build && cd frontend && npm install && npm run build && npm audit --production && echo COMPLETED",
18
"test": "mocha -r ts-node/register 'tests/**/*.ts'",
19
"zip-dist": "cd dist && zip hfs.zip -r * -x *.zip *.exe",
20
"make-exe-after-build": "pkg . -C brotli && cd dist && zip hfs.exe.zip -r * -x src src/** *.zip run.bat"