README ¶
Psiphon Client Library README
Mobile
If you are planning to embed Psiphon in a mobile application, please use the MobileLibrary.
Usage
If you are using the Library in your app, please read the USAGE.md instructions.
Building for Darwin (iOS, MacOS)
Note that you will need to have Xcode installed on a machine running MacOS.
Ensure that the command below is run from within the ClientLibrary
directory
./build-darwin.sh all
This command can also be modified by:
- replacing
all
withios
ormacos
as the first parameter tobuild-darwin.sh
(as in./build-darwin.sh ios
) to only build binaries for the operating system of choice
When that command completes, the compiled binaries will be located in the build
directory. The structure will be:
build
└── darwin
└── ios
│ └── PsiphonTunnel-ios-arm.h
│ └── PsiphonTunnel-ios-arm.dylib
│ └── PsiphonTunnel-ios-arm64.h
│ └── PsiphonTunnel-ios-arm64.dylib
└── macos
└── PsiphonTunnel-macos-386.dylib
└── PsiphonTunnel-macos-386.dylib
└── PsiphonTunnel-macos-amd64.dylib
└── PsiphonTunnel-macos-amd64.dylib
Building with Docker (Android, Linux, Windows)
Note that you may need to use sudo docker
below, depending on your OS.
-
While in the
ClientLibrary
directory, run the command:docker build --no-cache=true -t psiclientlibrary-builder .
-
Once completed, verify that you see an image named
psiclientlibrary-builder
when running:docker images
Ensure that the command below is run from within the ClientLibrary
directory
cd .. && \
docker run \
--rm \
-v $PWD:/go/src/github.com/Psiphon-Labs/psiphon-tunnel-core \
psiclientlibrary-builder \
/bin/bash -c './make.bash all' \
; cd -
This command can also be modified by:
- replacing
all
withandroid
,linux
, orwindows
as the first parameter tomake.bash
(as in./make.bash windows
) to only build binaries for the operating system of choice
When that command completes, the compiled binaries will be located in the build
directory (./build
, and everything under it will likely be owned by root, so be sure to chown
to an appropriate user) under the current directory. The structure will be:
build
├── android
│ └── PsiphonTunnel-android-arm7.h
│ └── PsiphonTunnel-android-arm7.so
│ └── PsiphonTunnel-android-arm64.h
│ └── PsiphonTunnel-android-arm64.so
├── linux
│ └── PsiphonTunnel-linux-386.h
│ └── PsiphonTunnel-linux-386.so
│ └── PsiphonTunnel-linux-amd64.h
│ └── PsiphonTunnel-linux-amd64.so
└── windows
└── PsiphonTunnel-windows-386.h
└── PsiphonTunnel-windows-386.dll
└── PsiphonTunnel-windows-amd64.h
└── PsiphonTunnel-windows-amd64.dll
Documentation ¶
There is no documentation for this package.