hfs rejetto

If you need Docker installation or Service installation, click the links.

Minimum Windows version required is 10 or Server 2019. If you have a previous version, you can still follow instructions for Other systems

1. go to https://github.com/rejetto/hfs/releases
2. click on Assets
3. download the right version for your system, unzip and launch hfs file.
   • Mac: if you get "cannot be opened because it is from an unidentified developer", you can hold control key while clicking, then click open.
   • If you cannot find your system in the list, see next section Other systems.
4. the browser should automatically open on localhost address, so you can configure the rest in the Admin-panel.

Got problems?

• if a browser cannot be opened on the computer where you are installing HFS, you should enter this command in the HFS console: create-admin

• if you cannot access the console (like when you are running as a service), you can edit the config file to add your admin account

• if you don't want to use an editor you can create the file with this command:

  echo "create-admin: PASSWORD" > config.yaml

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.

Other systems

If can't or don't want to run our binary versions, you can try this:

1. install node.js version 20 (or greater, but then compatibility is not guaranteed)
2. execute at command line npx hfs@latest

The @latest part is optional, and ensures that you are always up to date.

If this procedure fails, it may be that you are missing one of these requirements.

Configuration and other files will be stored in %HOME%/.vfs

Console commands

If you have full access to HFS' console, you can enter commands. Start with help to have a full list.

Configuration

For configuration please see file config.md.

Where is it stored

Configuration is stored in the file config.yaml, exception made for custom HTML which is stored in custom.html.

These files are kept in the Current Working Directory (cwd), which is by default 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 folder passing --cwd SOME_FOLDER parameter at command line. Any relative path provided is relative to the cwd.

Check details about config file format.

Internationalization

It is possible to show the Front-end in other languages. Translation for some languages is already provided. If you find an error, consider reporting it or editing the source file.

In the Languages section of the Admin-panel you can install additional language files.

If your language is missing, please consider translating yourself.

Hidden features

• Appending #LOGIN to address will bring up the login dialog
• Appending ?lang=CODE to address will force a specific language
• Right-click on toggle-all checkbox will invert each checkbox state
• Appending ?login=USER:PASSWORD will automatically log in the browser
• Appending ?overwrite on uploads, will override the dont_overwrite_uploading configuration, provided you also have delete permission
• Appending ?search=PATTERN will trigger search at start
• Appending ?onlyFiles or ?onlyFolders will limit type of results
• Appending ?autoplay=shuffle will trigger show & play; ?autoplay will not shuffle, but also will not start until the list is complete
• Right-click on "check for updates" will let you input a URL of a version to install
• Shift+click on a file will show & play
• Type the name of a file/folder to focus it, and ctrl+backspace to go to parent folder
• --consoleFile PATH will output all stdout and stderr also to a file
• env DISABLE_UPDATE=1 (for containers)

Contribute

There are several ways to contribute

• Report bugs

  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.

• Use beta versions, and give feedback.

  While betas have more problems, you'll get more features and give a huge help to the project.

• Translate to your language.

• Suggest ideas

  While the project should not become too complex, yours may be an idea for a plugin.

• Write guides or make videos for other users. We got a wiki!

• 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.

• Make a plugin

  A plugin can change the look (a theme), and/or introduce a new functionality.

More

• APIs

• Build yourself

• License

• Flag images are public-domain, downloaded from https://flagpedia.net