Skip to content

Commit 0ce4765

Browse files
committed
Merge branch 'master' of github.com:andrewosh/hypermount
2 parents eb04539 + f735a12 commit 0ce4765

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,6 @@ Or:
5151
vid.mkv
5252
```
5353

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-
5754
## Installation
5855
```
5956
npm i hyperdrive-daemon -g
@@ -73,9 +70,8 @@ You should only need to perform this step once (it will persist across restarts)
7370

7471
### Starting the Daemon
7572

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`.
7774

78-
From within this storage directory, run:
7975
```
8076
❯ hyperdrive start
8177
Daemon started at http://localhost:3101
@@ -87,6 +83,9 @@ If you want to stop the daemon, you can run:
8783
The Hyperdrive daemon has been stopped.
8884
```
8985

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+
9089
## CLI
9190

9291
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.
101100
Options include:
102101
```
103102
--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
105104
--log-level info // Logging level
106105
--port 3101 // The port gRPC will bind to.
107106
```

0 commit comments

Comments
 (0)