holesail
DownloadGithubBlog
  • 👋Welcome to the web of Peers
  • Overview
    • ⛵What can holesail do
    • ✨Our Features
  • Installation Guide
    • 📪Install through npm (Recommended)
    • 🪟Holesail executable (Windows, Linux, Mac)
    • 🍎Holesail Go (Mac & iPhone)
    • 📱Holesail Go Android
  • USAGE GUIDE
    • 😙Overview
    • 🖥️Set a port live
    • 🤝Connect to someone
    • Run in background
    • 🗃️Filemanager
  • Terminology
    • Connection String
    • Private vs Public connection string
Powered by GitBook
On this page

Was this helpful?

  1. USAGE GUIDE

Filemanager

PreviousRun in backgroundNextConnection String

Last updated 9 months ago

Was this helpful?

Holesail file manager let's you share files and folders with anyone and across devices with a single command.

There are no restrictions on the number of files that can be shared, the bandwidth or the size of the file.

Command:

holesail --filemanager

Supported options:

Option
Purpose
Required / Optional

--filemanager

Start file manager in current directory

Required

--filemanager PATH

Start file manager in the given directory

Optional

--username

Set a custom username for authentication

Optional. Default is admin

--password

Set a custom password

Optional. Default is admin

--role

Allow a user to create folder and files by setting role to admin

Optional. Default is "user".

--connector

Set a custom connection string. Can not be less than 32 chars or equal to 64 chars

Optional. The default is auto-generated.

--force

Bypass custom connection string length limit

Optional. Default is false

Examples:

  1. Start a filemanager session in the current directory with default username and password:

holesail --filemanager
  1. Connect to a Holesail server with a custom connection string and custom port:

Start a filemanager session in the current directory with public connection string:
  1. Start a filemanager session in a custom directory with custom username:

holesail --filemanager "/Users/supersu" --username "holesail"
  1. Start a filemanager session in a custom directory with custom username and password and admin role:

holesail --filemanager "/Users/supersu" --username "holesail" --password "securepass@99#123" --role admin

You can combine multiple options according to your needs. You will get a connection string and QR code that you can use to connect with Holesail filemanager and access in browser.

🗃️