diff --git a/README.md b/README.md index fc27ea5..0b91dbf 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ Docker image for Psiphon Psiphon is an Internet censorship circumvention system.
-This docker image runs the ConsoleClient from the [psiphon-tunnel-core](https://github.com/Psiphon-Labs/psiphon-tunnel-core "psiphon-tunnel-core"). +This Docker image runs the ConsoleClient from the [psiphon-tunnel-core](https://github.com/Psiphon-Labs/psiphon-tunnel-core "psiphon-tunnel-core"). -> This build uses `docker buildx` plugin with `docker-container` driver.
+> This build uses the `docker buildx` plugin with the `docker-container` driver.
> Docker image available at [swarupsengupta2007/psiphon](https://hub.docker.com/r/swarupsengupta2007/psiphon "swarupsengupta2007/psiphon").
```bash @@ -15,9 +15,9 @@ git clone https://github.com/swarupsengupta2007/psiphon-docker # Building
-1. Ensure buildx is enabled for docker +1. Ensure buildx is enabled for Docker 2. Create a builder instance for multi-arch -3. Build docker image for current platform or multi-arch +3. Build Docker image for current platform or multi-arch ```bash # choose target platforms TARGETS="linux/amd64,linux/386,linux/arm64,linux/arm/v7,linux/arm/v6" @@ -25,13 +25,13 @@ TARGETS="linux/amd64,linux/386,linux/arm64,linux/arm/v7,linux/arm/v6" # Create a builder instance if it doesn't exist docker buildx create --name cross-platform --platform ${TARGETS} --use -# Build for current platform and load to docker image +# Build for the current platform and load to Docker image docker buildx build -t . --load # If not already done, install the required cross-platform emulators docker run --privileged --rm tonistiigi/binfmt --install all -# run the script, this will build the image for current platform and load it to docker +# run the script, this will build the image for the current platform and load it to Docker ./make.bash --load ``` @@ -82,21 +82,21 @@ docker run -d \ swarupsengupta2007/psiphon ``` -The following Environment var are available (only applicable when running for the first tome with no psiphon.config in the mounted config directory)
+The following Environment var are available (only applicable when running for the first time with no psiphon.config in the mounted config directory)
|ENV variable|Description|Default| |--|--|--| |PUID|The UID 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| +|DEVICE_REGION|The device region for Psiphon client|IN| +|EGRESS_REGION|The egress region for Psiphon client|SG| # Configuration -The psiphon client configuration is stored in the mounted config directory. /config must be mounted and writable by the psiphon process.
+The Psiphon client configuration is stored in the mounted config directory. /config must be mounted and writable by the psiphon process.
# Healthcheck -The container has a healthcheck script that checks if the psiphon client is running and healthy.
+The container has a healthcheck script that checks if the Psiphon client is running and healthy.
You can check the health status of the container using the following command: ```bash docker inspect --format='{{json .State.Health}}' psiphon