Outline clients, developed by Jigsaw. The Outline clients use the popular Shadowsocks protocol, and lean on the Cordova and Electron frameworks to support Windows, Android / ChromeOS, Linux, iOS and macOS.
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.
All builds require Node 16 (lts/gallium), in addition to other per-platform requirements.
💡 NOTE: if you have
nvm useto switch to the correct node version!
After cloning this repo, install all node dependencies:
Outline clients share the same web app across all platforms. This code is located in the src/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:
npm run action src/www/start
The latter command will open a browser instance running the app. Browser platform development will use fake servers to test successful and unsuccessful connections.
npm run action src/www/storybook
Each platform is handled differently:
To enable error reporting through Sentry for local builds, run:
export SENTRY_DSN=[Sentry development API key] [platform-specific build command]
Release builds on CI are configured with a production Sentry API key.
For support and to contact us, see: https://support.getoutline.org.