The Outline Client is a cross-platform VPN or proxy client for Windows, macOS, iOS, Android, and ChromeOS. The Outline Client is designed for use with the Outline Server software, but it is fully compatible with any Shadowsocks server that has UDP support enabled.
Requirements for all builds
All builds require yarn, in addition to other per-platform requirements. After cloning this repo, you should run "yarn" to install all dependencies.
Building the web app
Outline clients shares the same web app across all platforms. This code is located in the www directory. If you are making changes to the shared web app and do not need to test platform-specific functionality, you can test in a desktop browser by running:
yarn gulp build --platform=browser --watch
This command will automatically rebuild after any typescript file in the www directory changes, however it will need to be re-run to pick up other file changes.
Browser platform development will use fake servers to test successful and unsuccessful connections.
Building the Android app
Additional requirements for Android:
- Android Studio
- Android SDK 26
To build for android, run:
yarn gulp build --platform=android
To rebuild after modifying platform dependent files, run:
yarn cordova platform rm android && yarn gulp build --platform=android
If this gives you unexpected Cordova errors, run:
yarn run clean && yarn && yarn gulp build --platform=android
Cordova will generate a new Android project in the platforms/android directory. Install the built apk by platforms/android/build/outputs/apk/android-armv7-debug.apk
To learn more about developing for Android, see docs/android-development.
Building for Android with Docker
A Docker image with all pre-requisites for Android builds is included. To build:
- Install dependencies with
- Then build with
./tools/build/build.sh yarn gulp build --platform=android
Apple (macOS and iOS)
Additional requirements for Apple:
- An Apple Developer Account. You will need to be invited to join the "Jigsaw Operations LLC" team
- XCode 9+ (download)
- XCode command line tools
To build for macOS (OS X), run:
yarn run clean && yarn && yarn gulp build --platform=osx
To build for iOS, run:
yarn run clean && yarn && yarn gulp build --platform=ios
To learn more about developing for Apple, see docs/apple-development
Additional requirements for building on Windows:
- Cygwin. It provides the "missing Unix pieces" required by build system such as rsync (and many others)
To build for Windows, run:
yarn do src/electron/build
Unlike the Android and Apple clients, the Windows build uses the Electron framework, rather than Cordova.