holesail-file-system
Advanced tools
A P2P based node package to expose your files access on the Holepunch protocol
Join our Discord Support Server
Holesail-file-system is a simple and flexible solution for creating a distributed hash table (DHT) server. It allows you to expose your local files system to the network, making it accessible to other nodes.
Before using holesail-file-system, make sure you have Node.js installed on your system. You can download Node.js from the official website: https://nodejs.org/en/download/
Once Node.js is installed, you can install Holesail-file-system Server using npm (Node Package Manager):
npm i holesail-file-system -g
To start a local Holesail-file-system Server, use the following command:
holesail-file-system --live port
Replace port with the desired port number you want to expose to the network on which your file system will work.
This will give you a seed to connect to, use that to acess this server from anywhere:
holesail-file-system --connect SEED --port
Available options:
--live PORT: Create a tunnel on this port
--connect SEED: Connect to a tunnel using the seed generated from --live command
--host ADDRESS: Default address is 127.0.0.1, use it to change address to localhost or other
--port PORT: Use this option with --connect to set a custom port instead of the default port 8989
To start a local holesail-file-system Server on port 8080, use the following command:
holesail-file-system --live 8080
If you need help or want to see the usage instructions, use the following command:
holesail-file-system --help
Holesail-file-system Server includes graceful goodbye functionality, which ensures that the server is properly shut down when you close the terminal or interrupt the process.
Holesail-file-system Server is released under the GPL-3.0 License. See the LICENSE file for more information.
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
Holesail-file-system is built using the following open-source projects:
and other node packges.
FAQs
A P2P based node package to expose your files access on the Holepunch protocol
We found that holesail-file-system 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 for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.