mirror of
https://github.com/fluencelabs/rust-libp2p
synced 2025-05-15 12:21:20 +00:00
ce8f38cc16
As mentioned in #4444, we need to include https://github.com/mxinden/libp2p-lookup/ in the image so that we can enable a healthcheck when it starts up. Pull-Request: #4466.
42 lines
1.4 KiB
Markdown
42 lines
1.4 KiB
Markdown
# Rust libp2p Server
|
|
|
|
A rust-libp2p based server implementation running:
|
|
|
|
- the [Kademlia protocol](https://github.com/libp2p/specs/tree/master/kad-dht)
|
|
|
|
- the [Circuit Relay v2 protocol](https://github.com/libp2p/specs/blob/master/relay/circuit-v2.md)
|
|
|
|
- the [AutoNAT protocol](https://github.com/libp2p/specs/blob/master/autonat/README.md)
|
|
|
|
## Usage
|
|
|
|
```
|
|
cargo run -- --help
|
|
|
|
A rust-libp2p server binary.
|
|
|
|
Usage: libp2p-server [OPTIONS] --config <CONFIG>
|
|
|
|
Options:
|
|
--config <CONFIG> Path to IPFS config file
|
|
--metrics-path <METRICS_PATH> Metric endpoint path [default: /metrics]
|
|
--enable-kademlia Whether to run the libp2p Kademlia protocol and join the IPFS DHT
|
|
--enable-autonat Whether to run the libp2p Autonat protocol
|
|
-h, --help Print help
|
|
```
|
|
|
|
|
|
```
|
|
cargo run -- --config ~/.ipfs/config
|
|
|
|
Local peer id: PeerId("12D3KooWSa1YEeQVSwvoqAMhwjKQ6kqZQckhWPb3RWEGV3sZGU6Z")
|
|
Listening on "/ip4/127.0.0.1/udp/4001/quic"
|
|
[...]
|
|
```
|
|
|
|
The Docker container includes [libp2-lookup](https://github.com/mxinden/libp2p-lookup/) to enable adding a proper healthcheck for container startup, e.g.
|
|
|
|
``` shell
|
|
docker run --health-cmd 'libp2p-lookup direct --address /ip4/127.0.0.1/tcp/4001/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa' /home/ipfs/.ipfs:/ipfs ghcr.io/libp2p/rust-libp2p-server --config /ipfs/config
|
|
```
|