oci/zeronet
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #284 from ashleypt/master

Browse source 
README.md modifications
This commit is contained in:
ZeroNet 2016-03-06 02:33:26 +01:00
commit 119a408f78
1 changed files with 28 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -5,12 +5,12 @@ Decentralized websites using Bitcoin crypto and the BitTorrent network - https:/
## Why? ## Why?
* We believe in open, free, and uncensored network and communication. * We believe in open, free, and uncensored networking and communication.
* No single point of failure: Site remains online so long as at least 1 peer * No single point of failure: Site remains online so long as at least 1 peer is
serving it. serving it.
* No hosting costs: Sites are served by visitors. * No hosting costs: Sites are served by visitors.
* Impossible to shut down: It's nowhere because it's everywhere. * 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 * Fast and works offline: You can access the site even if Internet is
unavailable. unavailable.
@ -20,11 +20,11 @@ Decentralized websites using Bitcoin crypto and the BitTorrent network - https:/
* Easy to setup: unpack & run * Easy to setup: unpack & run
* Clone websites in one click * Clone websites in one click
* Password-less [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) * Password-less [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)
based authorization: Your account is protected by same cryptography as your Bitcoin wallet based authorization: Your account is protected by the same cryptography as your Bitcoin wallet
* Built-in SQL server with P2P data synchronization: Allows easier site development and faster page load times * Built-in SQL server with P2P data synchronization: Allows easier site development and faster page load times
* Anonymity: Full Tor network support with .onion hidden services instead of ipv4 addresses * Anonymity: Full Tor network support with .onion hidden services instead of IPv4 addresses
* TLS encrypted connections * TLS encrypted connections
* Automatic, uPnP port opening * Automatic uPnP port opening
* Plugin for multiuser (openproxy) support * Plugin for multiuser (openproxy) support
* Works with any browser/OS * Works with any browser/OS
@ -36,12 +36,12 @@ Decentralized websites using Bitcoin crypto and the BitTorrent network - https:/
`http://127.0.0.1:43110/1HeLLo4uzjaLetFx6NH3PMwFP3qbRbTf3D`). `http://127.0.0.1:43110/1HeLLo4uzjaLetFx6NH3PMwFP3qbRbTf3D`).
* When you visit a new zeronet site, it tries to find peers using the BitTorrent * 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. network so it can download the site files (html, css, js...) from them.
* Each visited site becomes also served by you. * Each visited site is also served by you.
* Every site contains a `content.json` which holds all other files in a sha512 hash * Every site contains a `content.json` file which holds all other files in a sha512 hash
and a signature generated using site's private key. and a signature generated using the site's private key.
* If the site owner (who has the private key for the site address) modifies the * 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. 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 Afterwards, the peers verify the `content.json` integrity (using the
signature), they download the modified files and publish the new content to signature), they download the modified files and publish the new content to
other peers. other peers.
@ -59,7 +59,7 @@ Decentralized websites using Bitcoin crypto and the BitTorrent network - https:/
#### [More screenshots in ZeroNet docs »](https://zeronet.readthedocs.org/en/latest/using_zeronet/sample_sites/) #### [More screenshots in ZeroNet docs »](https://zeronet.readthedocs.org/en/latest/using_zeronet/sample_sites/)
## How to join? ## How to join
### Windows ### Windows
@ -92,7 +92,7 @@ It downloads the latest version of ZeroNet then starts it automatically.
* Open http://127.0.0.1:43110/ in your browser and enjoy! :) * Open http://127.0.0.1:43110/ in your browser and enjoy! :)
#### Other Linux or without root access #### 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 * 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 on
* `wget https://bootstrap.pypa.io/get-pip.py` * `wget https://bootstrap.pypa.io/get-pip.py`
* `python get-pip.py --user gevent msgpack-python` * `python get-pip.py --user gevent msgpack-python`
* Start with `python zeronet.py` * Start with `python zeronet.py`
@ -104,7 +104,7 @@ It downloads the latest version of ZeroNet then starts it automatically.
* `pip install gevent msgpack-python` * `pip install gevent msgpack-python`
* [Download](https://github.com/HelloZeroNet/ZeroNet/archive/master.zip), Unpack, run `python zeronet.py` * [Download](https://github.com/HelloZeroNet/ZeroNet/archive/master.zip), Unpack, run `python zeronet.py`
### Vagrant ### [Vagrant](https://www.vagrantup.com/)
* `vagrant up` * `vagrant up`
* Access VM with `vagrant ssh` * Access VM with `vagrant ssh`
@ -112,13 +112,26 @@ It downloads the latest version of ZeroNet then starts it automatically.
* Run `python zeronet.py --ui_ip 0.0.0.0` * Run `python zeronet.py --ui_ip 0.0.0.0`
* Open http://127.0.0.1:43110/ in your browser * Open http://127.0.0.1:43110/ in your browser
<<<<<<< HEAD
### [Docker](https://www.docker.com/)
* `docker run -p 15441:15441 -p 43110:43110 nofish/zeronet`
=======
### Docker ### Docker
* `docker run -d -v <local_data_folder>:/root/data -p 15441:15441 -p 43110:43110 nofish/zeronet` * `docker run -d -v <local_data_folder>:/root/data -p 15441:15441 -p 43110:43110 nofish/zeronet`
>>>>>>> upstream/master
* Open http://127.0.0.1:43110/ in your browser
### [Virtualenv](https://virtualenv.readthedocs.org/en/latest/)
* `virtualenv env`
* `source env/bin/activate`
* `pip install msgpack-python gevent`
* `python zeronet.py`
* Open http://127.0.0.1:43110/ in your browser * Open http://127.0.0.1:43110/ in your browser
## Current limitations ## Current limitations
* No torrent-like, file splitting for big file support * No torrent-like file splitting for big file support
* ~~No more anonymous than Bittorrent~~ (built-in full Tor support added) * ~~No more anonymous than Bittorrent~~ (built-in full Tor support added)
* File transactions are not compressed ~~or encrypted yet~~ (TLS encryption added) * File transactions are not compressed ~~or encrypted yet~~ (TLS encryption added)
* No private sites * No private sites
@ -169,7 +182,7 @@ Site:13DNDk..bhC2 Successfuly published to 3 peers
* That's it! You've successfully signed and published your modifications. * That's it! You've successfully signed and published your modifications.
## If you want to help keep this project alive ## Donate
- Bitcoin: 1QDhxQ6PraUZa21ET5fYUCPgdrwBomnFgX - Bitcoin: 1QDhxQ6PraUZa21ET5fYUCPgdrwBomnFgX
- Paypal: https://zeronet.readthedocs.org/en/latest/help_zeronet/donate/ - Paypal: https://zeronet.readthedocs.org/en/latest/help_zeronet/donate/