README: partially rewrite installing
This commit is contained in:
parent
7d4e66e07b
commit
b95b979c7f
1 changed files with 38 additions and 26 deletions
64
README.md
64
README.md
|
@ -6,7 +6,7 @@
|
|||
|
||||
[по-русски](README-ru.md) | [em português](README-ptbr.md) | [简体中文](README-zh-cn.md)
|
||||
|
||||
Zeronet-Conservancy is a fork/continuation of [ZeroNet](https://github.com/HelloZeroNet/ZeroNet) project
|
||||
`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
|
||||
|
||||
|
@ -79,40 +79,39 @@ Following links relate to original ZeroNet:
|
|||
|
||||
### Install from Nix package manager (Linux or MacOS)
|
||||
|
||||
if you're on NixOS, install & configure nix package manager:
|
||||
```nix-env -iA nixpkgs.zeronet-conservancy```
|
||||
or
|
||||
```nix-env -iA nixos.zeronet-conservancy```
|
||||
- install & configure nix package manager (if needed)
|
||||
- `nix-env -iA nixpkgs.zeronet-conservancy`
|
||||
|
||||
or add `zeronet-conservancy` to your system configuration if you're on NixOS
|
||||
|
||||
(thanks @fgaz for making & maintaining the package)
|
||||
|
||||
### Install from source - simplified, using Git and Python PIP
|
||||
|
||||
1. Install Git and Python PIP package:
|
||||
|
||||
- Debian and Ubuntu based: `sudo apt install git python3-pip -y`
|
||||
- Red Hat and Fedora based: `yum install epel-release -y 2>/dev/null;yum install git python3 python3-wheel`
|
||||
- Fedora based dandified: `sudo dnf install git python3-pip python3-wheel -y`
|
||||
- Arch and Manjaro based: `sudo pacman -S git python-pip -v --no-confirm`
|
||||
- openSUSE: `sudo zypper install python3-pip python3-setuptools python3-wheel`
|
||||
|
||||
2. Clone Github repository and install required Python modules. First edit zndir path at the begining of the command, to be the path where you want to store Zeronet-Conservancy:
|
||||
|
||||
`zndir="/home/user/myapps/zeronet" ; if [[ ! -d "$zndir" ]]; then git clone --recursive "https://github.com/zeronet-conservancy/zeronet-conservancy.git" "$zndir" && cd "$zndir"||exit; else cd "$zndir";git pull origin master; fi; cd "$zndir" && pip install -r requirements.txt|grep -v "already satisfied"; echo "Try to run: python3 $(pwd)/zeronet.py"`
|
||||
|
||||
(This command can also be used to keep Zeronet-Conservancy up to date)
|
||||
|
||||
### Install from source - detailed
|
||||
### Install from source
|
||||
|
||||
#### System dependencies
|
||||
|
||||
##### Generic unix-like (including mac os x)
|
||||
|
||||
Install autoconf and other basic development tools, python3 and pip, then proceed to "building python dependencies"
|
||||
(if running fails due to missing dependency, please report it/make pull request to fix dependency list)
|
||||
|
||||
##### Apt-based (debian, ubuntu, etc)
|
||||
- `sudo apt update`
|
||||
- `sudo apt install pkg-config libffi-dev python3-pip python3-venv python3-dev build-essential`
|
||||
|
||||
##### Red Hat and Fedora based
|
||||
- `yum install epel-release -y 2>/dev/null`
|
||||
- `yum install git python3 python3-wheel`
|
||||
|
||||
##### Fedora based dandified
|
||||
- `sudo dnf install git python3-pip python3-wheel -y`
|
||||
|
||||
##### openSUSE
|
||||
- `sudo zypper install python3-pip python3-setuptools python3-wheel`
|
||||
|
||||
##### Arch and Manjaro based
|
||||
- `sudo pacman -S git python-pip -v --no-confirm`
|
||||
|
||||
##### Android/Termux
|
||||
- install [Termux](https://termux.com/) (in Termux you can install packages via `pkg install <package-names>`)
|
||||
- `pkg update`
|
||||
|
@ -122,7 +121,7 @@ Install autoconf and other basic development tools, python3 and pip, then procee
|
|||
- (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)
|
||||
|
||||
#### Building python dependencies venv & running
|
||||
#### Building python dependencies, venv & 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)
|
||||
|
@ -147,13 +146,26 @@ Install autoconf and other basic development tools, python3 and pip, then procee
|
|||
- or: `docker compose up -d 0net-tor` for run 0net and tor in one container.
|
||||
(please check if these instructions are still accurate)
|
||||
|
||||
#### Alternative one-liner (installing python dependencies globally)
|
||||
|
||||
Clone Github repository and install required Python modules. First
|
||||
edit zndir path at the begining of the command, to be the path where
|
||||
you want to store `zeronet-conservancy`:
|
||||
|
||||
`zndir="/home/user/myapps/zeronet" ; if [[ ! -d "$zndir" ]]; then git clone --recursive "https://github.com/zeronet-conservancy/zeronet-conservancy.git" "$zndir" && cd "$zndir"||exit; else cd "$zndir";git pull origin master; fi; cd "$zndir" && pip install -r requirements.txt|grep -v "already satisfied"; echo "Try to run: python3 $(pwd)/zeronet.py"`
|
||||
|
||||
(This command can also be used to keep `zeronet-conservancy` up to date)
|
||||
|
||||
#### 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
|
||||
- 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
|
||||
- more convenience scripts to be added soon
|
||||
|
||||
### Windows build
|
||||
### (unofficial) Windows OS build
|
||||
|
||||
Download and extract .zip archive [zeronet-conservancy-0.7.10-unofficial-win64.zip](https://github.com/zeronet-conservancy/zeronet-conservancy/releases/download/v0.7.10/zeronet-conservancy-0.7.10-unofficial-win64.zip)
|
||||
Download and extract .zip archive
|
||||
[zeronet-conservancy-0.7.10-unofficial-win64.zip](https://github.com/zeronet-conservancy/zeronet-conservancy/releases/download/v0.7.10/zeronet-conservancy-0.7.10-unofficial-win64.zip)
|
||||
|
||||
### Building under Windows OS
|
||||
|
||||
|
|
Loading…
Reference in a new issue