CERBERUS/outline-server
1
0
Fork 0
mirror of https://github.com/OutlineFoundation/outline-server.git synced 2026-05-13 05:52:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
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/
1427 commits 95 branches 1102 tags 300 MiB
Find a file
Sander Bruens 845c02373b
feat(server): add ASN metric to opt-in server usage report (#1610) 
* feat(server): add ASN metric to opt-in server usage report

* Rename `LocationUsage` to `ReportedUsage`.

* Add test cases for different ASN+country combinations.
2024-10-17 13:05:30 -04:00
.github clean: add missing license headers and add a CI check (#1572) 2024-08-12 10:56:11 -04:00
docs chore: update shadowsocks.md (#1592) 2024-09-10 15:01:13 -04:00
scripts build: use Task (#1535) 2024-04-17 19:48:23 -04:00
src feat(server): add ASN metric to opt-in server usage report (#1610) 2024-10-17 13:05:30 -04:00
third_party clean(devtools/build): remove unused jsign files (#1569) 2024-07-30 09:52:30 -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 chore: add lint rule to prevent unnecessary public modifiers (#1557) 2024-07-23 14:28:57 -04:00
.gitallowed Fix eslint annotations 2022-03-10 17:19:27 +00:00
.gitignore Remove Makefile (#1540) 2024-04-19 10:50:43 -06: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 clean: add missing license headers and add a CI check (#1572) 2024-08-12 10:56:11 -04:00
CONTRIBUTING.md build: use Task (#1535) 2024-04-17 19:48:23 -04:00
go.mod chore(server): update outline-ss-server dependency to version 1.7.3 (#1604) 2024-10-03 11:44:05 -04:00
go.sum chore(server): update outline-ss-server dependency to version 1.7.3 (#1604) 2024-10-03 11:44:05 -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: update outline-ss-server dependency to latest version (#1593) 2024-09-19 11:37:41 -04:00
package.json chore: update outline-ss-server dependency to latest version (#1593) 2024-09-19 11:37:41 -04:00
README.md build: use Task (#1535) 2024-04-17 19:48:23 -04:00
Taskfile.yml clean: add missing license headers and add a CI check (#1572) 2024-08-12 10:56:11 -04:00
tools.go clean: add missing license headers and add a CI check (#1572) 2024-08-12 10:56:11 -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

Build and Test Mattermost Reddit

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+

  1. Install dependencies

    npm install

  2. 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.

  3. To clean up

    ./task clean