ZeroNet README

The project's README from github.com/HelloZeroNet/ZeroNet. As one markdown file: README.md.

ZeroNet Build Status Documentation Help tests Docker Pulls

Decentralized websites using Bitcoin crypto and the BitTorrent network - https://zeronet.io / onion

Why?

Features

How does it work?

Slideshow about ZeroNet cryptography, site updates, multi-user sites »

Frequently asked questions »

ZeroNet Developer Documentation »

Screenshots

Screenshot ZeroTalk

More screenshots in ZeroNet docs »

How to join

Windows

macOS

Linux (x86-64bit)

Tip: Start with ./ZeroNet.sh --ui_ip '*' --ui_restrict your.ip.address to allow remote connections on the web interface.

Android (arm, arm64, x86)

Docker

There is an official image, built from source at: https://hub.docker.com/r/nofish/zeronet/

Install from source

Current limitations

How can I create a ZeroNet site?

Next steps: ZeroNet Developer Documentation

Help keep this project alive

Sponsors

Thank you!

ZeroNet (HelloZeroNet/ZeroNet)

decentralized
Searching Database…

18.8K ·GitHub
What is this?ZeroNet is open-source software for a decentralized web: it lets you publish and visit websites that use Bitcoin cryptography and the BitTorrent network for distribution instead of a traditional hosting provider.
Is this a hosted service I sign up for, or a program I run on my own computer?A program on your machine: after starting it you browse ZeroNet sites from your regular browser, and it works with any browser/OS. Your machine then also serves the sites you visit to other peers.
How do I get it running?Pick a ready build and run it: ZeroNet.exe on Windows (an 18MB zip), ZeroNet.app on macOS, ./ZeroNet.sh on Linux, or an Android APK (Android 16 and up). There is also an official Docker image; from source you need Python 3 and start with 'python3 zeronet.py'.
What are the current limitations?Per the README, file transactions are not compressed yet, and there are no private sites.
Does that mean I can still open sites when my connection is down?Yes. Site files are stored on your machine, so you can access a site even if the Internet is unavailable — it is one of the project's headline promises.
How anonymous is browsing ZeroNet?Traffic can be routed through Tor with .onion hidden services instead of IPv4 addresses, and connections are TLS encrypted. There is also automatic uPnP port opening so peers can find you.
What is ZeroHello?The landing page ZeroNet opens in your browser once it is running — the starting point for browsing sites and for the 'Create new, empty site' menu used to publish your own.
Can ZeroNet sites use readable domain names?Yes, Namecoin .bit domains are supported, so a site can live at a .bit name instead of only a long cryptographic address.
Why build websites this way?The authors believe in an open, free, and uncensored network: no single point of failure, no hosting costs because sites are served by their visitors, and a site that is impossible to shut down since it is nowhere and everywhere at once.
Size
13.4 MB
Stars
18.8K
Age
11y
Commits · 90 Days