Skip to content
This repository was archived by the owner on Oct 30, 2018. It is now read-only.

Commit 75657f3

Browse files
authored
Merge pull request #177 from felixbrucker/docs/add-hostname-port
[Docs] Add 'connecting to a remote Daemon' to README
2 parents ea25e4b + ec58a48 commit 75657f3

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,34 @@ storjshare killall
223223
storjshare daemon --foreground
224224
```
225225

226+
## Connecting to a remote Daemon
227+
228+
**Note: Exposing your storjshare-daemon to the Internet is a bad idea
229+
as everybody could read your Private Key!**
230+
231+
To connect to a remote running daemon instance you will first need to
232+
ensure this daemon is running on a different address than the default
233+
`127.0.0.1`. This can be achieved by [configuring the Daemon](#configuring-the-daemon).
234+
235+
After your storjshare-daemon is reachable (eg. within your home network)
236+
you can use `-r` or `--remote` option (on supported commands) to use the
237+
specified IP/hostname and port to connect to, instead of `127.0.0.1`.
238+
239+
**Note that this option does not support to start the storjshare-daemon
240+
on a different system, only connect to an already running one!**
241+
242+
Example to connect to remote daemon running on `192.168.0.10` on the default port (`45015`) and show the status:
243+
244+
```
245+
storjshare status --remote 192.168.0.10
246+
```
247+
248+
If the port is changed, just append it like so:
249+
250+
```
251+
storjshare status --remote 192.168.0.10:51000
252+
```
253+
226254
## Migrating from [`storjshare-gui`](https://github.com/storj/storjshare-gui) or [`storjshare-cli`](https://github.com/storj/storjshare-cli)
227255
#### storjshare-gui
228256
If you are using the `storjshare-gui` package you can go on with the latest

bin/storjshare-daemon.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ storjshare_daemon
1515
.option('--status', 'print the status of the daemon and exit')
1616
.option('-F, --foreground', 'keeps the process in the foreground')
1717
.option('-r, --remote <hostname:port>',
18-
'hostname and optional port of the daemon')
18+
'hostname and optional port of the daemon ' +
19+
'to connect to when using --status')
1920
.parse(process.argv);
2021

2122
const api = new RPC({

0 commit comments

Comments
 (0)