{"id":13775755,"url":"https://github.com/uwnetworkslab/uproxy-p2p","last_synced_at":"2026-03-12T07:35:05.018Z","repository":{"id":15794032,"uuid":"18533350","full_name":"UWNetworksLab/uProxy-p2p","owner":"UWNetworksLab","description":"Internet without borders","archived":false,"fork":false,"pushed_at":"2022-12-06T21:00:42.000Z","size":22947,"stargazers_count":866,"open_issues_count":89,"forks_count":184,"subscribers_count":105,"default_branch":"master","last_synced_at":"2025-04-18T06:42:34.121Z","etag":null,"topics":["browser-extension","peer-to-peer","proxy-server","university-of-washington","webrtc"],"latest_commit_sha":null,"homepage":"https://www.uproxy.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/UWNetworksLab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-04-07T20:34:40.000Z","updated_at":"2025-02-20T09:18:10.000Z","dependencies_parsed_at":"2023-01-11T20:24:01.000Z","dependency_job_id":null,"html_url":"https://github.com/UWNetworksLab/uProxy-p2p","commit_stats":null,"previous_names":[],"tags_count":79,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UWNetworksLab%2FuProxy-p2p","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UWNetworksLab%2FuProxy-p2p/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UWNetworksLab%2FuProxy-p2p/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UWNetworksLab%2FuProxy-p2p/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UWNetworksLab","download_url":"https://codeload.github.com/UWNetworksLab/uProxy-p2p/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253540301,"owners_count":21924521,"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":["browser-extension","peer-to-peer","proxy-server","university-of-washington","webrtc"],"created_at":"2024-08-03T17:01:48.351Z","updated_at":"2025-12-17T17:09:52.888Z","avatar_url":"https://github.com/UWNetworksLab.png","language":"TypeScript","funding_links":[],"categories":["\u003ca id=\"d03d494700077f6a65092985c06bf8e8\"\u003e\u003c/a\u003e工具"],"sub_categories":["\u003ca id=\"0ff94312f3ab4898f5996725133ea9d1\"\u003e\u003c/a\u003e未分类"],"readme":"# uProxy\n\n[uProxy](https://www.uproxy.org) is a browser extension that lets users share their internet connection.\n\n## Status\n\n[![Slack Status](https://uproxy-slack.herokuapp.com/badge.svg)](https://uproxy-slack.herokuapp.com/)\n[![Travis Status](https://travis-ci.org/uProxy/uproxy.svg?branch=dev)](https://travis-ci.org/uProxy/uproxy)\n\nPlease read the [uProxy Coding Guide](https://docs.google.com/document/d/12RfgwSLnEm-X5Knj1xFVGpp-MH7BdWjuzzo_g7xabro/edit) to learn more about contributing to uProxy. For a high level technical overview of uProxy, see the [uProxy Design Doc](https://docs.google.com/document/d/1t_30vX7RcrEGuWwcg0Jub-HiNI0Ko3kBOyqXgrQN3Kw/edit#).\n\n## Tools\n\nuProxy is built using the following tools:\n - [Grunt](http://gruntjs.com/) to write the tasks that build uProxy\n - [TypeScript](http://www.typescriptlang.org/) as the primary language we code in; this compiles to JavaScript. It gives us type-checking and has some syntax improvements on JS, while letting us incrementally migrate and easily include external JS packages and frameworks.\n - [Jasmine](http://jasmine.github.io/) for testing\n - [Polymer](http://www.polymer-project.org/) for UI\n - [Travis](https://travis-ci.org/) for continuous integration\n\nTo manage dependencies we use:\n - [npm](https://www.npmjs.org/) to install node modules that we use for our build process.  (Specified in `package.json`)\n - [Bower](http://bower.io) to install libraries that we use in the UI\n   (specified in `bower.json`) including Polymer.\n\n## Build\n\n### Prerequisites\n\n * [Yarn](https://yarnpkg.com/en/docs/install). If you have npm, you can install with `npm install -g --production yarn`.\n * [grunt-cli](https://www.npmjs.com/package/grunt-cli) (once you've installed NPM, simply execute `yarn global add --prod grunt-cli`)\n\n### Building\n\nFirst, to install required NPMs and configure the `build/` directory for TypeScript compilation, execute:\n```bash\nyarn\n```\n\nThen, to compile the TypeScript code and build uProxy and all of the demo apps, execute:\n```bash\ngrunt\n```\n\nHaving problems? To clean up from a partial, broken, or extremely out-dated build, try executing this command before repeating the above steps:\n```bash\nyarn run clean\n```\n\n### IDE\n\n[Visual Studio Code](https://code.visualstudio.com/) supports TypeScript compilation, search, and refactoring out of the box - just point it at the directory containing your uProxy clone.\n\n\n## Run\n\n### uProxy\n\n#### Chrome\n\nThese are the steps to try uProxy in the Chrome browser.\n\n- In Chrome, go to `chrome://extensions`, make sure 'Developer mode' is enabled\n- Click 'Load unpacked extension...' and select `build/src/chrome/app`\n- Click 'Load unpacked extension...' and select `build/src/chrome/extension`\n\nYou need both the uProxy Chrome App and the uProxy Extension.\n\nYou can use `grunt build_chrome` from the root directory of the repository to re-compile just Chrome components.\n\n#### Firefox\n\nThese are the steps to try uProxy in the Firefox browser.\n\n- To run the add-on you need to have the Firefox add-on SDK installed.\nInstructions can be found here: https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Installation\n    - A quick way to get started is to download/extract the zip mentioned in \"Prerequisites\"\n\n- Run `cd build/src/firefox`\n\n- Run `cfx run` and Firefox should launch with the uProxy add-on installed\n\nYou can use `grunt build_firefox` from the root directory of the repository to compile just Firefox comonents.\n\n### Demo apps\n\nThese can be found at `build/src/samples/`. They are a mix of web sites, browser extensions (Chrome and Firefox), and Node.js apps.\n\nTo run web apps:\n * start a webserver, e.g. `python -m SimpleHTTPServer`\n * open the relevant HTML file in your browser, e.g. http://localhost:8000/build/src/samples/simple-freedom-chat/main.html.\n\nTo run Chrome apps:\n - open `chrome://extensions`, enable check Developer Mode, and load the unpacked extension from the relevant directory, e.g. `build/src/samples/simple-socks-chromeapp/`.\n\nTo run Firefox add-ons:\n- install [jpm](https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/jpm) via NPM, e.g. `yarn install jpm -g`, `cd` to the relevant directory, e.g. `build/src/samples/simple-socks-firefoxapp/`, and execute ``jpm run -b `which firefox` ``.\n\nTo run Node.js apps:\n - Directly run `node` with the entry point, e.g. `node build/src/samples/zork-node/index.js`\n\n**Note: until freedom-for-node supports core.rtcpeerconnection, this sample will not work**\n\nMore on the demo apps themselves:\n\n * **simple-freedom-chat** is a WebRTC-powered chat client, with both peers on the same page. This is the simplest possible demo `src/peerconnection`.\n * **copypaste-freedom-chat** is the simplest possible, distributed, `src/peerconnection` demo in which text boxes\nact as the signalling channel between two peers. Messages can be exchanged by\nemail, IM, shared doc, etc.\n * **echo-server** starts a TCP echo server on port 9998. Run `telnet 127.0.0.1 9998` and then\ntype some stuff to verify that echo server echoes what you send it. Press ctrl-D to have the echo server terminate the connection or press `ctrl-]` then type `quit` to exit telnet.\n * **Simple SOCKS** is the simplest possible, single-page, demo of the SOCKS proxy (`socks-to-rtc` and\n`rtc-to-net` directories). This command may be used to test the proxy: `curl -x socks5h://localhost:9999 www.example.com` (`-h` indicates that DNS requests are made through the proxy too)\n * **Zork** is a distributed SOCKS proxy with a telnet-based signalling channel, intended for use with [our Docker-based integration testing](https://github.com/uProxy/uproxy-docker). Try connecting to Zork with `telnet localhost 9000`.\n * **uProbe** guess-timates your NAT type.\n * **simple-churn-chat** is just like simple-freedom-chat, except WebRTC traffic between the two peers is obfuscated. Wireshark may be used to verify that the traffic is obfuscated; the endpoints in use - along with a lot of debugging information - may be determined by examining the Javascript console.\n * **copypaste-freedom-chat** is just like copypaste-fredom-chat, except WebRTC traffic between the two peers is obfuscated.\n\n### Development and re-building uProxy\n\nuProxy uses the Grunt build system for its build tasks. Here is a list\nof uProxy's Grunt commands:\n\n *  `build` - Builds everything, making stuff in the `build` directory (and runs tests).\n   *  `build_chrome` - Build Chrome app and extension\n     *  `build_chrome_app` - Build just Chrome app\n     *  `build_chrome_ext` - Build just Chrome extension\n   *  `build_firefox` - Build just Firefox\n *  `dist` - Generates distribution files, including the Firefox xpi\n *  `clean` - Cleans up\n *  `test` - Run unit tests\n *  `integration_test` - Run integration tests\n *  `everything` - 'build', 'test' and then 'integration_test'\n\nThe easiest way to stay current is to pull changes, run `grunt build` to build\nyour distribution, and re-run as you make changes to the files.\n\nBefore submitting any changes to the repository, make sure to run `grunt test`\nto make sure it passes all unit tests. Failing tests are enough to immediately\nreject submissions. :)\n\n## uProxy for Mobile\n\nThe development for mobile platforms uses the Cordova Chrome Apps (CCA) tool, also known as the [Chrome Apps for Mobile Toolchain](https://github.com/MobileChromeApps/mobile-chrome-apps). You can find the platform-specific information below:\n\n* [Android Development](https://github.com/uProxy/uproxy/wiki/Android-Development)\n\n## Layout of files\n\nConfiguration and setup files\n * `Gruntfile.js` a file that specifies common tasks, e.g. how to build and package uProxy.\n * `bower.json` specifies dependent libraries from Bower.\n * `package.json` specifies dependent libraries from NPM.\n * `.gitignore` what git should ignore\n * `.bowerrc` tells bower where to put files\n * `.travis.yml` Travis auto-testing\n * `tools` directory contains some typescript and javascript to help Grunt.\n * `third_party/tsd.json` specifies the typescript definitions to use\n\nSource code\n * `src` holds all source code; no compiled files\n * `src/generic_ui` generic user interface code\n * `src/generic_core` generic uproxy core-functionality code\n * `src/chrome/app` code specific to the chrome app\n * `src/chrome/extension` code specific to the chrome extension\n * `src/firefox` code specific to firefox\n * `third_party` holds external libraries we depend on that are copied into this repository\n * `node_modules` dynamically generated npm module dependencies\n * `scraps` temporary holding for sharing scraps of code\n\nDynamically created directories (`grunt clean` should remove them)\n * `build` created by grunt tasks; holds the built code, but none of the code that was compiled.\n * `build/dist` created by grunt tasks; holds final distribution versions\n * `.grunt` holds grunt cache stuff\n * `.tscache` holds typescript cache stuff\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuwnetworkslab%2Fuproxy-p2p","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuwnetworkslab%2Fuproxy-p2p","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuwnetworkslab%2Fuproxy-p2p/lists"}