mirror of
https://github.com/hufrea/byedpi.git
synced 2025-08-25 12:55:37 +00:00
Add information about docker to the readme
This commit is contained in:
parent
3c715b327b
commit
22ae84f73d
@ -332,6 +332,12 @@ TCP может отсылать данные вне основного пото
|
|||||||
* Linux: `make`
|
* Linux: `make`
|
||||||
* Windows: `make windows CC=x86_64-w64-mingw32-gcc`
|
* Windows: `make windows CC=x86_64-w64-mingw32-gcc`
|
||||||
|
|
||||||
|
------
|
||||||
|
### Docker образ
|
||||||
|
|
||||||
|
Docker образ выкладывается на [DockerHub](https://hub.docker.com/r/hufrea/byedpi).
|
||||||
|
Пример конфигурации контейнера можно найти в [dist/docker](dist/docker).
|
||||||
|
|
||||||
------
|
------
|
||||||
### Дополнительная информация о DPI, источники идей
|
### Дополнительная информация о DPI, источники идей
|
||||||
* https://github.com/bol-van/zapret/blob/master/docs/readme.md
|
* https://github.com/bol-van/zapret/blob/master/docs/readme.md
|
||||||
|
48
dist/docker/README.md
vendored
Normal file
48
dist/docker/README.md
vendored
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
# Docker
|
||||||
|
|
||||||
|
## Docker Hub
|
||||||
|
|
||||||
|
An official container image available at https://hub.docker.com/r/hufrea/byedpi.
|
||||||
|
|
||||||
|
Images are tagged by full version number (`major.minor.patch`) and `major.minor`. As usual the latest stable release has `latest` tag.
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
To build a container image from the source execute:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker build . --tag my/byedpi
|
||||||
|
```
|
||||||
|
|
||||||
|
A tag allows to reference built image by human-readable name instead of hash and is optional.
|
||||||
|
|
||||||
|
Provided `Dockerfile` is compatible with podman if you want an alternative to docker.
|
||||||
|
|
||||||
|
## Running
|
||||||
|
|
||||||
|
To run a byedpi container use the command:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker run -it --rm hufrea/byedpi --help
|
||||||
|
```
|
||||||
|
|
||||||
|
Don't forget to expose a port to communicate with the container. For example to have local only access to byedpi SOCKS proxy on port 1234 add `-p 127.0.0.1:1234:1080` before the image name:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker run -it --rm -p 127.0.0.1:1234:1080 hufrea/byedpi --fake -1 --md5sig
|
||||||
|
```
|
||||||
|
|
||||||
|
## Compose
|
||||||
|
|
||||||
|
Docker compose is useful to simplify management of docker containers.
|
||||||
|
|
||||||
|
To use provided `compose.yaml` edit
|
||||||
|
1) arguments passed to byedpi in `command` array
|
||||||
|
2) `published` port if 1080 is already allocated
|
||||||
|
and run the command inside a directory containing `compose.yaml`
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
If docker daemon configured to start on system boot, it will keep byedpi container always up.
|
12
dist/docker/compose.yaml
vendored
Normal file
12
dist/docker/compose.yaml
vendored
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
services:
|
||||||
|
byedpi:
|
||||||
|
image: hufrea/byedpi
|
||||||
|
command: ["--fake", "-1", "--md5sig"]
|
||||||
|
restart: unless-stopped
|
||||||
|
user: 1000:1000
|
||||||
|
ports:
|
||||||
|
- name: SOCKS proxy
|
||||||
|
target: 1080
|
||||||
|
host_ip: 127.0.0.1
|
||||||
|
published: 1080
|
||||||
|
protocol: tcp
|
Loading…
Reference in New Issue
Block a user