HelloZeroNet / HelloZeroNet/ZeroNet

Please add explaination to README how to run ZeroNet with tor

Open
#1,081 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
18.8k
Forks
2.3k
PR merge metrics
No merged PRs in 30d

Description

You should add a section: "Tor connectivity", and explain there that by default ZeroNet connects through the clearnet, and requires either UPnP feature on the router, or manually opened port #. In case of ```--tor=always```, on the other hand, open port isn't needed, but torrc should have ..... and explain what is actually required from Tor.

This pertains to basic connectivity, and should be in README, IMO.

Contributor guide

No contributing guide indexed for this repository

Research direction

Read the README and locate the appropriate place for a new “Tor connectivity” section. Document the default clearnet behavior, UPnP or manually opened ports, the --tor=always case, and the required torrc configuration; done means these connectivity requirements are explained clearly in the README.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, networking
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.