Weekly downloads
Changelog
0.41.0
new "list" permission some fixes
Full Changelog: https://github.com/rejetto/hfs/compare/v0.40.1...v0.41.0
Readme
HFS is the best way via web to access or share files from your disk.
This is a full rewrite of the Delphi version.
Assets
hfs
filelocalhost
address, so you can configure the rest in the Admin-panel.
create-admin <PASSWORD>
If you access Admin-panel via localhost, by default HFS won't require you to login.
If you don't like this behavior, disable it in the Admin-panel or enter this console command config localhost_admin false
.
If your system is not Windows/Linux/Mac, you can try this alternative version:
sudo npm -g i hfs
hfs
Configuration and other files will be stored in %HOME%/.vfs
With this installation method, you can update with sudo npm -g update hfs
.
If you want to run HFS as a service
npm
on Windows
npx qckwinsvc2 install name="HFS" description="HFS" path="%APPDATA%\npm\node_modules\hfs\src\index.js" args="--cwd %HOMEPATH%\.hfs" now
npx qckwinsvc2 uninstall name="HFS"
npm -g update hfs
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.
If your language is missing, please consider translating yourself.
Translation is applied automatically based on the configuration of the visitor's browser. Check the language configuration of your browser.
To install a plugin you just copy its folder inside plugins
folder.
Delete it to uninstall.
HFS will ignore all folders with -disabled
at the end of the name.
As you can see from the list of features, we already have some goods that you cannot find in HFS 2. Other than that, you can also consider:
But you may still want to stay with HFS 2.x (so far) for the following reasons
If you have access to HFS' console, you can enter commands. Start with help
to have a full list.
Configuration can be done in several ways
config NAME VALUE
--NAME VALUE
config.yaml
file. As soon as you save it is reloaded and changes are appliedNAME
stands for the property name that you want to change. See the complete list below.
Configuration is stored in the file config.yaml
, which is stored in the same folder of hfs.exe
if you are using this
kind of distribution on Windows, or USER_FOLDER/.hfs
on other systems.
You can decide a different file and location by passing --config SOME_FILE
at command line, or inside
an env called HFS_CONFIG
. Any relative path provided is relative to the cwd.
Check details about config file format.
HFS can work behind a reverse proxy. Configuration depends on what software you use, but this is an example using nginx
exposing HFS under the path /files/
instead of just /
. Adjust it to suit your needs.
location /files/ {
proxy_http_version 1.1;
keepalive_timeout 30;
proxy_buffering off;
proxy_redirect off;
proxy_max_temp_file_size 0;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; # forward IP address
proxy_set_header X-forwarded-prefix "/files"; # the location without final slash
client_max_body_size 0; # disable max size for uploads
proxy_pass http://127.0.0.1:80/;
}
This is enough, but you may want to configure generated links accordingly:
There are several ways to contribute
It's very important to report bugs, and if you are not so sure about it, don't worry, we'll discuss it. If you find important security problems, please contact us privately so that we can publish a fix before the problem is disclosed, for the safety of other users.
While the project should not become too complex, yours may be an idea for a plugin.
Submit your code
If you'd like to make a change yourself in the code, please first open an "issue" or "discussion" about it, so we'll try to cooperate and understand what's the best path for it.
A plugin can change the look (a theme), and/or introduce a new functionality.
FAQs
HTTP File Server
The npm package hfs receives a total of 536 weekly downloads. As such, hfs popularity was classified as not popular.
We found that hfs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.