fix: useless files in exe distribution, and renamed accounts to accounts-example
Massimo Melina committed
Jan 22, 2022 at 12:03 UTC
5e90656d9d9bcf008d62b713f45704a72f494416
2 files changed
+6
-7
README.md
+4
-5
@@ -31,14 +31,13 @@ You won't find all previous features here (yet), but still we got:
31
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`.
34
+3. among the zip files, we suggest the one with "exe" in the name. Download ti and unzip somewhere on your computer
35
+4. first time you should rename `config-example` to `config`, and `accounts-example` to `accounts`. Preserve the `yaml` extension.
36
+
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
-
41
-We suggest the other distribution, without the "exe" in the name.
40
+5. launch the `hfs.exe` file
41
42
# Configuration
43
package.json
+2
-2
@@ -13,11 +13,11 @@
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 accounts.yaml READ* plugins tests dist && cp config.yaml dist/config-example.yaml && cd dist && npm ci --production && cd .. && node afterbuild",
16
+ "build": "npm install && tsc --target es2018 && cp -v -r package*.json READ* plugins tests dist && cp config.yaml dist/config-example.yaml && cp accounts.yaml dist/accounts-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
- "exe-dist": "pkg . -C brotli && cd dist && zip hfs.exe.zip -r * -x src src/** *.zip run.bat"
20
+ "exe-dist": "pkg . -C brotli && cd dist && rm -rf src node_modules && zip hfs.exe.zip -r * -x *.zip run.bat"
21
},
22
"bin": "dist/src/index.js",
23
"pkg": {