UProxy

uProxy is a browser extension that lets users share their internet connection. Please read the uProxy Coding Guide to learn more about contributing to uProxy. For a high level technical overview of uProxy, see the uProxy Design Doc. uProxy is built using the following tools: Grunt to write the tasks that build uProxy TypeScript 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. Jasmine for testing Polymer for UI Travis for continuous integration Yarn. If you have npm, you can install with npm install -g --production yarn . grunt-cli (once you've installed NPM, simply execute yarn global add --prod grunt-cli ) Having problems? To clean up from a partial, broken, or extremely out-dated build, try executing this command before repeating the above steps: These are the steps to try uProxy in the Chrome browser. In Chrome, go to chrome://extensions , make sure 'Developer mode' is enabled Click 'Load unpacked extension...' and select build/src/chrome/app Click 'Load unpacked extension...' and select build/src/chrome/extension You can use grunt build chrome from the root directory of the repository to re-compile just Chrome components. These are the steps to try uProxy in the Firefox browser. To run the add-on you need to have the Firefox add-on SDK installed. Instructions can be found here: A quick way to get started is to download/extract the zip mentioned in "Prerequisites" Run cd build/src/firefox Run cfx run and Firefox should launch with the uProxy add-on installed You can use grunt build firefox from the root directory of the repository to compile just Firefox comonents. These can be found at build/src/samples/ . They are a mix of web sites, browser extensions (Chrome and Firefox), and Node.js apps. To run Chrome apps: open chrome://extensions , enable check Developer Mode, and load the unpacked extension from the relevant directory, e.g. build/src/samples/simple-socks-chromeapp/ . To run Node.js apps: Directly run node with the entry point, e.g. node build/src/samples/zork-node/index.js simple-freedom-chat is a WebRTC-powered chat client, with both peers on the same page. This is the simplest possible demo src/peerconnection . copypaste-freedom-chat is the simplest possible, distributed, src/peerconnection demo in which text boxes act as the signalling channel between two peers. Messages can be exchanged by email, IM, shared doc, etc. echo-server starts a TCP echo server on port 9998. Run telnet 127.0.0.1 9998 and then type 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. Simple SOCKS is the simplest possible, single-page, demo of the SOCKS proxy ( socks-to-rtc and 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) Zork is a distributed SOCKS proxy with a telnet-based signalling channel, intended for use with our Docker-based integration testing. Try connecting to Zork with telnet localhost 9000 . uProbe guess-timates your NAT type. 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. copypaste-freedom-chat is just like copypaste-fredom-chat, except WebRTC traffic between the two peers is obfuscated. uProxy uses the Grunt build system for its build tasks. Here is a list of uProxy's Grunt commands: build - Builds everything, making stuff in the build directory (and runs tests). build chrome - Build Chrome app and extension build chrome app - Build just