Skip to content

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.



Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit

…build code at buildtime (#1626)

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* close

* closer

* electron

* wip

* wip

* wip

* wip

* wip

* fix

* Update src/build/get_build_environment.mjs

Co-authored-by: Vinicius Fortuna <>

* feedback

* set to 1

* remove verbose

* ignore this lmao

* okay

* fix android

* cleanup xml

* Update src/cordova/build.action.mjs

Co-authored-by: Vinicius Fortuna <>

* Update src/cordova/setup.action.mjs

Co-authored-by: Vinicius Fortuna <>

* Update src/electron/build_main.action.mjs

Co-authored-by: Vinicius Fortuna <>

* feedback

* remove

* try this

* string -> number

* remove publish

* translation edits

* rm build number

* no publish if no url

* Delete zh.json

* typo


Co-authored-by: Vinicius Fortuna <>

Git stats


Failed to load latest commit information.
Latest commit message
Commit time
December 15, 2022 16:49
March 15, 2018 17:05
March 15, 2018 17:05

Outline Client

Build and Test Mattermost Reddit

Test coverage currently only tracks the Apple Libraries and core web view code:


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.

The client's user interface is implemented in Polymer 2.0. Platform support is provided by Cordova and Electron, with additional native components in this repository.

To join our Outline Community, sign up for the IFF Mattermost.

Requirements for all builds

All builds require Node 18 (lts/hydrogen), in addition to other per-platform requirements.

💡 NOTE: if you have nvm installed, run nvm use to switch to the correct node version!

After cloning this repo, install all node dependencies:

npm install

Building the shared web app

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.

The app logic is located in src/www/app. UI components are located in src/www/ui_components. If you want to work specifically on an individual UI element, try the storybook!:

npm run action src/www/storybook

💡 NOTE: the src part of the path is optional. npm run action www/start resolves to the same script.

💡 NOTE: every script in this repository can be run with npm run action - for a CLI-like experience, add something like

alias outline="npm run action"

(you can call it whatever you like)

to your shell, then try outline www/start!

Life of a Packet

How does the Outline Client work?

Accepting a server invite

Looking for instructions on how to accept a server invite?

Platform-specific development

Each platform is handled differently:

  1. Developing for Apple (MacOS and iOS)
  2. Developing for Android
  3. Developing for Electron (Windows and Linux)

Error reporting

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: