Update README (NixOS dev instructions)

thanks @fgaz for explanations

fixes #189
This commit is contained in:
caryoscelus 2022-12-05 16:50:10 +00:00
parent 0fa90c5d17
commit ab9fc61efc

View file

@ -87,7 +87,7 @@ if you're on NixOS
(thanks @fgaz for making & maintaining the package) (thanks @fgaz for making & maintaining the package)
### Install from source (recommended) ### Install from source
#### System dependencies #### System dependencies
@ -108,7 +108,7 @@ Install autoconf and other basic development tools, python3 and pip, then procee
- (optional) `pkg install tor` - (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) - (optional) run tor via `tor --ControlPort 9051 --CookieAuthentication 1` command (you can then open new session by swiping to the right)
#### Building python dependencies & 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/`) - 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) - `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) - `source venv/bin/activate` (activate environment)
@ -119,6 +119,11 @@ Install autoconf and other basic development tools, python3 and pip, then procee
- `source venv/bin/activate` - `source venv/bin/activate`
- `python3 zeronet.py` - `python3 zeronet.py`
#### (alternatively) On NixOS
- clone this repo
- `nix-shell '<nixpkgs>' -A zeronet-conservancy` to enter shell with installed dependencies
- `./zeronet.py`
#### (alternatively) Build Docker image #### (alternatively) Build Docker image
- build 0net image: `docker build -t 0net-conservancy:latest . -f Dockerfile` - build 0net image: `docker build -t 0net-conservancy:latest . -f Dockerfile`
- or build 0net image with integrated tor: `docker build -t 0net-conservancy:latest . -f Dockerfile.integrated_tor` - or build 0net image with integrated tor: `docker build -t 0net-conservancy:latest . -f Dockerfile.integrated_tor`