hesoyam/psiphon-docker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated the readme

Browse Source
This commit is contained in:
Swarup Sengupta
2025-06-29 03:46:52 +05:30
parent 02fe2a0c63
commit 25e08e3bda
1 changed files with 29 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+29 -24
View File
@@ -7,7 +7,6 @@ This docker image runs the ConsoleClient from the [psiphon-tunnel-core](https://
> This build uses `docker buildx` plugin with `docker-container` driver. <br> > This build uses `docker buildx` plugin with `docker-container` driver. <br>
> Docker image available at [swarupsengupta2007/psiphon](https://hub.docker.com/r/swarupsengupta2007/psiphon "swarupsengupta2007/psiphon"). <br> > Docker image available at [swarupsengupta2007/psiphon](https://hub.docker.com/r/swarupsengupta2007/psiphon "swarupsengupta2007/psiphon"). <br>
> This is built on base image from [swarupsengupta2007/apine-s6-docker](https://github.com/swarupsengupta2007/alpine-s6-docker "swarupsengupta2007/apine-s6-docker")
```bash ```bash
# Clone this repo # Clone this repo
@@ -32,25 +31,16 @@ docker buildx build -t <your_tag> . --load
# If not already done, install the required cross-platform emulators # If not already done, install the required cross-platform emulators
docker run --privileged --rm tonistiigi/binfmt --install all docker run --privileged --rm tonistiigi/binfmt --install all
# build for multi-arch and push to registry # run the script, this will build the image for current platform and load it to docker
# optional, choose targets (defaults to the following list) ./make.bash --load
export TARGETS="linux/amd64,linux/386,linux/arm64,linux/arm/v7,linux/arm/v6"
# choose psiphon version (currently 2.0.32)
export PSIPHON_VERSION=2.0.32
# choose go version (currently 1.23.7)
export GO_VERSION=1.23.7
# run the script
./make.bash --push
``` ```
Build-args available Build-args available
|build-arg|Description| |build-arg|Description|Default|
|--|--| |--|--|--|
|VERSION|psiphon-tunnel-core release version| |VERSION|psiphon-tunnel-core release version|latest|
|TARGETS|\<BUIDLOS\>/\<BUILDARCH\> (Targets for cross-compilation for the build stage)| |TARGETS|\<BUIDLOS\>/\<BUILDARCH\> (Targets for cross-compilation for the build stage)|current platform|
|GO_VERSION|Go version to use for building the psiphon-tunnel-core binary|1.22.7|
--- ---
# Usage # Usage
@@ -65,6 +55,10 @@ services:
environment: environment:
- PUID=1000 - PUID=1000
- PGID=1000 - PGID=1000
- HTTP_PORT=8080
- SOCKS_PORT=1080
- DEVICE_REGION=IN
- EGRESS_REGION=SG
volumes: volumes:
- /path/to/psiphon/config:/config - /path/to/psiphon/config:/config
ports: ports:
@@ -80,19 +74,30 @@ docker run -d \
--restart=unless-stopped \ --restart=unless-stopped \
-p 8080:8080 \ -p 8080:8080 \
-p 1080:1080 \ -p 1080:1080 \
-e HTTP_PORT=8080 \
-e SOCKS_PORT=1080 \
-e DEVICE_REGION=IN \
-e EGRESS_REGION=SG \
-v /home/swarup/psiphon/config/:/config \ -v /home/swarup/psiphon/config/:/config \
swarupsengupta2007/psiphon swarupsengupta2007/psiphon
``` ```
The following Environment var are available<br> The following Environment var are available (only applicable when running for the first tome with no psiphon.config in the mounted config directory)<br>
|ENV variable|Description|Default| |ENV variable|Description|Default|
|--|--|--| |--|--|--|
|PUID|The UID for psiphon process|1000| |PUID|The UID for psiphon process|1000|
|PGID|The GID for psiphon process|1000| |PGID|The GID for psiphon process|1000|
|HTTP_PORT|The HTTP proxy port|8080|
|SOCKS_PORT|The SOCKS proxy port|1080|
|DEVICE_REGION|The device region for psiphon client|IN|
|EGRESS_REGION|The egress region for psiphon client|SG|
Following ports and volumes are available # Configuration
|Option|switch|Description|Default| The psiphon client configuration is stored in the mounted config directory. /config must be mounted and writable by the psiphon process. <br>
|--|--|--|--|
|HTTP PORT|-p <host_port>:8080|http proxy port|8080| # Healthcheck
|SOCKS PORT|-p <host_port>:1080|socks proxy port|1080| The container has a healthcheck script that checks if the psiphon client is running and healthy. <br>
|VOLUME|-v /path/to/config:/config|The container storage|/config| You can check the health status of the container using the following command:
```bash
docker inspect --format='{{json .State.Health}}' psiphon
```