doc: installation instructions for service
Massimo Melina committed
Sep 14, 2023 at 17:07 UTC
319aaa037a4fccd103d4264ec72a8c88d3db1e9d
2 files changed
+38
-31
README.md
+35
-31
@@ -51,11 +51,15 @@ NB: minimum Windows version required is 8.1 , Windows Server 2012 R2 (because of
51
52
1. go to https://github.com/rejetto/hfs/releases
53
2. click on `Assets`
54
-3. **download** the right version for your computer
55
-4. launch `hfs` file
56
-5. the browser should automatically open on `localhost` address, so you can configure the rest in the Admin-panel.
54
+3. **download** the right version for your system, unzip and launch `hfs` file.
55
+ - If you cannot find your system in the list, see next section [Other systems](#other-systems).
56
+4. the browser should automatically open on `localhost` address, so you can configure the rest in the Admin-panel.
57
- if a browser cannot be opened on the computer where you are installing HFS,
58
you should enter this command in HFS console: `create-admin <PASSWORD>`
59
+ - if you are running as a service and cannot access the console, your best option is to stop it, launch it
60
+ at command line (not as a service), and follow previous instruction.
61
+ - if you can never access the console, even with the previous instructions,
62
+ you can [edit config file add add your admin account](config.md#accounts)
63
64
If you access *Admin-panel* via localhost, by default HFS **won't** require you to login.
65
If you don't like this behavior, disable it in the Admin-panel or enter this console command `config localhost_admin false`.
@@ -108,6 +112,34 @@ To update
112
- run `npm -g update hfs`
113
- run `npx qckwinsvc2 install name="HFS" description="HFS" path="%APPDATA%\npm\node_modules\hfs\src\index.js" args="--cwd %HOMEPATH%\.hfs" now`
114
115
+## Console commands
116
+
117
+If you have access to HFS' console, you can enter commands. Start with `help` to have a full list.
118
+
119
+## Configuration
120
+
121
+Configuration can be done in several ways
122
+- accessing the Admin-panel with your browser
123
+ - it will automatically open when you start HFS. Bookmark it. if your port is 8000 the address will be http://localhost:8000/~/admin
124
+- after HFS has started you can enter console command in the form `config NAME VALUE`
125
+- passing via command line at start in the form `--NAME VALUE`
126
+- directly editing the `config.yaml` file. As soon as you save it is reloaded and changes are applied
127
+
128
+`NAME` stands for the property name that you want to change. See the [complete list](config.md).
129
+
130
+### Where is it stored
131
+
132
+Configuration is stored in the file `config.yaml`, exception made for custom HTML which is stored in `custom.html`.
133
+
134
+These files are kept in the Current Working Directory (cwd), which is by default the same folder of `hfs.exe`
135
+if you are using this kind of distribution on Windows, or `USER_FOLDER/.hfs` on other systems.
136
+You can decide a different cwd passing `--cwd SOME_FOLDER` parameter at command line.
137
+
138
+You can decide also a different file for config by passing `--config SOME_FILE`, or inside an *env* called `HFS_CONFIG`.
139
+Any relative path provided is relative to the *cwd*.
140
+
141
+[Check details about config file format](config.md).
142
+
143
## Internationalization
144
145
It is possible to show the Front-end in other languages.
@@ -134,34 +166,6 @@ But you may still want to stay with HFS 2.x (so far) for the following reasons
166
- more tested
167
- classic window interface (can be easier for some people)
168
137
-## Console commands
138
-
139
-If you have access to HFS' console, you can enter commands. Start with `help` to have a full list.
140
-
141
-## Configuration
142
-
143
-Configuration can be done in several ways
144
-- accessing the Admin-panel with your browser
145
- - it will automatically open when you start HFS. Bookmark it. if your port is 8000 the address will be http://localhost:8000/~/admin
146
-- after HFS has started you can enter console command in the form `config NAME VALUE`
147
-- passing via command line at start in the form `--NAME VALUE`
148
-- directly editing the `config.yaml` file. As soon as you save it is reloaded and changes are applied
149
-
150
-`NAME` stands for the property name that you want to change. See the [complete list](config.md).
151
-
152
-### Where is it stored
153
-
154
-Configuration is stored in the file `config.yaml`, exception made for custom HTML which is stored in `custom.html`.
155
-
156
-These files are kept in the Current Working Directory (cwd), which is by default the same folder of `hfs.exe`
157
-if you are using this kind of distribution on Windows, or `USER_FOLDER/.hfs` on other systems.
158
-You can decide a different cwd passing `--cwd SOME_FOLDER` parameter at command line.
159
-
160
-You can decide also a different file for config by passing `--config SOME_FILE`, or inside an *env* called `HFS_CONFIG`.
161
-Any relative path provided is relative to the *cwd*.
162
-
163
-[Check details about config file format](config.md).
164
-
169
## Security
170
171
While this project focuses on ease of use, we care about security.
config.md
+3
@@ -96,6 +96,9 @@ E.g.
96
accounts:
97
admin:
98
password: hello123
99
+ admin: true
100
+ frank:
101
+ password: another
102
belongs: group1
103
guest:
104
password: guest