You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+70-2Lines changed: 70 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,18 @@
1
1
# ⏏️ hypermount
2
2
A FUSE-mountable distributed filesystem, built with Hyperdrive.
3
3
4
-
Hypermount lets your mount Hyperdrives as directories on both OSX and Linux. To create a new mounted Hyperdrive, just run `hypermount mount <an empty dir>` -- hypermount will generate and seed a new Hyperdrive for you, mounted at the specified directory, and it will give you a key you can share with others. To mount someone else's Hyperdrive, just run `hypermount mount <an empty dir> <key>`!
4
+
Hypermount lets your mount Hyperdrives as directories on both OSX and Linux. To generate and seed a new Hyperdrive, mounted at a just run:
5
+
```
6
+
❯ hypermount mount me
7
+
Mounted 8a18b05e95e2e20eca9e66cdeff5b926c7c553edc34c7ffc06054edbb1810f7e at /home/andrewosh/friends/me
8
+
```
9
+
This command will give you a Hyperdrive key you can share with others. A friend can subsequently mount this drive:
10
+
```
11
+
❯ hypermount mount andrew 8a18b05e95e2e20eca9e66cdeff5b926c7c553edc34c7ffc06054edbb1810f7e
12
+
Mounted 8a18b05e95e2e20eca9e66cdeff5b926c7c553edc34c7ffc06054edbb1810f7e at /home/andrewosh/friends/andrew
13
+
```
14
+
15
+
Once your drives are mounted, you can treat them as you would any other directory!
5
16
6
17
To make it easier to mount multiple drives, Hypermount runs as a daemonized HTTP server. It maintains a database of mounted Hyperdrives, which it will automatically remount when the daemon is started and unmount when it's stopped.
7
18
@@ -26,7 +37,64 @@ You should only need to perform this step once (it will persist across restarts)
26
37
27
38
## Usage
28
39
29
-
Hypermount provides an HTTP interface for mounting, unmounting, and providing status information about all current mounts. There's also a bundled CLI tool
40
+
Hypermount provides an HTTP interface for mounting, unmounting, and providing status information about all current mounts. There's also a bundled CLI tool which wraps the HTTP interfaces and provides the following commands:
41
+
42
+
#### `hypermount setup`
43
+
Performs a one-time configuration step that installs FUSE. This command will prompt you for `sudo`.
44
+
45
+
#### `hypermount mount <mountpoint> [key]`
46
+
If a key is specified, create a Hyperdrive using that key. If not, generate a new one. Once the drive has been created, mount it at `mountpoint`.
47
+
48
+
This command takes options:
49
+
```
50
+
--sparse Create a sparse content feed. [boolean] [default: true]
51
+
--sparseMetadata Create a sparse metadata feed. [boolean] [default: true]
52
+
```
53
+
54
+
#### `hypermount unmount <mountpoint>`
55
+
Unmount a Hyperdrive that's been previously mounted at `mountpoint`, if it exists.
56
+
57
+
*Note: This command will currently not delete or unseed the Hyperdrive. Support for this will be added soon.
58
+
59
+
#### `hypermount list`
60
+
Display information about all mounted Hyperdrives.
Display status information about the Hypermount daemon.
86
+
87
+
#### `hypermount start`
88
+
Launch the Hypermount daemon. When this command is executed, it will use the current working directory as its storage/logging directory. This command must be run before any additional commands (except for `setup`) will work.
89
+
90
+
Takes these options:
91
+
```
92
+
--port The HTTP port that the daemon will bind to. [number] [default: 3101]
93
+
--replicationPort The port that the hypercore replicator will bind to. [number] [default: 3102]
94
+
```
95
+
96
+
#### `hypermount stop`
97
+
Unmount all mounted Hyperdrives and stop the daemon.
0 commit comments