79 lines
2.2 KiB
Markdown
79 lines
2.2 KiB
Markdown
|
|
# Psiphon Docker
|
|
Docker image for Psiphon
|
|
|
|
Psiphon is an Internet censorship circumvention system. <br>
|
|
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.
|
|
|
|
```bash
|
|
# Clone this repo
|
|
git clone https://github.com/swarupsengupta2007/psiphon-docker
|
|
```
|
|
|
|
# Building<br>
|
|
|
|
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
|
|
```bash
|
|
# choose target platforms
|
|
TARGETS="linux/amd64,linux/386,linux/arm64,linux/arm"
|
|
|
|
# Create a builder instance
|
|
sudo docker buildx create --name cross-platform --platform ${TARGETS} --use
|
|
|
|
# Build for current platform and load to docker image
|
|
sudo docker buildx build -t <your_username>/<your_tag> . --load
|
|
|
|
# Build for multi-arch and push to registry
|
|
sudo docker buildx build --build-arg TARGETS=${TARGETS} -t <your_username>/<your_tag> \
|
|
--platform ${TARGETS} . --push
|
|
```
|
|
|
|
> To change the version of the psiphon add --build-arg VERSION=<version_no><br>
|
|
e.g.
|
|
```bash
|
|
# to build v2.0.22
|
|
sudo docker buildx build --build-arg VERSION=2.0.22 -t <your_username>/<your_tag> . --load
|
|
```
|
|
|
|
# Usage
|
|
|
|
## Using docker-compose (recommended) <br>
|
|
```yaml
|
|
version: "3.5"
|
|
services:
|
|
psiphon:
|
|
image: swarupsengupta2007/psiphon:latest
|
|
container_name: psiphon
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
volumes:
|
|
- /path/to/psiphon/config:/config
|
|
ports:
|
|
- 1080:1080
|
|
- 8080:8080
|
|
restart: unless-stopped
|
|
```
|
|
|
|
## Using docker-cli <br>
|
|
```bash
|
|
sudo docker run --name psiphon -d -p 8080:8080 -p 1080:1080 -v /home/swarup/psiphon/config/:/config swarupsengupta2007/psiphon
|
|
```
|
|
|
|
The following Environment var are available<br>
|
|
|ENV variable|Description|Default|
|
|
|--|--|--|
|
|
|PUID|The UID for psiphon process|1000|
|
|
|PGID|The GID for psiphon process|1000|
|
|
|
|
Following ports and volumes are available
|
|
|Option|switch|Description|Default|
|
|
|--|--|--|--|
|
|
|HTTP PORT|-p host_port:8080|http proxy port|8080|
|
|
|SOCKS PORT|-p host_port:1080|socks proxy port|1080|
|
|
|VOLUME|-v /path/to/config:/config|The container storage|/config|
|