From 020620c68acddf132416efe7de3b2608a8cc68d3 Mon Sep 17 00:00:00 2001 From: Maxim Portnyagin Date: Tue, 31 May 2022 17:20:59 +0400 Subject: [PATCH] Add docs --- README-ru.md | 7 +++++++ README.md | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/README-ru.md b/README-ru.md index f01c2abe..5b3ddbc1 100644 --- a/README-ru.md +++ b/README-ru.md @@ -90,6 +90,13 @@ zeronet-conservancy — это форк/продолжение проекта [Z - `source venv/bin/activate` - `python3 zeronet.py` +#### Создание образа Docker +- создание образа: `docker build -t 0net:conservancy . -f Dockerfile` +- и его запуск: `docker run --rm -it -v :/app/data -p 43110:43110 -p 26552:26552 0net:conservancy` +- /path/to/0n/data/directory - директория, куда будут сохраняться все данные в том числе секретные ключи. Если вы запускаете в боевом режиме, не потеряйте эту папку! +- или вы можете воспользоваться docker-compose: `docker compose up -d 0net` запускает два контейнера раздельно, для 0net и tor сервисов. +- или: `docker compose up -d 0net-tor` запускает один контейнер с tor и 0net. + #### альтернативный скрипт - после установки общих зависимостей и клонирования репозитория (как указано выше) запустите `start-venv.sh` который создаст для вас виртуальную среду и установит требования Python - больше удобных скриптов будует добавлено в ближайшее время diff --git a/README.md b/README.md index 652cb36d..bc9570c6 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,13 @@ Install autoconf and other basic development tools, python3 and pip. - `source venv/bin/activate` - `python3 zeronet.py` +#### Build Docker image +- build 0net image: `docker build -t 0net:conservancy . -f Dockerfile` +- and run it: `docker run --rm -it -v :/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. + #### 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 - more convenience scripts to be added soon