hfs 0.42.3 → 0.44.0

package/README.md

@@ -61,7 +61,7 @@ If you don't like this behavior, disable it in the Admin-panel or enter this con
 
 ### Other systems
 
-If your system is not Windows/Linux/Mac, you can try this alternative version:
+If your system is not Windows/Linux/Mac or you just don't want to run the binaries, you can try this alternative version:
 
 1. [install node.js](https://nodejs.org)
 2. execute at command line `npx hfs@latest`
@@ -72,27 +72,48 @@ Configuration and other files will be stored in `%HOME%/.vfs`
 
 ### Service
 
-If you want to run HFS as a service
-- if you installed with `npm` on Windows 
-  - service installation
-      - run `npx qckwinsvc2 install name="HFS" description="HFS" path="%APPDATA%\npm\node_modules\hfs\src\index.js" args="--cwd %HOMEPATH%\.hfs" now`
-  - service update 
-    - run `npx qckwinsvc2 uninstall name="HFS"`
-    - run `npm -g update hfs`
-    - run the service installation again
+If you want to run HFS at boot (as a service), we suggest the following methods
+
+#### On Linux 
+1. [install node.js](https://nodejs.org)
+2. create a file `/etc/systemd/system/hfs.service` with this content
+  ```
+  [Unit]
+  Description=HFS
+  After=network.target
+  
+  [Service]
+  Type=simple
+  Restart=always
+  ExecStart=/usr/bin/npx -y hfs@latest
+  
+  [Install]
+  WantedBy=multi-user.target
+  ```
+3. run `sudo systemctl daemon-reload && sudo systemctl enable hfs && sudo systemctl start hfs && sudo systemctl status hfs`
+
+NB: update will be attempted at each restart
+
+#### On Windows
+
+1. [install node.js](https://nodejs.org)
+2. run `npm -g i hfs`
+3. run `npx qckwinsvc2 install name="HFS" description="HFS" path="%APPDATA%\npm\node_modules\hfs\src\index.js" args="--cwd %HOMEPATH%\.hfs" now`
+  
+To update 
+- run `npx qckwinsvc2 uninstall name="HFS"`
+- run `npm -g update hfs`
+- run `npx qckwinsvc2 install name="HFS" description="HFS" path="%APPDATA%\npm\node_modules\hfs\src\index.js" args="--cwd %HOMEPATH%\.hfs" now`
 
 ## Internationalization
 
 It is possible to show the Front-end in other languages.
-In the Languages section of the Admin-panel you'll be able to install lang files.
-You can find some of these files at https://github.com/rejetto/hfs/tree/main/langs
-Files are named `hfs-lang-CODE.json`, where `CODE` is the ISO code for your language (e.g. pt-br for Brazilian).
-To download a file: open it, right-click on the "Raw" button, Save.
+Translation for some languages is already provided. If you find an error, consider reporting it
+or [editing the source file](https://github.com/rejetto/hfs/tree/main/src/langs). 
 
-If your language is missing, please consider [translating yourself](#translate-to-your-language). 
+In the Languages section of the Admin-panel you can install additional language files.
 
-Translation is applied automatically based on the configuration of the visitor's browser.
-[Check the language configuration of your browser](https://gtranslate.io/detect-browser-language).
+If your language is missing, please consider [translating yourself](https://github.com/rejetto/hfs/wiki/Translation). 
 
 ## Plug-ins
 
@@ -142,6 +163,21 @@ an *env* called `HFS_CONFIG`. Any relative path provided is relative to the *cwd
 
 [Check details about config file format](https://github.com/rejetto/hfs/blob/main/config.md). 
 
+## Security
+
+While this project focuses on ease of use, we care about security.
+- HTTPS support
+- Passwords are not saved, and user password is safe even logging in without https thanks to [SRP](https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol)
+- Automated tests ran on every release, including libraries audit
+- No default admin password
+
+Some actions you can take for improved security:
+- use https, better if using a proper certificate, even free with [Letsencrypt](https://letsencrypt.org/).
+- have a domain (ddns is ok too), start vhosting plugin, configure your domain, enable "Block requests that are not using any of the domains above"
+- install/start rejetto/antidos plugin. Tweak configuration if necessary.
+- start antibrute plugin (it's started by default)
+- disable "unprotected admin on localhost"
+
 ## Reverse proxy
 
 HFS can work behind a reverse proxy. Configuration depends on what software you use, but this is an example using nginx
@@ -168,7 +204,10 @@ This is enough, but you may want to configure generated links accordingly:
 
 ## Hidden features
 
-- Going to address `#LOGIN` will bring up the login dialog
+- Appending `#LOGIN` to address will bring up the login dialog
+- Appending ?lang=CODE to address will force a specific language
+- env `SESSION_DURATION` can be set to any number of seconds. Default is 1 day.
+- right/ctrl/command click on toggle-all checkbox will invert each checkbox state
 
 ## Contribute
 

package/admin/assets/index-35f6e3dc.css

@@ -0,0 +1 @@
+:root{height:100dvh}body{margin:0;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;height:100vh;background:#000}#root{min-height:100%;display:flex}code{font-family:source-code-pro,Menlo,Monaco,Consolas,Courier New,monospace}.MuiTreeItem-content{box-sizing:border-box}ol,ul{margin-top:.2em}