mirror of https://github.com/OutlineFoundation/outline-server.git synced 2026-05-13 13:58:57 +00:00

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://getoutline.org/

docker linux outline outline-vpn proxy-server shadowsocks

Find a file

Vinicius Fortuna 6556d7e595 build: use Task (#1535 )		2024-04-17 19:48:23 -04:00
.github	build: use Task (#1535 )	2024-04-17 19:48:23 -04:00
docs	chore(docs): update `README` to reflect manager move (#1519 )	2024-03-12 15:09:01 -04:00
scripts	build: use Task (#1535 )	2024-04-17 19:48:23 -04:00
src	build: use Task (#1535 )	2024-04-17 19:48:23 -04:00
third_party	build: use Task (#1535 )	2024-04-17 19:48:23 -04:00
.browserslistrc	chore(devtools): non-build updates from client (#1103 )	2022-06-03 10:08:21 -04:00
.clang-format	import code	2018-03-14 17:52:39 -04:00
.dockerignore	Add .dockerignore	2018-05-30 23:35:11 -04:00
.editorconfig	Fix lint	2022-03-09 23:10:15 +00:00
.eslintignore	Add newlines	2022-03-10 17:10:36 +00:00
.eslintrc.json	feat(devtools): partial import restrictions (#1114 )	2022-06-23 17:52:30 -05:00
.gitallowed	Fix eslint annotations	2022-03-10 17:19:27 +00:00
.gitignore	build: use Task (#1535 )	2024-04-17 19:48:23 -04:00
.npmrc	Refactor	2022-05-13 11:58:52 -04:00
.nvmrc	chore: upgrade node to lts/hydrogen (#1365 )	2023-10-16 11:47:42 -04:00
.prettierignore	Add newline	2022-03-10 17:07:39 +00:00
.prettierrc.json	Rename Prettier config	2022-03-09 23:16:11 +00:00
.shellcheckrc	Migrate from Yarn to Node lts/gallium (#1004 )	2021-11-05 16:40:34 -04:00
commitlint.config.js	chore: delete manager and update server_manager/README.md (#1511 )	2024-02-22 13:16:40 -05:00
CONTRIBUTING.md	build: use Task (#1535 )	2024-04-17 19:48:23 -04:00
go.mod	build: use Task (#1535 )	2024-04-17 19:48:23 -04:00
go.sum	build: use Task (#1535 )	2024-04-17 19:48:23 -04:00
jasmine.json	Fix lint	2022-03-09 23:10:15 +00:00
LICENSE	import code	2018-03-14 17:52:39 -04:00
package-lock.json	chore(devtools): update @typescript-eslint/eslint-plugin dependency (#1534 )	2024-04-15 17:13:50 -04:00
package.json	build: use Task (#1535 )	2024-04-17 19:48:23 -04:00
README.md	build: use Task (#1535 )	2024-04-17 19:48:23 -04:00
Taskfile.yml	build: use Task (#1535 )	2024-04-17 19:48:23 -04:00
tools.go	build: use Task (#1535 )	2024-04-17 19:48:23 -04:00
tsconfig.json	chore: upgrade webpack to v5 to support lts/hydrogen (#1422 )	2023-10-11 10:44:36 -04:00

README.md

Outline Server

Outline Server is the component that provides the Shadowsocks service (via 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.

Components:

Outline Server (src/shadowbox): The core proxy server that runs and manages outline-ss-server, a Shadowsocks backend. It provides a REST API for access key management.
Metrics Server (src/metrics_server): A REST service for optional, anonymous metrics sharing.

Join the Outline Community by signing up for the 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.

Installation

Prerequisites

Node LTS (lts/hydrogen, version 18.16.0)
NPM (version 9.5.1)
Go 1.21+

Install dependencies
```
npm install
```
Start the server
```
./task shadowbox:start
```
Exploring further options:
- Refer to the README: Find additional configuration and usage options in the core server's README.
- Learn about the build system: For in-depth build system information, consult the contributing guide.
To clean up
```
./task clean
```