UWNetworksLab / uProxy-windows-installer

Windows installer that installs a copy of Firefox with uProxy preloaded.

uProxy Windows Installer

uProxy is a browser plugin that allows users to reach the open internet through a trusted friend or uProxy cloud server.

The uProxy Windows Installer creates a modified version of the Firefox Windows Installer with the uProxy extension enabled by default. This allows Windows users to get up and running with uProxy quickly.

Download

For downloads, please click here.

###Dev setup:

• Need to use a Windows OS
• 7-zip and signtool, which is part of Windows SDK 7.1, need to be installed

To build Windows installer:

• git clone https://github.com/uProxy/uproxy-windows-installer.git
• install.bat
• Grab executable files from dist\%language%\Firefox_with_uProxy.exe and upload them to releases. By default we build versions for English (us-EN) and Chinese (zh-CN).

Build for a specfic Firefox version or language:

• We support a couple optional arguments for building specific versions of Firefox
• To build the installer for a specific language: install.bat -l us-En
• To build the installer for a specific version of Firefox: install.bat -v 45.0
• Another example: install.bat -v 45.0 -l zh-CN
• List of possible languages here

###To make changes:

• git clone https://github.com/uProxy/uproxy-windows-installer.git
• Make a new branch for your changes: git checkout -b your_branch_name origin/master
• Make changes
• In install.bat, update the version patch number
• Push changes: git push your_branch_name origin/master
• Create pull request

###When there is a new version of the uProxy Firefox extension:

• Follow the steps above to make changes
• While using Windows, get the url to the newly released uProxy .xpi file at https://addons.mozilla.org/en-US/firefox/addon/uproxy-firefox/. It should look something like this https://addons.mozilla.org/firefox/downloads/file/401357/uproxy_beta-0.8.36-fx-windows.xpi
• In install.bat, set the uproxyAddonURL to the new url
• In install.bat, update the Version and uProxy Version
• git push <your_branch_name> origin/master
• Create pull request
• If you want to build the new releases, run install.bat and upload new executables to releases

###To test a release:

• If you've already installed Firefox on your computer, uninstall Firefox.
• Clear old Firefox data and profiles by deleting two directories: C:\Users\<user>\AppData\Roaming\Mozilla\ and C:\Users\<user>\AppData\Local\Mozilla
• Run the new setup .exe file. Check to see that the landing page is displayed and uProxy is installed.

To create a release:

1. Create a new tag for the release, e.g. git tag -a v1.2.3 -m 'tag v1.2.3'
2. Push it to GitHub, e.g. git push origin v1.2.3
3. You should now see it on the https://github.com/uProxy/uproxy-windows-installer/releases page.
4. Check out a local dist branch tracking the corresponding remote branch: git fetch && git checkout dist
5. Replace the build artifacts in the repo with the new ones you just built: git rm _/*.exe && cp /path/to/new/builds/* _/
6. Update links in the README to point to the latest builds you're about to push.
7. Stage these changes: git add .
8. Amend the previous commit so as not to bloat the history: git commit --amend --date (date)
9. Force-push the commit: git push -f
10. Verify that https://github.com/uProxy/uproxy-windows-installer/tree/dist#download-latest contains the latest download links and that they work.
11. After you pushed the tag, GitHub will have automatically created a corresponding release under https://github.com/uProxy/uproxy-windows-installer/releases. Note the previous releases have descriptions populated, and the new one doesn't. Click "Edit" next to the new release, and:
    • In the description field, add a big, bold download link advising users to download from https://github.com/uProxy/uproxy-windows-installer/tree/dist#download-latest
    • Note the included uProxy and Firefox versions.
    • Note the available languages.
    • Save and make sure everything looks good.
12. Finally, upload the latest release artifacts to the archive in Drive: https://drive.google.com/drive/folders/0B22PfwRIULBDc1VicmpNVk5qWk0