Share your pathway to the Internet
Pull request Compare This branch is 5614 commits behind UWNetworksLab:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
editor_support/sublime_text
scraps
src
third_party
tools
.bowerrc
.gitignore
.travis.yml
CONTRIBUTING.md
Gruntfile.coffee
LICENSE.md
README.md
bower.json
package.json
tsd.json

README.md

uProxy

uProxy is a browser extension that lets users share their internet connection.

Build Status

Dev: Build Status Master: Build Status

Tools

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

To manage dependencies we use:

  • npm for installing node modules that we use for our build process. (Specified in package.json)
  • Bower to install libraries that we use in the UI (specified in bower.json) including AngularJS.

Development setup

Pre-Requirements to build uProxy

Note: you will either need to run these as root, or set the directories they modify (/usr/local) to being editable by your user (sudo chown -R $USER /usr/local)

  • node and the Node Package Manaager (NPM):

    • On Mac with Brew, you can do: brew install node (You may need to update you brew package manager, e.g. brew update). You can also install directly from a Mac package off the NodeJS Website.

    • On Ubuntu, you can do apt-get install nodejs.

    • On Archlinux, you can do 'pacman -S nodejs'.

    • You may need to set your $NODE_PATH environment variable appropriately (e.g. it might be: /usr/local/share/npm/lib/node_modules).

    • If you install npm things globally, you'll need to do so as the appropriate super-user.

  • bower 1.0 or later: Install globally with npm install -g bower. If you already have bower installed at a lower version, run npm update -g bower.

    • To run binaries from globally-installed npm packages without fully-qualifying paths, make sure you have added your npm bin directory to your path (e.g. export PATH=$PATH:/usr/local/share/npm/bin/grunt).
  • Grunt: Install globally with npm install -g grunt-cli

  • Typescript: Install globally with npm install -g typescript

    • This is assuming you have ruby and rubygems installed.

Setup of uProxy codebase

  1. Clone uProxy and its submodules (and its submodules' submodules...): git clone https://github.com/uProxy/uProxy.git or git clone git@github.com:uProxy/uproxy.git if you have your ssh access to github setup (useful if you use 2-step auth for github, which you should do).

  2. Run bower install to install any bower dependencies.

  3. Run npm install. This will install all local dependencies, as appropriate to run in Chrome and Firefox. The first time you run this, you'll see lots of npm, bower and grunt messages. Check the last couple of lines in case there is an error.

Note that if any local dependencies have changed (i.e. changes to bower dependencies, updates to FreeDOM), you will have to run npm update and/or bower install to update the dependencies.

Building and installing and running for Chrome

These are the steps to try uProxy in the Chrome browser.

  • Run grunt build_chrome from the root directory of the repository to compile all the typescript and prepare the assets.

  • In Chrome, go to chrome://extensions, make sure 'Developer mode' is enabled, and click 'Load unpacked extension...' for both build/dev/chrome/app and build/dev/chrome/extension. You need both the uProxy Chrome App and the Extension.

Please don’t submit uProxy to the Chrome Web Store or Firefox Marketplace. uProxy is under active development and the team takes its responsibility to provide security very seriously; we don’t want at-risk groups that may not be technically sophisticated — journalists, human-rights workers, et al — to rely on uProxy until we feel it’s ready. Prematurely making uProxy available could have very serious real world ramifications.

One of the reasons we are doing this source code release is so that the community as a whole can help us make sure that we haven’t overlooked anything in our implementation. Once we feel that uProxy is ready, we will release it via the browser web stores ourselves.

Proxying between 2 instances of Chrome

To test proxying without using multiple computers, you will need to launch 2 separate instances of Chrome (specifying different directories for user-data-dir). To launch a new instance of Chrome on Mac, run: "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome" --user-data-dir=${DIR_NAME}/.chrome-beta where DIR_NAME is set to the name of a new directory. You may re-use your normal instance of Chrome if you wish to only run this command once.

In each instance of Chrome, load the uProxy app and extension. Then in each instance, sign into Google with gmail accounts that have already added each other as contacts. After sign in both contacts should be visible on each others roster without changing the default filters. Once proxying is started in the UI, try visiting any web page from the client's Chrome window. To verify that traffic is actually being proxied, open the debug console for the server's App and trace should appear indicating the flow of traffic.

Development and re-building uProxy

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 Chrome app
  • build_chrome_extension - Build just Chrome extension
  • build_firefox - Build just Firefox
  • build_uistatic - Build the static ui.
  • clean - Cleans up
  • watch - Watch for changes and recompile as needed.
  • test - Run unit tests
  • xpi - Generates an .xpi for installation to Firefox.
  • run_uistatic - Run the standalone UI on a local webserver.
  • everything - 'test', then 'build'

The easiest way to stay current is to pull changes, run grunt build to build your distribution, then run grunt watch, which will rebuild as you make changes. (TODO: grunt watch is broken; fix it!)

Before submitting any changes to the repository, make sure to run grunt test to make sure it passes all unit tests. Failing tests are cause to immediately reject submissions. :)

Fixing compilation and setup

The following hints may help you if it goes wrong and you need to debug and fix it.

  • The file called package.json provides details of node packages used to build uProxy. To download and install them in the right place (typically a subdirectory called node_packages) run npm install.

  • A file called bower.json provides details of packages for the UI, typically JavaScript for the browser. Run bower install to download and install the dependencies. They are typically installed in a directory called lib (as defined by a local file called .bowerrc).

  • If bower fails, it doesn't tell you. Sometimes things don't work because it failed to install something that you need. You can run bower by hand from the bower install and look out for error messages.

  • If things are not working, check that you have a recent version of bower, npm, and node.

Layout of files

Configuration and setup files

  • Gruntfile.js a file that specifies common tasks, e.g. how to build and package uproxy.
  • bower.json specified dependent libraries from Bower.
  • package.json specified dependent libraries from NPM.
  • .gitignore what git should ignore
  • .bowerrc tells bower where to put files
  • .travis.yml Travis auto-testing
  • tools directory contains some typescript and javascript to help Grunt.

Source code

  • src holds all source code; no compiled files
  • src/generic_ui generic user interface code
  • src/generic_core generic uproxy core-functionality code
  • src/chrome_app code specific to the chrome app
  • src/chrome_extension code specific to the chrome extension
  • src/firefox code specific to firefox
  • third_party holds external libraries we depend on that are copied into this repository
  • node_modules dynamically generated npm module dependencies
  • scraps temporary holding for sharing scraps of code

Dynamically created directories (grunt clean should remove them)

  • build created by grunt tasks; holds the built code, but none of the code that was compiled.
  • dist created by grunt tasks; holds final distribution versions
  • test_output created by grunt tasks; holds test-output files
  • .grunt holds grunt cache stuff

Glossary of frameworks you need to know about

  • Bower (and the bower.json file) - a package manager for the web. Used for javascript and web-libraries that the extension uses (e.g. angular). Note: this uses the file .bowerrc to specify where bower components get installed (in third_party/bower_components)
  • Coveralls: a continuous coverage checking system
  • Grunt (and the Gruntfile.js file) - a JavaScript task runner, used for compilation/building
  • Jasmine - a testing framework for JavaScript.
  • Karma - a test runner
  • NPM (and the package.json file): NPM (node package manager) us used to specify dependencies on node modules we use for compilation, e.g. typescript and grunt. These dependencies get places in the node_modules directory
  • Travis: a continuous build system
  • TypeScript as the primary language, which compiles to JavaScript. This does type checking and has some syntax improvements on JS, while letting us incrementally migrate and easily include external JS packages and frameworks