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: 10 days 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 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-25T18:50:06.000Z (14 days ago)
• Last Synced: 2024-10-26T11:34:00.728Z (13 days ago)
• Topics: docker, linux, outline, outline-vpn, proxy-server, shadowsocks
• Language: TypeScript
• Homepage: https://getoutline.org/
• Size: 236 MB
• Stars: 5,813
• Watchers: 146
• Forks: 784
• Open Issues: 171
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-network-stuff - **3248**星

README

        
# Outline Server

![Build and Test](https://github.com/Jigsaw-Code/outline-server/actions/workflows/build_and_test_debug.yml/badge.svg?branch=master) [![Mattermost](https://badgen.net/badge/Mattermost/Outline%20Community/blue)](https://community.internetfreedomfestival.org/community/channels/outline-community) [![Reddit](https://badgen.net/badge/Reddit/r%2Foutlinevpn/orange)](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

   ```