Rev426, Fix for nonce error on bigsites asking, Dont display error details on 404 error, Dont log Websocket close errors, Add travis pip caching and osx test, Add build status to readme, Test for site files after cloning, Test for json to db mapping, Test site deleteFiles command, Test user certificate and auth address generation, Exclude debug lines from coverage, Dont run webtests every time
2015-09-20 22:35:45 +02:00
# ZeroNet [![Build Status](https://travis-ci.org/HelloZeroNet/ZeroNet.svg?branch=master)](https://travis-ci.org/HelloZeroNet/ZeroNet)
2015-01-12 03:18:50 +01:00
2015-05-31 15:52:21 +02:00
Decentralized websites using Bitcoin crypto and the BitTorrent network - http://zeronet.io
2015-01-12 20:35:23 +01:00
2015-01-12 11:36:21 +01:00
## Why?
2015-02-18 15:45:08 +01:00
* We believe in open, free, and uncensored network and communication.
* No single point of failure: Site remains online so long as at least 1 peer
serving it.
* No hosting costs: Sites are served by visitors.
* Impossible to shut down: It's nowhere because it's everywhere.
* Fast and works offline: You can access the site even if your internet is
unavailable.
2015-01-12 11:36:21 +01:00
2015-01-12 03:18:50 +01:00
2015-04-20 22:31:29 +02:00
## Features
* Real-time updated sites
* Namecoin .bit domains support
* Easy to setup: unpack & run
2015-08-16 11:51:00 +02:00
* Clone websites in one click
* Password-less [BIP32 ](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki )
2015-04-20 22:31:29 +02:00
based authorization: Your account is protected by same cryptography as your Bitcoin wallet
* Built-in SQL server with P2P data synchronization: Allows easier site development and faster page load times
* Tor network support
2015-06-15 02:51:51 +02:00
* TLS encrypted connections
2015-04-20 22:31:29 +02:00
* Automatic, uPnP port opening
* Plugin for multiuser (openproxy) support
2015-04-21 00:35:34 +02:00
* Works with any browser/OS
2015-08-16 11:51:00 +02:00
2015-04-20 22:31:29 +02:00
2015-01-13 10:56:47 +01:00
## How does it work?
2015-02-18 15:45:08 +01:00
* After starting `zeronet.py` you will be able to visit zeronet sites using
2015-08-16 11:51:00 +02:00
`http://127.0.0.1:43110/{zeronet_address}` (eg.
2015-02-18 15:45:08 +01:00
`http://127.0.0.1:43110/1EU1tbG9oC1A8jz2ouVwGZyQ5asrNsE4Vr` ).
* When you visit a new zeronet site, it tries to find peers using the BitTorrent
network so it can download the site files (html, css, js...) from them.
* Each visited site becomes also served by you.
* Every site contains a `site.json` which holds all other files in a sha512 hash
and a signature generated using site's private key.
* If the site owner (who has the private key for the site address) modifies the
site, then he/she signs the new `content.json` and publishes it to the peers.
After the peers have verified the `content.json` integrity (using the
signature), they download the modified files and publish the new content to
other peers.
2015-04-28 00:43:17 +02:00
#### [Slideshow about ZeroNet cryptography, site updates, multi-user sites »](https://docs.google.com/presentation/d/1_2qK1IuOKJ51pgBvllZ9Yu7Au2l551t3XBgyTSvilew/pub?start=false&loop=false&delayms=3000)
2015-07-07 03:14:45 +02:00
#### [Frequently asked questions »](http://zeronet.readthedocs.org/en/latest/faq/)
2015-01-12 03:18:50 +01:00
2015-01-12 20:35:23 +01:00
2015-01-12 11:55:37 +01:00
2015-04-08 01:19:56 +02:00
## Screenshots
![Screenshot ](http://zeronet.readthedocs.org/en/latest/img/zerohello.png )
![ZeroTalk ](http://zeronet.readthedocs.org/en/latest/img/zerotalk.png )
2015-05-06 00:59:15 +02:00
#### [More screenshots in ZeroNet docs »](http://zeronet.readthedocs.org/en/latest/using_zeronet/sample_sites/)
2015-01-12 03:18:50 +01:00
2015-01-12 20:35:23 +01:00
2015-01-12 11:36:21 +01:00
## How to join?
2015-01-21 12:58:26 +01:00
2015-02-18 15:45:08 +01:00
### Windows
2015-10-19 01:34:36 +02:00
* [Download ZeroBundle package ](https://github.com/HelloZeroNet/ZeroBundle/releases/download/0.1.1/ZeroBundle-v0.1.1.zip ) that includes Python 2.7.9 and all required libraries
2015-04-09 22:20:33 +02:00
* Unpack to any directory
* Run `zeronet.cmd`
It downloads the latest version of ZeroNet then starts it automatically.
#### Alternative method for Windows by installing Python
2015-02-18 15:45:08 +01:00
* [Install Python 2.7 ](https://www.python.org/ftp/python/2.7.9/python-2.7.9.msi )
* [Install Python Greenlet ](http://zeronet.io/files/windows/greenlet-0.4.5.win32-py2.7.exe )
* [Install Python Gevent ](http://zeronet.io/files/windows/gevent-1.0.1.win32-py2.7.exe )
* [Install Python MsgPack ](http://zeronet.io/files/windows/msgpack-python-0.4.2.win32-py2.7.exe )
2015-04-09 22:20:33 +02:00
* [Download and extract ZeroNet ](https://codeload.github.com/HelloZeroNet/ZeroNet/zip/master ) to any directory
* Run `start.py`
2015-02-18 15:45:08 +01:00
### Linux
#### Debian
2015-03-25 12:40:12 +01:00
* `sudo apt-get update`
2015-08-16 11:51:00 +02:00
* `sudo apt-get install msgpack-python python-gevent`
2015-05-06 01:42:28 +02:00
* `wget https://github.com/HelloZeroNet/ZeroNet/archive/master.tar.gz`
* `tar xvpfz master.tar.gz`
* `cd ZeroNet-master`
2015-02-18 15:45:08 +01:00
* Start with `python zeronet.py`
2015-03-25 12:40:12 +01:00
* Open http://127.0.0.1:43110/ in your browser and enjoy! :)
2015-02-18 15:45:08 +01:00
2015-03-11 16:33:51 +01:00
#### Other Linux or without root access
* Check your python version using `python --version` if the returned version is not `Python 2.7.X` then try `python2` or `python2.7` command and use it from now
2015-08-16 11:51:00 +02:00
* `wget https://bootstrap.pypa.io/get-pip.py`
2015-05-03 13:12:25 +02:00
* `python get-pip.py --user gevent msgpack-python`
2015-02-18 15:45:08 +01:00
* Start with `python zeronet.py`
2015-01-12 20:35:23 +01:00
2015-04-12 23:59:22 +02:00
### Mac
2015-04-11 12:36:44 +02:00
2015-06-04 22:02:47 +02:00
* Install [Homebrew ](http://brew.sh/ )
2015-04-11 12:36:44 +02:00
* `brew install python`
2015-05-03 13:12:25 +02:00
* `pip install gevent msgpack-python`
2015-04-11 12:36:44 +02:00
* [Download ](https://github.com/HelloZeroNet/ZeroNet/archive/master.zip ), Unpack, run `python zeronet.py`
2015-08-16 11:51:00 +02:00
2015-05-26 21:44:45 +02:00
### Vagrant
* `vagrant up`
* Access VM with `vagrant ssh`
* `cd /vagrant`
* Run `python zeronet.py --ui_ip 0.0.0.0`
* Open http://127.0.0.1:43110/ in your browser
2015-04-11 12:36:44 +02:00
2015-05-27 20:16:15 +02:00
### Docker
* `docker run -p 15441:15441 -p 43110:43110 nofish/zeronet `
* Open http://127.0.0.1:43110/ in your browser
2015-01-17 18:50:56 +01:00
## Current limitations
2015-02-18 15:45:08 +01:00
* No torrent-like, file splitting for big file support
2015-02-18 15:47:36 +01:00
* No more anonymous than Bittorrent
2015-06-15 02:51:51 +02:00
* File transactions are not compressed ~~or encrypted yet~~
2015-02-18 15:45:08 +01:00
* No private sites
2015-04-08 01:19:56 +02:00
* ~~You must have an open port to publish new changes~~
* ~~Timeout problems on slow connections~~
2015-01-17 18:50:56 +01:00
2015-01-12 20:35:23 +01:00
## How can I create a ZeroNet site?
2015-02-18 15:45:08 +01:00
2015-01-27 22:37:13 +01:00
Shut down zeronet if you are running it already
2015-02-18 15:45:08 +01:00
```bash
2015-01-12 20:35:23 +01:00
$ zeronet.py siteCreate
...
- Site private key: 23DKQpzxhbVBrAtvLEc2uvk7DZweh4qL3fn3jpM3LgHDczMK2TtYUq
- Site address: 13DNDkMUExRf9Xa9ogwPKqp7zyHFEqbhC2
...
- Site created!
$ zeronet.py
...
```
2015-02-18 15:45:08 +01:00
Congratulations, you're finished! Now anyone can access your site using
`http://localhost:43110/13DNDkMUExRf9Xa9ogwPKqp7zyHFEqbhC2`
2015-01-12 20:35:23 +01:00
2015-05-10 18:31:56 +02:00
Next steps: [ZeroNet Developer Documentation ](http://zeronet.readthedocs.org/en/latest/site_development/getting_started/ )
2015-01-18 22:52:19 +01:00
2015-01-17 18:50:56 +01:00
2015-01-12 20:35:23 +01:00
## How can I modify a ZeroNet site?
2015-02-18 15:45:08 +01:00
* Modify files located in data/13DNDkMUExRf9Xa9ogwPKqp7zyHFEqbhC2 directory.
After you're finished:
```bash
2015-01-12 20:35:23 +01:00
$ zeronet.py siteSign 13DNDkMUExRf9Xa9ogwPKqp7zyHFEqbhC2
- Signing site: 13DNDkMUExRf9Xa9ogwPKqp7zyHFEqbhC2...
Private key (input hidden):
```
2015-02-18 15:45:08 +01:00
2015-09-07 08:00:04 +02:00
* Enter the private key you got when you created the site, then:
2015-02-18 15:45:08 +01:00
```bash
2015-01-12 20:35:23 +01:00
$ zeronet.py sitePublish 13DNDkMUExRf9Xa9ogwPKqp7zyHFEqbhC2
...
Site:13DNDk..bhC2 Publishing to 3/10 peers...
Site:13DNDk..bhC2 Successfuly published to 3 peers
- Serving files....
```
2015-02-18 15:45:08 +01:00
* That's it! You've successfully signed and published your modifications.
2015-01-13 00:29:40 +01:00
2015-01-17 18:50:56 +01:00
2015-01-13 00:29:40 +01:00
## If you want to help keep this project alive
Bitcoin: 1QDhxQ6PraUZa21ET5fYUCPgdrwBomnFgX
2015-08-09 02:18:11 +02:00
### Sponsors
* Better OSX/Safari compatibility made possible by [BrowserStack.com ](https://www.browserstack.com )
2015-01-15 23:24:51 +01:00
2015-01-18 22:52:19 +01:00
#### Thank you!
2015-01-17 18:50:56 +01:00
2015-02-18 15:45:08 +01:00
* More info, help, changelog, zeronet sites: http://www.reddit.com/r/zeronet/
2015-02-26 01:32:27 +01:00
* Come, chat with us: [#zeronet @ FreeNode ](https://kiwiirc.com/client/irc.freenode.net/zeronet ) or on [gitter ](https://gitter.im/HelloZeroNet/ZeroNet )
2015-04-08 01:19:56 +02:00
* Email: hello@noloop.me