Skip to content

Commit a9b777d

Browse files
committed
Update READMEs
1 parent 9e3c684 commit a9b777d

File tree

2 files changed

+40
-10
lines changed

2 files changed

+40
-10
lines changed

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
- [Supported arguments](#supported-arguments)
4242
- [Run from source code](#run-from-source-code)
4343
- [Building the executable](#building-the-executable)
44-
- [Running in Docker](#running-in-docker)
44+
- [Run in Docker](#run-in-docker)
4545
- [FAQ](#faq)
4646
- [Star History](#star-history)
4747

@@ -172,7 +172,7 @@ options:
172172

173173
## Run from source code
174174

175-
1) Make sure you have Python 3.9 or higher installed. No third-party libraries are required
175+
1) Make sure you have Python 3.7 or higher installed. No third-party libraries are required
176176
2) Clone the repository `git clone https://github.com/GVCoder09/NoDPI.git` or [download the archive](https://github.com/GVCoder09/NoDPI/archive/refs/heads/main.zip) with the source code and unzip it
177177
3) Go to the main directory and run the code with the command `python src/main.py`
178178
4) In the browser or system settings, set the proxy to 127.0.0.1:8881
@@ -182,18 +182,33 @@ You can enable error or access logging using parameters `--log_error` and `--log
182182

183183
## Building the executable
184184

185-
1) Make sure you have Python 3.9 or higher installed.
185+
1) Make sure you have Python 3.7 or higher installed.
186186
2) Install pyinstaller: `pip install pyinstaller`
187187
3) Clone the repository `git clone https://github.com/GVCoder09/NoDPI.git` or [download the archive](https://github.com/GVCoder09/NoDPI/archive/refs/heads/main.zip) with the source code and unzip it
188188
4) Go to the main directory and run the command `pyinstaller ./nodpi.spec`
189189
5) The compiled file will be located in ist folder `./dist`
190190

191-
## Running in Docker
191+
## Run in Docker
192192

193193
1) [Install Docker](https://docs.docker.com/).
194194
2) Clone the repository: `git clone https://github.com/GVCoder09/NoDPI`
195-
3) Navigate to the project directory and build the container: `cd NoDPI && docker build -t nodpi .`
196-
4) Run the container with the command: `docker run -d -p 127.0.0.1:8881:8881 -v /path/to/blacklists/:/blacklists:ro nodpi`, where `/path/to/blacklists/` is the path to the blacklist files.
195+
3) Navigate to the project directory and build the container:
196+
```bash
197+
cd NoDPI
198+
sudo docker build -t nodpi-proxy .
199+
```
200+
4) Run the container with the command:
201+
```bash
202+
sudo docker run -d \
203+
--name nodpi \
204+
-p 8881:8881 \
205+
-v $(pwd)/blacklist.txt:/tmp/nodpi/blacklist.txt \
206+
nodpi-proxy \
207+
--host 127.0.0.1 \
208+
--port 8881 \
209+
--blacklist /tmp/nodpi/blacklist.txt \
210+
--quiet
211+
```
197212
5) Enjoy!
198213

199214
## FAQ

README.ru.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ options:
171171

172172
## Запуск из исходного кода
173173

174-
1) Убедитесь, что у вас установлен Python 3.9 или выше. Сторонние библиотеки не требуются.
174+
1) Убедитесь, что у вас установлен Python 3.8 или выше. Сторонние библиотеки не требуются.
175175
2) Склонируйте репозиторий `git clone https://github.com/GVCoder09/NoDPI.git` или [скачайте архив](https://github.com/GVCoder09/NoDPI/archive/refs/heads/main.zip) с исходным кодом и распакуйте его.
176176
3) Перейдите в корневой каталог и запустите код командой `python src/main.py`.
177177
4) В настройках браузера или системы установите прокси-сервер на 127.0.0.1:8881.
@@ -181,7 +181,7 @@ options:
181181

182182
## Сборка исполняемого файла
183183

184-
1) Убедитесь, что у вас установлен Python 3.9 или выше.
184+
1) Убедитесь, что у вас установлен Python 3.8 или выше.
185185
2) Установите pyinstaller: `pip install pyinstaller`
186186
3) Клонируйте репозиторий `git clone https://github.com/GVCoder09/NoDPI.git` или [скачайте архив](https://github.com/GVCoder09/NoDPI/archive/refs/heads/main.zip) с исходным кодом и распакуйте его.
187187
4) Перейдите в корневой каталог и выполните команду `pyinstaller ./nodpi.spec`
@@ -191,8 +191,23 @@ options:
191191

192192
1) [Установите Docker](https://docs.docker.com/).
193193
2) Клонируйте репозиторий: `git clone https://github.com/GVCoder09/NoDPI`
194-
3) Перейдите в каталог проекта и соберите контейнер: `cd NoDPI && docker build -t nodpi .`
195-
4) Запустите контейнер командой: `docker run -d -p 127.0.0.1:8881:8881 -v /path/to/blacklists/:/blacklists:ro nodpi`, где `/path/to/blacklists/` — это путь к файлам чёрного списка.
194+
3) Перейдите в каталог проекта и соберите контейнер:
195+
```bash
196+
cd NoDPI
197+
sudo docker build -t nodpi-proxy .
198+
```
199+
4) Запустите контейнер командой:
200+
```bash
201+
sudo docker run -d \
202+
--name nodpi \
203+
-p 8881:8881 \
204+
-v $(pwd)/blacklist.txt:/tmp/nodpi/blacklist.txt \
205+
nodpi-proxy \
206+
--host 127.0.0.1 \
207+
--port 8881 \
208+
--blacklist /tmp/nodpi/blacklist.txt \
209+
--quiet
210+
```
196211
5) Наслаждайтесь!
197212

198213
## FAQ

0 commit comments

Comments
 (0)