Readme create, update site, clearer site publishing debug message

This commit is contained in:
HelloZeroNet 2015-01-12 20:35:23 +01:00
parent effa267b73
commit ceb8ce6027
2 changed files with 41 additions and 7 deletions

View File

@ -1,8 +1,10 @@
# ZeroNet
Decentralized web platform using Bitcoin Crypto and BitTorrent network
Decentralized web platform using Bitcoin crypto and BitTorrent network
## Why?
- We believe in open, free and uncensored network and communication.
- No single point of failure: Site goes on until at least 1 peer serving it.
- No hosting costs: Site served by visitors.
- Imposible to shut down: It's nowhere because it's everywhere.
@ -10,21 +12,24 @@ Decentralized web platform using Bitcoin Crypto and BitTorrent network
## How does it works?
- After starting `zeronet.py` you will be able to visit zeronet sites using http://127.0.0.1:43110/[zeronet_address] (eg. http://127.0.0.1:43110/1EU1tbG9oC1A8jz2ouVwGZyQ5asrNsE4Vr).
- After starting `zeronet.py` you will be able to visit zeronet sites using http://127.0.0.1:43110/{zeronet_address} (eg. http://127.0.0.1:43110/1EU1tbG9oC1A8jz2ouVwGZyQ5asrNsE4Vr).
- When you visit a new zeronet site, it's try to find peers using BitTorrent network and download the site files (html, css, js...) from them.
- Each visited sites become also served by You.
- Every site containing a `site.json` which holds all other files md5 hash and a sign generated using site's private key.
- Every site containing a `site.json` which holds all other files sha1 hash and a sign 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 publish it to the peers. After the peers verified the `content.json` integrity using the sign they download the modified files and publish the new content to other peers.
## Screenshot
![Screenshot](http://i.imgur.com/QaZhUCk.png)
## How to join?
Windows:
- [Install Python 2.7](https://www.python.org/ftp/python/2.7.9/python-2.7.9.msi)
- [Install Python ZeroMQ](http://www.lfd.uci.edu/~gohlke/pythonlibs/girnt9fk/pyzmq-14.4.1.win32-py2.7.exe)
- [Install Python Gevent](http://www.lfd.uci.edu/~gohlke/pythonlibs/girnt9fk/gevent-1.0.1.win32-py2.7.exe)
- [Install Python ZeroMQ](http://zeronet.io/files/windows/pyzmq-14.4.1.win32-py2.7.exe)
- [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)
- start `zeronet.py`
@ -35,4 +40,33 @@ Linux (Debian):
- `pip install msgpack-python`
- start using `python zeronet.py`
## How can I create a ZeroNet site?
```
$ zeronet.py siteCreate
...
- Site private key: 23DKQpzxhbVBrAtvLEc2uvk7DZweh4qL3fn3jpM3LgHDczMK2TtYUq
- Site address: 13DNDkMUExRf9Xa9ogwPKqp7zyHFEqbhC2
...
- Site created!
$ zeronet.py
...
```
Congratulations, you are done! Now anyone can access your site using http://localhost:43110/13DNDkMUExRf9Xa9ogwPKqp7zyHFEqbhC2
## How can I modify a ZeroNet site?
- Modify files located in data/13DNDkMUExRf9Xa9ogwPKqp7zyHFEqbhC2 directory. After you done:
```
$ zeronet.py siteSign 13DNDkMUExRf9Xa9ogwPKqp7zyHFEqbhC2
- Signing site: 13DNDkMUExRf9Xa9ogwPKqp7zyHFEqbhC2...
Private key (input hidden):
```
- Enter your private key you got when created the site, then:
```
$ zeronet.py sitePublish 13DNDkMUExRf9Xa9ogwPKqp7zyHFEqbhC2
...
Site:13DNDk..bhC2 Publishing to 3/10 peers...
Site:13DNDk..bhC2 Successfuly published to 3 peers
- Serving files....
```
- That's it! You successfuly signed and published your modifications.

View File

@ -152,7 +152,7 @@ class Site:
# Update content.json on peers
def publish(self, limit=3):
self.log.info("Publishing to %s/%s peers..." % (limit, len(self.peers)))
self.log.info( "Publishing to %s/%s peers..." % (len(self.peers), limit) )
published = 0
for key, peer in self.peers.items(): # Send update command to each peer
result = {"exception": "Timeout"}