https://github.com/Jigsaw-Code/outline-server
Outline Server, developed by Jigsaw. The Outline Server is a proxy server that runs a Shadowsocks instance and provides a REST API for access key management.
https://github.com/Jigsaw-Code/outline-server
docker linux outline outline-vpn proxy-server shadowsocks
Last synced: 7 months ago
JSON representation
Outline Server, developed by Jigsaw. The Outline Server is a proxy server that runs a Shadowsocks instance and provides a REST API for access key management.
- Host: GitHub
- URL: https://github.com/Jigsaw-Code/outline-server
- Owner: Jigsaw-Code
- License: apache-2.0
- Created: 2018-03-13T21:24:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-10T18:25:19.000Z (7 months ago)
- Last Synced: 2025-03-11T19:10:33.675Z (7 months ago)
- Topics: docker, linux, outline, outline-vpn, proxy-server, shadowsocks
- Language: TypeScript
- Homepage: https://getoutline.org/
- Size: 237 MB
- Stars: 5,911
- Watchers: 146
- Forks: 796
- Open Issues: 159
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome - Jigsaw-Code/outline-server - Outline Server, developed by Jigsaw. The Outline Server is a proxy server that runs a Shadowsocks instance and provides a REST API for access key management. (TypeScript)
- awesome-hacking-lists - Jigsaw-Code/outline-server - Outline Server, developed by Jigsaw. The Outline Server is a proxy server that runs a Shadowsocks instance and provides a REST API for access key management. (TypeScript)
- my-awesome - Jigsaw-Code/outline-server - vpn,proxy-server,shadowsocks pushed_at:2025-08 star:6.1k fork:0.9k Outline Server, developed by Jigsaw. The Outline Server is a proxy server that runs a Shadowsocks instance and provides a REST API for access key management. (TypeScript)
- awesome-starred - Jigsaw-Code/outline-server - Outline Manager, developed by Jigsaw. The Outline Manager application creates and manages Outline servers, powered by Shadowsocks. It uses the Electron framework to offer support for Windows, macOS an (linux)
README
# Outline Server
 [](https://community.internetfreedomfestival.org/community/channels/outline-community) [](https://www.reddit.com/r/outlinevpn/)
Outline Server is the component that provides the Shadowsocks service (via [outline-ss-server](https://github.com/Jigsaw-Code/outline-ss-server/)) and a service management API. You can deploy this server directly following simple instructions in this repository, or if you prefer a ready-to-use graphical interface you can use the [Outline Manager](https://github.com/Jigsaw-Code/outline-apps/).
**Components:**
- **Outline Server** ([`src/shadowbox`](src/shadowbox)): The core proxy server that runs and manages [outline-ss-server](https://github.com/Jigsaw-Code/outline-ss-server/), a Shadowsocks backend. It provides a REST API for access key management.
- **Metrics Server** ([`src/metrics_server`](src/metrics_server)): A REST service for optional, anonymous metrics sharing.
**Join the Outline Community** by signing up for the [IFF Mattermost](https://wiki.digitalrights.community/index.php?title=IFF_Mattermost)!
## Shadowsocks and Anti-Censorship
Outline's use of Shadowsocks means it benefits from ongoing improvements that strengthen its resistance against detection and blocking.
**Key Protections:**
- **AEAD ciphers** are mandatory.
- **Probing resistance** mitigates detection techniques.
- **Protection against replayed data.**
- **Variable packet sizes** to hinder identification.
See [Shadowsocks resistance against detection and blocking](docs/shadowsocks.md).
## Installation
**Prerequisites**
- [Node](https://nodejs.org/en/download/) LTS (`lts/hydrogen`, version `18.16.0`)
- [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) (version `9.5.1`)
- [Go](https://go.dev/dl/) 1.21+
1. **Install dependencies**
```sh
npm install
```
1. **Start the server**
```sh
./task shadowbox:start
```
Exploring further options:
- **Refer to the README:** Find additional configuration and usage options in the core server's [`README`](src/shadowbox/README.md).
- **Learn about the build system:** For in-depth build system information, consult the [contributing guide](CONTRIBUTING.md).
1. **To clean up**
```sh
./task clean
```