opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-06-24 14:08:13 +08:00
Code Issues Projects Releases Wiki Activity

p2p: update docs after refactor

Browse Source 
License: MIT
Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
This commit is contained in:
Łukasz Magiera
2018-05-26 16:15:39 +02:00
parent 0198693e69
commit e4db7f7a48
1 changed files with 22 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/experimental-features.md
View File

@ -275,7 +275,7 @@ The `p2p` command needs to be enabled in config:
First, pick a protocol name for your application. Think of the protocol name as First, pick a protocol name for your application. Think of the protocol name as
a port number, just significantly more user-friendly. In this example, we're a port number, just significantly more user-friendly. In this example, we're
going to use `/p2p/kickass/1.0`. going to use `/kickass/1.0`.
**Setup:** **Setup:**
@ -289,7 +289,7 @@ First, start your application and have it listen on `$APP_PORT`.
Then, configure the p2p listener by running: Then, configure the p2p listener by running:
```sh ```sh
> ipfs p2p listener open /p2p/kickass/1.0 /ip4/127.0.0.1/tcp/$APP_PORT > ipfs p2p forward /kickass/1.0 /ipfs /ip4/127.0.0.1/tcp/$APP_PORT
``` ```
This will configure IPFS to forward all incoming `/p2p/kickass/1.0` streams to This will configure IPFS to forward all incoming `/p2p/kickass/1.0` streams to
@ -303,10 +303,28 @@ First, configure the p2p dialer to forward all inbound connections on
node. node.
```sh ```sh
> ipfs p2p stream dial $SERVER_ID /p2p/kickass/1.0 /ip4/127.0.0.1/tcp/$SOME_PORT > ipfs p2p forward /kickass/1.0 /ip4/127.0.0.1/tcp/$SOME_PORT /ipfs/$SERVER_ID
``` ```
Next, have your application open a connection to `127.0.0.1:$SOME_PORT`. This connection will be forwarded to the service running on `127.0.0.1:$APP_PORT` on the remote machine. Next, have your application open a connection to `127.0.0.1:$SOME_PORT`. This
connection will be forwarded to the service running on `127.0.0.1:$APP_PORT` on
the remote machine. You can test it with netcat:
**On "server" node:**
```sh
> nc -v -l -p $APP_PORT
```
**On "client" node:**
```sh
> nc -v 127.0.0.1 $SOME_PORT
```
You should now see that a connection has been established and be able to
exchange messages between netcat instances.
(note that depending on your netcat version you may need to drop the `-v` flag)
### Road to being a real feature ### Road to being a real feature
- [ ] Needs more people to use and report on how well it works / fits use cases - [ ] Needs more people to use and report on how well it works / fits use cases