2021-12-22 19:14:02 +01:00
# zeronet-conservancy
2016-10-18 10:06:58 +02:00
2022-05-10 20:47:26 +02:00
zeronet-conservancy is a fork/continuation of [ZeroNet ](https://github.com/HelloZeroNet/ZeroNet ) project
(that has been abandoned by its creator) that is dedicated to sustaining existing p2p network and developing
its values of decentralization and freedom, while gradually switching to a better designed network
2015-01-12 20:35:23 +01:00
2021-12-22 19:14:02 +01:00
## Why fork?
2015-01-12 11:36:21 +01:00
2022-05-10 20:47:26 +02:00
During onion-v3 switch crisis, we needed a fork that worked with onion-v3 and didn't depend on trust to one or
two people. This fork started from fulfilling that mission, implementing minimal changes to
[ZeroNet/py3 ](https://github.com/HelloZeroNet/ZeroNet/tree/py3 ) branch which are easy to audit by anyone. While
you can still use the early releases of the fork to get onion-v3 working, the goal of this fork has since shifted
and we're dedicated to solving more problems and improving user experience and security all over, until the
brand new, completely transparent and audited network is ready and this project can be put to rest
2021-12-22 19:14:02 +01:00
## Why 0net?
2015-02-18 15:45:08 +01:00
2021-12-13 07:22:23 +01:00
* We believe in open, free, and uncensored networks and communication.
2016-03-02 12:50:36 +01:00
* No single point of failure: Site remains online so long as at least 1 peer is
2015-02-18 15:45:08 +01:00
serving it.
* No hosting costs: Sites are served by visitors.
* Impossible to shut down: It's nowhere because it's everywhere.
2016-03-02 12:50:36 +01:00
* Fast and works offline: You can access the site even if Internet is
2015-02-18 15:45:08 +01:00
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
2015-08-16 11:51:00 +02:00
* Clone websites in one click
2021-12-28 22:17:45 +01:00
* Password-less authorization using private/public keys
* Built-in SQL server with P2P data synchronization: allows easier dynamic site development
* Anonymity: Tor network support with .onion hidden services (including onion-v3 support)
* TLS encrypted connections (through clearnet)
* Automatic uPnP port opening (if opted in)
2015-04-20 22:31:29 +02:00
* Plugin for multiuser (openproxy) support
2022-05-10 20:47:26 +02:00
* Works with any modern 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.
2022-05-15 13:37:56 +02:00
`http://127.0.0.1:43110/126NXcevn1AUehWFZLTBw7FrX1crEizQdr` ).
2015-02-18 15:45:08 +01:00
* 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.
2016-03-02 12:50:36 +01:00
* Each visited site is also served by you.
* Every site contains a `content.json` file which holds all other files in a sha512 hash
and a signature generated using the site's private key.
2015-02-18 15:45:08 +01:00
* 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.
2016-03-02 12:50:36 +01:00
Afterwards, the peers verify the `content.json` integrity (using the
2015-02-18 15:45:08 +01:00
signature), they download the modified files and publish the new content to
other peers.
2015-04-28 00:43:17 +02:00
2021-12-28 22:17:45 +01:00
Following links relate to original ZeroNet:
2015-01-12 03:18:50 +01:00
2021-12-28 22:17:45 +01: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 )
- [Frequently asked questions » ](https://zeronet.io/docs/faq/ )
- [ZeroNet Developer Documentation » ](https://zeronet.io/docs/site_development/getting_started/ )
2015-01-12 20:35:23 +01:00
2016-03-02 12:50:36 +01:00
## How to join
2015-01-21 12:58:26 +01:00
2022-01-08 10:32:27 +01:00
### Install from source (recommended)
#### System dependencies
2022-05-15 13:37:56 +02:00
##### Generic unix-like (including mac os x)
2022-01-08 10:32:27 +01:00
Install autoconf and other basic development tools, python3 and pip.
##### Apt-based (debian, ubuntu, etc)
- `sudo apt update`
2022-05-14 13:21:32 +02:00
- `sudo apt install pkg-config python3-pip python3-venv`
2022-01-08 10:32:27 +01:00
##### Android/Termux
2022-05-15 18:09:49 +02:00
- install [Termux ](https://termux.com/ ) (in Termux you can install packages via `pkg install <package-names>` )
2022-01-08 10:32:27 +01:00
- `pkg update`
2022-05-15 18:09:49 +02:00
- `pkg install python automake git binutils` (TODO: check fresh installation whether there are more dependencies to install)
2022-05-13 01:15:43 +02:00
- (optional) `pkg install tor`
- (optional) run tor via `tor --ControlPort 9051 --CookieAuthentication 1` command (you can then open new session by swiping to the right)
2022-01-08 10:32:27 +01:00
#### Building python dependencies & running
- clone this repo (NOTE: on Android/Termux you should clone it into "home" folder of Termux, because virtual environment cannot live in `storage/` )
- `python3 -m venv venv` (make python virtual environment, the last `venv` is just a name, if you use different you should replace it in later commands)
- `source venv/bin/activate` (activate environment)
- `python3 -m pip install -r requirements.txt` (install dependencies)
- `python3 zeronet.py` (**run zeronet-conservancy!**)
- open the landing page in your browser by navigating to: http://127.0.0.1:43110/
- to start it again from fresh terminal, you need to navigate to repo directory and:
- `source venv/bin/activate`
- `python3 zeronet.py`
2021-12-22 19:31:40 +01:00
2022-05-31 15:20:59 +02:00
#### Build Docker image
- build 0net image: `docker build -t 0net:conservancy . -f Dockerfile`
2022-05-31 15:35:04 +02:00
- or build 0net image with integrated tor: `docker build -t 0net:conservancy . -f Dockerfile.integrated_tor`
2022-05-31 15:20:59 +02:00
- and run it: `docker run --rm -it -v </path/to/0n/data/directory>:/app/data -p 43110:43110 -p 26552:26552 0net:conservancy`
- /path/to/0n/data/directory - directory, where all data will be saved, including your secret certificates. If you run it with production mode, do not remove this folder!
- or you can run it with docker-compose: `docker compose up -d 0net` up two containers - 0net and tor separately.
- or: `docker compose up -d 0net-tor` for run 0net and tor in one container.
2022-05-10 20:47:26 +02:00
#### alternative script
- after installing general dependencies and cloning repo (as above), run `start-venv.sh` which will create a virtual env for you and install python requirements
2022-05-13 01:15:43 +02:00
- more convenience scripts to be added soon
2022-05-10 20:47:26 +02:00
2015-01-17 18:50:56 +01:00
## Current limitations
2015-02-18 15:45:08 +01:00
2021-12-28 22:17:45 +01:00
* File transactions are not compressed
2015-02-18 15:45:08 +01:00
* No private sites
2021-12-28 22:17:45 +01:00
* No DHT support
2022-05-13 01:15:43 +02:00
* Centralized elements like zeroid (we're working on this!)
* No reliable spam protection (and on this too)
* Doesn't work directly from browser (one of the top priorities for mid-future)
* No data transparency
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
2022-05-15 13:37:56 +02:00
* Click on ** ⋮** > ** "Create new, empty site"** menu item on the [admin page ](http://127.0.0.1:43110/126NXcevn1AUehWFZLTBw7FrX1crEizQdr ).
2019-12-18 14:55:37 +01:00
* You will be **redirected** to a completely new site that is only modifiable by you!
* You can find and modify your site's content in **data/[yoursiteaddress]** directory
2021-12-13 07:22:23 +01:00
* After the modifications open your site, drag the topright "0" button to the left, then press **sign** and **publish** buttons on the bottom
2015-01-12 20:35:23 +01:00
2018-11-08 02:43:51 +01:00
Next steps: [ZeroNet Developer Documentation ](https://zeronet.io/docs/site_development/getting_started/ )
2015-01-18 22:52:19 +01:00
2021-12-22 19:27:33 +01:00
## Help this project stay alive
2015-01-13 00:29:40 +01:00
2021-12-22 19:27:33 +01:00
### Become a maintainer
2015-01-13 00:29:40 +01:00
2022-05-13 01:15:43 +02:00
We need more maintainers! Become one today! You don't need to know how to code,
there's a lot of other work to do.
### Fix bugs & add features
We've decided to go ahead and make a perfect p2p web, so we need more help
implementing it.
### Make your site/bring your content
We know the documentation is lacking, but we try our best to support anyone
who wants to migrate. Don't hesitate to ask.
2015-08-09 02:18:11 +02:00
2021-12-22 19:27:33 +01:00
### Use it and spread the word
Make sure to tell people why do you use 0net and this fork in particular! People
need to know their alternatives.
### Financially support maintainers
2022-05-16 22:12:20 +02:00
Currently the lead developer / maintainer of this fork is @caryoscelus . You can
see ways to donate to them on https://caryoscelus.github.io/donate/ (or check
sidebar if you're reading this on github for more ways). As our team grows, we
will create team accounts on friendly crowdfunding platforms as well.
2021-12-22 19:27:33 +01:00
If you want to make sure your donation is recognized as donation for this
project, there is a dedicated bitcoin address for that, too:
1Kjuw3reZvxRVNs27Gen7jPJYCn6LY7Fg6
If you want to donate in a different way, feel free to contact maintainer or
create an issue