{"id":13488887,"url":"https://github.com/rejetto/hfs","last_synced_at":"2026-03-14T13:57:52.604Z","repository":{"id":37444986,"uuid":"439824270","full_name":"rejetto/hfs","owner":"rejetto","description":"HFS is a web file server for your computer. Share folders or even a single file thanks to the virtual file system.","archived":false,"fork":false,"pushed_at":"2026-02-22T15:58:26.000Z","size":13427,"stargazers_count":3507,"open_issues_count":19,"forks_count":334,"subscribers_count":47,"default_branch":"main","last_synced_at":"2026-02-22T20:46:09.464Z","etag":null,"topics":["file-server","file-sharing","http-server","nodejs","typescript","web"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rejetto.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"github":["rejetto"],"custom":"https://www.paypal.com/donate/?hosted_button_id=HC8MB4GRVU5T2"}},"created_at":"2021-12-19T09:34:54.000Z","updated_at":"2026-02-22T15:58:29.000Z","dependencies_parsed_at":"2023-12-30T14:23:42.640Z","dependency_job_id":"89235270-ed0a-4931-bfd2-4dd83ce3b867","html_url":"https://github.com/rejetto/hfs","commit_stats":{"total_commits":1424,"total_committers":5,"mean_commits":284.8,"dds":"0.016151685393258397","last_synced_commit":"db0958512bf314ef8ef8775bd32407e2dbfd3ddd"},"previous_names":[],"tags_count":282,"template":false,"template_full_name":null,"purl":"pkg:github/rejetto/hfs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rejetto%2Fhfs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rejetto%2Fhfs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rejetto%2Fhfs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rejetto%2Fhfs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rejetto","download_url":"https://codeload.github.com/rejetto/hfs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rejetto%2Fhfs/sbom","scorecard":{"id":510707,"data":{"date":"2025-08-11","repo":{"name":"github.com/rejetto/hfs","commit":"22b442288c579a51c722b455430f7b061651ee92"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.6,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 27 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.57.11 not signed: https://api.github.com/repos/rejetto/hfs/releases/239483211","Warn: release artifact v0.57.10-beta1 not signed: https://api.github.com/repos/rejetto/hfs/releases/238716346","Warn: release artifact v0.57.9 not signed: https://api.github.com/repos/rejetto/hfs/releases/233671825","Warn: release artifact v0.57.9-beta1 not signed: https://api.github.com/repos/rejetto/hfs/releases/232046451","Warn: release artifact v0.57.8 not signed: https://api.github.com/repos/rejetto/hfs/releases/230278700","Warn: release artifact v0.57.11 does not have provenance: https://api.github.com/repos/rejetto/hfs/releases/239483211","Warn: release artifact v0.57.10-beta1 does not have provenance: https://api.github.com/repos/rejetto/hfs/releases/238716346","Warn: release artifact v0.57.9 does not have provenance: https://api.github.com/repos/rejetto/hfs/releases/233671825","Warn: release artifact v0.57.9-beta1 does not have provenance: https://api.github.com/repos/rejetto/hfs/releases/232046451","Warn: release artifact v0.57.8 does not have provenance: https://api.github.com/repos/rejetto/hfs/releases/230278700"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T00:28:01.888Z","repository_id":37444986,"created_at":"2025-08-20T00:28:01.888Z","updated_at":"2025-08-20T00:28:01.888Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29939089,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-28T13:49:17.081Z","status":"ssl_error","status_checked_at":"2026-02-28T13:48:50.396Z","response_time":90,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["file-server","file-sharing","http-server","nodejs","typescript","web"],"created_at":"2024-07-31T18:01:23.575Z","updated_at":"2026-03-14T13:57:52.571Z","avatar_url":"https://github.com/rejetto.png","language":"TypeScript","funding_links":["https://github.com/sponsors/rejetto","https://www.paypal.com/donate/?hosted_button_id=HC8MB4GRVU5T2"],"categories":["TypeScript","web","Tool"],"sub_categories":["File Server"],"readme":"# HFS: HTTP File Server\n\n![logo and motto](hfs-logo-color-motto.svg)\n\n## Index\n\n- [Introduction](#introduction)\n- [How does it work](#how-does-it-work)\n- [Features](#features)\n- [Installation](#installation)\n  - [Other systems](#other-systems)\n- [Configuration](#configuration)\n  - [Where is it stored](#where-is-it-stored)\n- [Internationalization](#internationalization)\n- [Hidden features](#hidden-features)\n- [Contribute](#contribute)\n- [More](#more)\n\n## Introduction\n\nAccess your files via web, directly from your disk.\n\n- Be your own server: share files **fresh from your disk** with **unlimited** space and bandwidth.\n- **Fast:** try zipping 100GB – download starts immediately.\n- **Smart:** HFS detects problems and suggests solutions.\n- Present things the way you want: share **even a single file**, even with a different name, with our *virtual file system*.\n- **Monitor** all activities in real-time.\n- **Bandwidth throttling**: decide how much to give.\n- **Direct transfers**: share large files with friends without having to upload them first.\n- **Expandable**: install plugins for additional features.\n\nRuns on: Windows, Linux, macOS, FreeBSD, Android\n\n## How does it work\n\n- run HFS on your computer; an administration webpage automatically shows up\n- select which files and folders you want to be accessible\n- access those files from a phone or another computer just using a browser\n- possibly create accounts and limit access to files\n\n## Features\n\n- https\n- easy certificate generation\n- virtual file system\n- mobile friendly\n- search\n- accounts\n- resumable downloads \u0026 uploads\n- download folders as zip archive\n- delete, move and rename files\n- plug-ins (anti-brute-force, thumbnails, ldap, themes, and more)\n- simple website serving\n- real-time monitoring of connections\n- [show some files](https://github.com/rejetto/hfs/discussions/270)\n- speed throttler\n- geographic firewall\n- admin web interface\n- multi-language front-end\n- virtual hosting\n- [reverse-proxy support](https://github.com/rejetto/hfs/wiki/Reverse-proxy)\n- comments in file descript.ion\n- integrated media player\n- [customizable with html, css, and javascript](https://github.com/rejetto/hfs/wiki/Customization)\n- dynamic-dns updater\n\n## Installation\n\nFor Docker, see https://github.com/rejetto/hfs/wiki/Docker . \n\nFor service installation, see https://github.com/rejetto/hfs/wiki/Service-installation.\n\nFor Homebrew, just `brew install rejetto/hfs/hfs`\n\nThe minimum Windows version required is 10 or Server 2019.\n\n1. Download the zip file for your operating system from https://github.com/rejetto/hfs/releases\n   - ⚠️ Antivirus problems on Windows? [READ THIS](https://github.com/rejetto/hfs/wiki/Antivirus)\n   - ⚠️ If you have Linux ARM or other unlisted/unsupported platforms, please see the [Other systems](#other-systems) section.\n2. Unzip and launch the `hfs` file.\n   - ⚠️ Mac: if you get *\"cannot be opened because it is from an unidentified developer\"*,\n     you can hold `control` key while clicking, then click `open`.\n3. The browser should automatically open at `localhost`, so you can configure the rest in the Admin-panel.\n\nTroubleshooting\n   - If a browser cannot be opened on the computer where you are installing HFS, \n     you should enter this command in the HFS console: `create-admin \u003cPASSWORD\u003e`\n   - If you cannot access the console (like when you are running as a service), \n       you can [edit the config file to add your admin account](config.md#accounts)\n   - If you don't want to use an editor, you can create the file with this command: \n     \n     `echo \"create-admin: PASSWORD\" \u003e config.yaml` \n\nBy default, HFS does not require a login when you access the *Admin-panel* from localhost.\nIf you don't like this behavior, disable it in the Admin-panel or enter this console command `config localhost_admin false`.\n\nTo uninstall, remove the files you unzipped and the configuration/data directory (see `config.md` for the location).\n\n### Other systems\n\nIf you can't or don't want to run our binary versions, you can try this:\n\n1. [Install Node.js](https://nodejs.org) version 18 to 24\n2. Run at the command line `npx hfs@latest`\n\nThe `@latest` part is optional, and ensures that you are always up to date.\n\nIf this procedure fails, it may be that you are missing one of [these requirements](https://github.com/nodejs/node-gyp#installation).\n\nConfiguration and other files will be stored in `%HOME%/.vfs`\n\n## Configuration\n\nFor configuration please see [config.md](config.md); it explains also where all configurations are stored.\n\n## Internationalization\n\nIt is possible to show the Front-end in other languages.\nTranslation for some languages is already provided. If you find an error, consider reporting it\nor [editing the source file](https://github.com/rejetto/hfs/tree/main/src/langs). \n\nIn the Languages section of the Admin-panel you can install additional language files.\n\nIf your language is missing, please consider [translating yourself](https://github.com/rejetto/hfs/wiki/Translation). \n\n## Hidden features\n\n- Append `#LOGIN` to the URL to open the login dialog\n- Append `?lang=CODE` to the URL to force a specific language\n- `Right-click` on toggle-all checkbox to *invert* the state of all checkboxes\n- Append `?login=USER:PASSWORD` to automatically log in to the browser\n- Append `?overwrite` when uploading to override the `dont_overwrite_uploading` configuration, provided you also have *delete* permission\n- Append `?search=PATTERN` to trigger a search on startup\n- Append `?onlyFiles` or `?onlyFolders` to limit the type of results\n- Append `?get=basic` to display a basic web interface, intended for older/simpler browsers \n  - This is automatic if a basic browser is detected.\n- Append `?autoplay=shuffle` to trigger show \u0026 play; `?autoplay` will not shuffle, but also will not start until the list is complete \n- `Right-click` on \"check for updates\" to enter a URL of a version to install\n- `Shift+click` on a file to *show* and play\n- `Ctrl+backspace` to navigate to the parent folder\n- Start typing a filename to focus it in the list\n- `--consoleFile PATH` to also output all stdout/stderr to a file\n- Set env.var. `DISABLE_UPDATE=1` (for containers)\n- Launch with `--debug` or env.var. `HFS_DEBUG=1` to generate additional console logs \n- Launch with `--no-central` to skip fetching updated info from GitHub (uses built-in data only)\n\n## Contribute\n\nThere are several ways to contribute\n\n- [Report bugs](https://github.com/rejetto/hfs/issues/new?labels=bug\u0026template=bug_report.md)\n\n  It's very important to report bugs, and if you are not so sure about it, don't worry, we'll discuss it.\n  If you find important security problems, please [contact us privately](mailto:a@rejetto.com) so that we can publish a fix before\n  the problem is disclosed, for the safety of other users.  \n\n- Use beta versions, and give feedback. \n\n  While betas have more problems, you'll get more features and give a huge help to the project. \n\n- [Translate to your language](https://github.com/rejetto/hfs/wiki/Translation).\n\n- [Suggest ideas](https://github.com/rejetto/hfs/discussions)\n\n  While the project should not become too complex, yours may be an idea for a plugin.\n\n- Write guides or make videos for other users. [We got a wiki](https://github.com/rejetto/hfs/wiki)! \n\n- Submit your code\n\n  If you'd like to make a change yourself in the code, please first open an \"issue\" or \"discussion\" about it,\n  so we'll try to cooperate and understand what's the best path for it.\n\n- [Make a plugin](dev-plugins.md)\n\n  A plugin can change the look (a theme), and/or introduce a new functionality.\n\n## Code Signing Policy\n\nFree code signing 🙏 provided by SignPath.io, certificate by [SignPath Foundation](https://signpath.org).\n\nAuthor/Reviewer/Approver: Massimo Melina.\n\nPrivacy: Update checks are opt-out; other outbound connections are user-triggered.\n\n## More\n\n- [Additional information (Wiki)](https://github.com/rejetto/hfs/wiki)\n\n- [APIs](https://github.com/rejetto/hfs/wiki/APIs)\n\n- [Build yourself](dev.md)\n\n- [License](LICENSE.txt)\n\n- Flag images are public-domain, downloaded from https://flagpedia.net\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frejetto%2Fhfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frejetto%2Fhfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frejetto%2Fhfs/lists"}