# p2p-port-mapping

**Repository Path**: MemoryFast/p2p-port-mapping

## Basic Information

- **Project Name**: p2p-port-mapping
- **Description**: p2p port forwarding/mapping across NAT/firewalls, Access your server anywhere. p2p内网穿透, 端口转发/端口映射. 跨NAT和防火墙，从任何地方访问你的服务器.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-06-26
- **Last Updated**: 2021-06-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# p2p-port-mappig
p2p port forwarding/mapping across NAT/firewalls, Access your server anywhere.
<br />
<a href="https://github.com/yuanzhanghu/p2p-port-mapping/blob/master/README_Chinese.md"><strong>中文说明</strong></a>
## Features
```
- p2p port forwarding/mapping, no data relay server is needed.
- NAT traversal without router configuration.
- service installed, will be started automatically after reboot.
- support multiple clients and multiple connections for each tunnel.
- windows/linux server port forwarding/mapping tested.
- using webrtc to establish data tunnel, scp rate can reach upto 350Mbps for the tunnel.
```
## Installation
```
1. install node
2. git clone https://github.com/yuanzhanghu/p2p-port-mapping.git
3. cd p2p-port-mapping
4. npm install
```
## Example 1 (verified on linux and windows)
```
Assume that we want to do ssh from computer B to computer A across firewalls, we can do port mapping like:
1. on computer A, mapping port out to serverKey:
(linux and windows) node p2p-mapping.js --add --mapping-out --port 22
added mapping: port 22 ====> serverKey:qMdtjthkW   // printed result, here serverKey is generated
(linux) sudo `which node` p2p-mapping.js --start-service
(windows) node p2p-mapping.js --start-service

2. on computer B, mapping serverKey in to port:
// here serverKey is used on computer B
(linux and windows) node p2p-mapping.js --add --mapping-in -n sshTunnel --server-key qMdtjthkW --port 2222
(linux) sudo `which node` p2p-mapping.js --start-service
(windows) node p2p-mapping.js --start-service

3. now we can do this on B:
'ssh user@localhost -p 2222"
above command will ssh to A actually.
```
## Example 2 (accessing windows remote desktop across firewalls)
```
Assume that we want to do remote desktop control from B to A(windows)
1. on computer A(windows), mapping port to a serverKey:
node p2p-mapping.js --add --mapping-out --port 3389
  added mapping: port 3389 ====> serverKey:iweos23kW //write down this serverKey, will be used on B
node p2p-mapping.js --start-service

2. on computer B, mapping a serverKey to port:
(linux and windows) node p2p-mapping.js --add --mapping-in -n winRDP --server-key iweos23kW --port 4001
(linux) sudo `which node` p2p-mapping.js --start-service
(windows) node p2p-mapping.js --start-service

3. now we can access A's desktop from B by accessing localhost:4001
```
## More commands
```
1. to stop the service: 
(linux) sudo `which node` p2p-mapping.js --stop-service
(windows) node p2p-mapping.js --stop-service

2. to delete mapping out port: 
(linux and windows) node p2p-mapping.js --delete --mapping-out --port 22

3. to delete mapping in port: 
(linux and windows) node p2p-mapping.js --delete --mapping-in --port 2222

4. to list the status of service: 
node p2p-mapping.js --list

5. more helps
node p2p-mapping.js --help

```
## Contact
QQ交流群: 872893118
<br />
email: huyuanzhang@gmail.com