{"id":13389991,"url":"https://github.com/Jigsaw-Code/outline-server","last_synced_at":"2025-03-13T14:32:26.012Z","repository":{"id":37548129,"uuid":"125116575","full_name":"Jigsaw-Code/outline-server","owner":"Jigsaw-Code","description":"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.","archived":false,"fork":false,"pushed_at":"2025-03-10T18:25:19.000Z","size":248386,"stargazers_count":5911,"open_issues_count":159,"forks_count":796,"subscribers_count":146,"default_branch":"master","last_synced_at":"2025-03-11T19:10:33.675Z","etag":null,"topics":["docker","linux","outline","outline-vpn","proxy-server","shadowsocks"],"latest_commit_sha":null,"homepage":"https://getoutline.org/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jigsaw-Code.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-13T21:24:49.000Z","updated_at":"2025-03-10T18:25:23.000Z","dependencies_parsed_at":"2023-10-11T19:08:49.707Z","dependency_job_id":"a92da1b9-22d1-493f-b29a-531813427ba0","html_url":"https://github.com/Jigsaw-Code/outline-server","commit_stats":{"total_commits":1122,"total_committers":57,"mean_commits":19.68421052631579,"dds":0.6105169340463459,"last_synced_commit":"13151a4fc6ec940a41353c1589d5f115ad2051c9"},"previous_names":[],"tags_count":1088,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jigsaw-Code%2Foutline-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jigsaw-Code%2Foutline-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jigsaw-Code%2Foutline-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jigsaw-Code%2Foutline-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jigsaw-Code","download_url":"https://codeload.github.com/Jigsaw-Code/outline-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243422713,"owners_count":20288507,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","linux","outline","outline-vpn","proxy-server","shadowsocks"],"created_at":"2024-07-30T13:01:44.479Z","updated_at":"2025-03-13T14:32:20.990Z","avatar_url":"https://github.com/Jigsaw-Code.png","language":"TypeScript","readme":"# Outline Server\n\n![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/)\n\nOutline 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/).\n\n**Components:**\n\n- **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.\n\n- **Metrics Server** ([`src/metrics_server`](src/metrics_server)): A REST service for optional, anonymous metrics sharing.\n\n**Join the Outline Community** by signing up for the [IFF Mattermost](https://wiki.digitalrights.community/index.php?title=IFF_Mattermost)!\n\n## Shadowsocks and Anti-Censorship\n\nOutline's use of Shadowsocks means it benefits from ongoing improvements that strengthen its resistance against detection and blocking.\n\n**Key Protections:**\n\n- **AEAD ciphers** are mandatory.\n- **Probing resistance** mitigates detection techniques.\n- **Protection against replayed data.**\n- **Variable packet sizes** to hinder identification.\n\nSee [Shadowsocks resistance against detection and blocking](docs/shadowsocks.md).\n\n## Installation\n\n**Prerequisites**\n\n- [Node](https://nodejs.org/en/download/) LTS (`lts/hydrogen`, version `18.16.0`)\n- [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) (version `9.5.1`)\n- [Go](https://go.dev/dl/) 1.21+\n\n1. **Install dependencies**\n\n   ```sh\n   npm install\n   ```\n\n1. **Start the server**\n\n   ```sh\n   ./task shadowbox:start\n   ```\n\n   Exploring further options:\n\n   - **Refer to the README:** Find additional configuration and usage options in the core server's [`README`](src/shadowbox/README.md).\n   - **Learn about the build system:** For in-depth build system information, consult the [contributing guide](CONTRIBUTING.md).\n\n1. **To clean up**\n\n   ```sh\n   ./task clean\n   ```\n","funding_links":[],"categories":["TypeScript","TypeScript (19)","TypeScript (64)","HarmonyOS","electron","Tools"],"sub_categories":["Windows Manager","Provisioning"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJigsaw-Code%2Foutline-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJigsaw-Code%2Foutline-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJigsaw-Code%2Foutline-server/lists"}