pb-mapper-server 0.8.0

Relay server implementation for pb-mapper
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# pb-mapper server

`pb-mapper-server` is the relay-server library used by pb-mapper. It accepts
authenticated service registrations and client subscriptions, then routes TCP
or UDP traffic between them. With its UDP service enabled
(`run_server_on_listener_with_direct`, `p2p` feature), it also coordinates
direct peer-to-peer sessions between endpoints and stays their relay
fallback. `DirectServerConfig::advertise` may leave the IP unspecified, in
which case clients pair the announced port with the relay address they dialed.

Applications embedding the relay can depend on the library directly:

```toml
[dependencies]
pb-mapper-server = "0.8"
```

To install and run the ready-made server program, install the unified CLI:

```bash
cargo install pb-mapper-cli --locked
pb-mapper server --port 7666   # 7666/tcp relay, 7666/udp direct coordination
```

See the [user guide](https://github.com/acking-you/pb-mapper/blob/master/docs/user-guide.md)
for authentication and deployment instructions.