docs: add Reticulum connectivity step to quickstart

Add step 1 covering Reticulum setup: LAN works automatically, for
other transports generate the example config with rnsd --exampleconfig
and configure the appropriate interface. Fixes missing instructions
that caused bridges not to discover each other on fresh installs.
Standardise on uv throughout.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Maciek "mab122" Bator 2026-04-24 11:36:18 +02:00
parent d670b096f2
commit fd6c1b4f05
1 changed files with 20 additions and 15 deletions

View File

@ -8,11 +8,8 @@ Bridges [Radicle](https://radicle.xyz) (decentralized Git) over [Reticulum](http
## Prerequisites ## Prerequisites
Install anything you don't already have:
- **Radicle**`rad` CLI + `radicle-node`: [radicle.xyz/install](https://radicle.xyz/install) - **Radicle**`rad` CLI + `radicle-node`: [radicle.xyz/install](https://radicle.xyz/install)
- **Reticulum**`rns` Python package: `pip install rns` or [reticulum.network](https://reticulum.network/manual/gettingstartedfast.html) - **uv**: [docs.astral.sh/uv](https://docs.astral.sh/uv/getting-started/installation/) (manages Python and dependencies)
- **Python 3.10+**
--- ---
@ -21,26 +18,34 @@ Install anything you don't already have:
```sh ```sh
git clone rad:z4NMdcKbw2TETQ56fbQfbibFHtZqZ git clone rad:z4NMdcKbw2TETQ56fbQfbibFHtZqZ
cd radicle-reticulum cd radicle-reticulum
pip install .
```
With [uv](https://docs.astral.sh/uv/getting-started/installation/) instead of pip:
```sh
uv sync uv sync
``` ```
Optional — faster push detection on Linux/macOS (inotify): Optional — faster push detection on Linux/macOS (inotify):
```sh ```sh
pip install ".[watch]" # or: uv sync --extra watch uv sync --extra watch
``` ```
--- ---
## Quick start ## Quick start
### 1. Tell radicle-node to listen on localhost Do this on **every machine**.
### 1. Reticulum connectivity
On the same LAN, Reticulum discovers peers automatically via multicast — no configuration needed.
For other transports (internet, LoRa, packet radio, I2P) configure the appropriate Reticulum interface in `~/.reticulum/config` first. If this is your first time using Reticulum, generate the annotated example config:
```sh
rnsd --exampleconfig > ~/.reticulum/config
```
Then edit it to enable the interface for your transport. See [Reticulum interfaces](#reticulum-interfaces) below and the [Reticulum manual](https://reticulum.network/manual/) for details. Once Reticulum can reach between your machines the bridge works the same regardless of transport.
### 2. Configure radicle-node to listen on localhost
Edit `~/.radicle/config.json`: Edit `~/.radicle/config.json`:
@ -57,7 +62,7 @@ rad node start
rad node status # should show "listening … 127.0.0.1:8776" rad node status # should show "listening … 127.0.0.1:8776"
``` ```
### 2. Start the bridge on both machines ### 3. Start the bridge on both machines
```sh ```sh
uv run radicle-rns bridge uv run radicle-rns bridge
@ -76,7 +81,7 @@ Tunnel 1 opened
[Status] Tunnels: 1, Remote bridges: 1, TX: 1551, RX: 1831 [Status] Tunnels: 1, Remote bridges: 1, TX: 1551, RX: 1831
``` ```
### 3. Use radicle normally ### 4. Use radicle normally
```sh ```sh
# Machine A # Machine A
@ -93,7 +98,7 @@ That's it. `rad push`, `rad fetch`, and `rad sync` all work as usual — they ta
## Reticulum interfaces ## Reticulum interfaces
On a LAN, Reticulum auto-discovers peers via UDP multicast — no config needed. For LoRa, serial, or I2P, edit `~/.reticulum/config`: For LoRa, serial, or I2P, edit `~/.reticulum/config`:
```ini ```ini
[[lora_interface]] [[lora_interface]]