permissionlesstech/georelays
1
0
Fork 0
mirror of https://github.com/permissionlesstech/georelays.git synced 2026-07-24 21:45:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update documentation to reference new python relays_geo_lookup script

Browse Source
This commit is contained in:
a1denvalu3
2026-01-14 16:21:53 +01:00
parent 1e076a17bd
commit 67e67fca1d
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
PROJECT_STRUCTURE.md
+1 -1
View File
@@ -5,7 +5,7 @@ This project is organized as follows:
## Core Files ## Core Files
- `nostr_relay_discovery.py` - Python script for discovering functioning Nostr relays - `nostr_relay_discovery.py` - Python script for discovering functioning Nostr relays
- `filter_bitchat_relays.sh` - Shell script to filter relays for BitChat capability - `filter_bitchat_relays.sh` - Shell script to filter relays for BitChat capability
- `relays_geo_lookup.sh` - Shell script to geolocate relay servers - `relays_geo_lookup.py` - Python script to geolocate relay servers
- `nostr_relays.csv` - The main output file with relay URLs and geolocation data - `nostr_relays.csv` - The main output file with relay URLs and geolocation data
## Directories ## Directories
README.md
+6 -6
View File
@@ -28,12 +28,12 @@ The repository contains three scripts that form a simple pipeline:
- Uses the `nak` CLI to query (`nak req -k 20000`) and post (`nak event -k 20000 ...`). - Uses the `nak` CLI to query (`nak req -k 20000`) and post (`nak event -k 20000 ...`).
- Output: writes to stdout the subset of input relay URLs that pass both checks. You can redirect this to a file, e.g., `bitchat_relays.txt`. - Output: writes to stdout the subset of input relay URLs that pass both checks. You can redirect this to a file, e.g., `bitchat_relays.txt`.
3) Geolocate relays (Bash) 3) Geolocate relays (Python)
- Script: `relays_geo_lookup.sh <output.csv>` - Script: `relays_geo_lookup.py <output.csv>`
- What it does: - What it does:
- Downloads the DB‑IP city IPv4 ranges (`dbip-city-ipv4-num.csv.gz`), loads it into memory, and uses a binary search to map IPv4s to latitude/longitude. - Downloads the DB‑IP city IPv4 ranges (`dbip-city-ipv4-num.csv.gz`), loads it into memory, and uses a binary search to map IPv4s to latitude/longitude.
- Reads hostnames from stdin, resolves them via `dig` to A records, and looks up the first IPv4 with available coordinates. - Reads URLs from stdin or file, resolves them asynchronously to A records, and looks up the first IPv4 with available coordinates.
- Input: hostnames only (e.g., `relay.example.com`), not full ws/wss URLs. - Input: ws/wss URLs or hostnames (e.g., `wss://relay.example.com`).
- Output: writes a CSV with header `Relay URL,Latitude,Longitude` to the file you specify. - Output: writes a CSV with header `Relay URL,Latitude,Longitude` to the file you specify.
Note: The geolocation step is IPv4‑only (the DB‑IP file used here is IPv4). IPv6‑only relays will be skipped. Note: The geolocation step is IPv4‑only (the DB‑IP file used here is IPv4). IPv6‑only relays will be skipped.
@@ -44,7 +44,7 @@ Note: The geolocation step is IPv4‑only (the DB‑IP file used here is IPv4).
- The discovery step uses timeouts and concurrent batches; tune `--batch-size`, `--timeout`, and `--max-depth` for your environment. - The discovery step uses timeouts and concurrent batches; tune `--batch-size`, `--timeout`, and `--max-depth` for your environment.
- The BitChat filter posts a test kind 20000 event. Ensure `nak` is configured to publish (e.g., via its config or environment variables as per `nak` docs). - The BitChat filter posts a test kind 20000 event. Ensure `nak` is configured to publish (e.g., via its config or environment variables as per `nak` docs).
- Geolocation is an estimate based on DB‑IP and only for IPv4. Accuracy varies and may reflect the ISP/hosting POP rather than precise server location. - Geolocation is an estimate based on DB‑IP and only for IPv4. Accuracy varies and may reflect the ISP/hosting POP rather than precise server location.
- `relays_geo_lookup.sh` stops at the first IPv4 for which DB‑IP provides coordinates. Some hostnames resolve to multiple IPs. - `relays_geo_lookup.py` stops at the first IPv4 for which DB‑IP provides coordinates. Some hostnames resolve to multiple IPs.
--- ---
@@ -56,7 +56,7 @@ This repository includes a GitHub Actions workflow under `.github/workflows/` th
- Runs `nostr_relay_discovery.py` to produce `relay_discovery_results.json` - Runs `nostr_relay_discovery.py` to produce `relay_discovery_results.json`
- Extracts the functioning relays with `jq` - Extracts the functioning relays with `jq`
- Runs `filter_bitchat_relays.sh` - Runs `filter_bitchat_relays.sh`
- Runs `relays_geo_lookup.sh` to generate `nostr_relays.csv` - Runs `relays_geo_lookup.py` to generate `nostr_relays.csv`
- Commits the updated artifacts back to the repository - Commits the updated artifacts back to the repository
To change the schedule, seed relay, or enable BitChat filtering in CI, edit the workflow file in `.github/workflows/`. To change the schedule, seed relay, or enable BitChat filtering in CI, edit the workflow file in `.github/workflows/`.