mirror of
https://github.com/spacedriveapp/spacedrive
synced 2024-07-13 13:04:04 +00:00
b015763a6f
* Remove relay * restructure p2p * wip * cleanup webrtc * split up P2P docs * wip * more wip * the fork has moved * finish local network discovery * Document the relay system * be less stupid * a * remote ip from deploy script * remove debug from deploy script * Explain relay setup and usage * Physical pain * fix * error handling for relay setup * Listeners Relay state + merge it into NLM state * `node_remote_identity` * redo libraries hook * toggle relay active in settings * Dedicated network settings page * Stablise P2P debug page * warning for rspc remote * Linear links in docs * fix p2p settings switches * fix typescript errors on general page * fix ipv6 listener status * discovery method in UI * Remove p2p debug menu on the sidebar * wip * lol * wat * fix * another attempt at fixing library hook * fix * Remove sync from sidebar * fix load library code * I hate this * Detect connections over the relay * fix * fixes * a * fix mDNS * a bunch o fixes * a bunch of state management fixes * Metadata sync on connection * skill issue * fix markdown * Clippy cleanup * Backport #2380 * Update interface/locales/en/common.json Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/local-network-discovery.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/local-network-discovery.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/relay.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/relay.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/relay.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/relay.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/relay.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/sd_p2p.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/sd_p2p.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/sd_p2p_proto.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/overview.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/overview.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/relay.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/sd_p2p_proto.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/sd_p2p_proto.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/transport-layer.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/sd_p2p_proto.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/local-network-discovery.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * Update docs/developers/p2p/sd_p2p_proto.mdx Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com> * a * Cleaning binario section * cleanup Docker message * idk * Idempotent listeners * Manual peers working???? * minor fixes * crazy idea - don't panic in the event loop * fixes * debug * debug * LAN badge in network settings * Use `dns_lookup` instead of `tokio::net::lookup_host` * fix * bruh sandwich * proper dialing * a * remove logs * fix * Small cleanup * manual peers state on connected device * a * Fix manual discovery state + give it a badge * Clippy improvements * flip discovery priority * Add `addrs` to debug query * connection candidates in debug * Fix state * Clippppppppppppy * Manual discovery badge * Flesh out ping example * Usage guide * `sd_p2p_proto` examples * More discovery docs * More docs work * docs docs docs and more docs * PONG * rename --------- Co-authored-by: Matthew Yung <117509016+myung03@users.noreply.github.com>
37 lines
2.6 KiB
Plaintext
37 lines
2.6 KiB
Plaintext
---
|
|
title: Discovery
|
|
index: 25
|
|
---
|
|
|
|
# Discovery
|
|
|
|
Discovery is the process of finding other nodes to connect with.
|
|
|
|
We do this through the following 3 systems:
|
|
- Manual entry by the user
|
|
- [Local Network Discovery](/docs/developers/p2p/local-network-discovery) via mDNS
|
|
- [Relay](/docs/developers/p2p/relay) via mDNS
|
|
|
|
## Overview of methods
|
|
|
|
From a technical perspective all of these methods operate very differently so it's important to understand the differences between them when making changes to the P2P system.
|
|
|
|
The relay and manual entry method both require the P2P system to be given an upfront list of peers to connect to, whereas the mDNS system is able to discover them itself. For the relay these peers comes from the instances table in the database and for manual entry these peers comes from the node configuration file.
|
|
|
|
A quirk manual entry is that when we attempt a connection we don't know the remote nodes identity or metadata prior to connecting. We instead establish a full connection to ask for remote nodes information (`RemoteIdentity` and metadata) after which we treat it as discovered.
|
|
|
|
This table summarises the differences between the methods:
|
|
|
|
| | mDNS | Relay | Manual |
|
|
|-------------------------------------------------------------------------|---------|----------|-----------|
|
|
| Requires upfront knowledge of existence of peer | No | Yes | Yes |
|
|
| Knows connection info (metadata, RemoteIdentity) ahead of connection | Yes | Yes | No |
|
|
|
|
## Manually provided peers
|
|
|
|
The user can manually provide a set of [`SocketAddr`](https://doc.rust-lang.org/std/net/enum.SocketAddr.html)'s or [FQDN](https://en.wikipedia.org/wiki/Fully_qualified_domain_name)'s and the P2P system will attempt to connect to them. If a domain is provided the P2P system will resolve it to an IP address and then attempt to connect to that address.
|
|
|
|
This feature primarily exists for usage with Docker as mDNS discovery does not work correctly, however it could be useful for working around difficult network setups. It's important to note that you *must* use [port forwarding](https://en.wikipedia.org/wiki/Port_forwarding) and set a static port for the node when using this feature.
|
|
|
|
When you add a manual peer it will *not* show up in the nodes list until the P2P system is able to establish a connection. This is because without having established a connection the system is unable to determine the remote nodes identity or metadata which is required for it to be considered discovered.
|