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
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,9 +51,6 @@ Or:
51
51
vid.mkv
52
52
```
53
53
54
-
### Hyperdrive API
55
-
The daemon also provides a gRPC API for interacting with remote Hyperdrives. [`hyperdrive-daemon-client`](https://github.com/andrewosh/hyperdrive-daemon-client) is a Node client that you can use to interact with the API. If you'd like to write a client in another language, check out the schema definitions in [`hyperdrive-schemas`](https://github.com/andrewosh/hypedrive-schemas)
56
-
57
54
## Installation
58
55
```
59
56
npm i hyperdrive-daemon -g
@@ -73,9 +70,8 @@ You should only need to perform this step once (it will persist across restarts)
73
70
74
71
### Starting the Daemon
75
72
76
-
After installing/configuring, you'll need to start the daemon before running any other commands. To do this, first pick a storage directory for your mounted Hyperdrives.
73
+
After installing/configuring, you'll need to start the daemon before running any other commands. To do this, first pick a storage directory for your mounted Hyperdrives. By default, the daemon will use `~/.hyperdrive/storage`.
77
74
78
-
From within this storage directory, run:
79
75
```
80
76
❯ hyperdrive start
81
77
Daemon started at http://localhost:3101
@@ -87,6 +83,9 @@ If you want to stop the daemon, you can run:
87
83
The Hyperdrive daemon has been stopped.
88
84
```
89
85
86
+
## API
87
+
The daemon exposes a gRPC API for interacting with remote Hyperdrives. [`hyperdrive-daemon-client`](https://github.com/andrewosh/hyperdrive-daemon-client) is a Node client that you can use to interact with the API. If you'd like to write a client in another language, check out the schema definitions in [`hyperdrive-schemas`](https://github.com/andrewosh/hyperdrive-schemas)
88
+
90
89
## CLI
91
90
92
91
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:
@@ -101,7 +100,7 @@ Start the Hyperdrive daemon.
101
100
Options include:
102
101
```
103
102
--bootstrap ['host:port', 'host:port', ...] // Optional, alternative bootstrap servers
104
-
--storage /my/storage/dir // A storage directory for cores and the db. Defaults to ./storage
103
+
--storage /my/storage/dir // The storage directory. Defaults to ~/.hyperdrive/storage
0 commit comments