Skip to content

docs(readme): correct DHT support claim#37

Merged
MudDev merged 1 commit into
mainfrom
docs/readme-dht-support
May 18, 2026
Merged

docs(readme): correct DHT support claim#37
MudDev merged 1 commit into
mainfrom
docs/readme-dht-support

Conversation

@MudDev
Copy link
Copy Markdown

@MudDev MudDev commented May 18, 2026

Summary

Fixes #28. The README's ### Current Limitations section claimed "No DHT support (relies on BitTorrent trackers)", but DHT is fully implemented and enabled by default.

Verification

Changes

  • Removes - No DHT support (relies on BitTorrent trackers) from ### Current Limitations
  • Adds - **DHT peer discovery**: Trackerless peer discovery over the BitTorrent mainline DHT (enabled by default) to ## Core Features

Other Current Limitations bullets — verified before leaving them alone

  • No I2P integration: confirmed — no I2P references in src/ or plugins/
  • Limited spam protection: fair — RateLimit covers publish (30s) and file requests with bad_actions escalation, plus --lax-cert-check, but it's not a robust anti-spam system
  • No built-in encryption for local storage: confirmed — CryptMessage plugin is ECIES for messaging (Epix Mail), not at-rest disk encryption; on-disk site data is plaintext

Test plan

  • Diff is +1/-1, scoped to README
  • grep -i DHT README.md confirms no stale "No DHT" claim remains

Credit to @slrslr for catching this in #28.

DHT is implemented (src/DHT/DHTServer.py) and enabled by default
(--dht default=True in Config.py). SiteAnnouncer.announceDHT() runs
alongside tracker announces, and the DHT bootstraps from hardcoded
public mainline DHT routers so it works without any tracker config.

Removes "No DHT support" from Current Limitations and adds a DHT
bullet under Core Features so the README matches reality.

Fixes #28
@MudDev MudDev merged commit 5fcebc6 into main May 18, 2026
2 of 3 checks passed
@MudDev MudDev deleted the docs/readme-dht-support branch May 18, 2026 23:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix README.md - DHT support

1 participant