Changes between Version 102 and Version 103 of doc/TorBrowser/Hacking


Ignore:
Timestamp:
Dec 8, 2017, 8:49:18 PM (10 months ago)
Author:
igt0
Comment:

Add Orfox build instructions

Legend:

Unmodified
Added
Removed
Modified
  • doc/TorBrowser/Hacking

    v102 v103  
    148148
    149149Now, you should be able to start Tor Browser in $INSTDIR normally. To run multiple copies at once, see the next section.
     150
     151= Building Orfox =
     152
     153This section is of interest to developers making changes to Tor Browser Mobile or its components (e.g. Orbot), and who wish to test their patches.
     154
     155== Orfox ==
     156
     157First, you need to check out a copy of the Orfox browser and fetch all sub modules with:
     158
     159{{{
     160git clone https://github.com/guardianproject/Orfox.git
     161cd Orfox
     162git submodule update --init --recursive
     163}}}
     164
     165Later, instead of downloading dependency by dependency, you can use Mozilla bootstrap command to download all of them at once.
     166
     167{{{
     168cd external/tor-browser
     169./mach bootstrap
     170}}}
     171
     172Now we need to use the Orfox mozconfig and update it.
     173
     174{{{
     175export MOZCONFIG=`pwd`"/external/tor-browser/.mozconfig-orfox-release"
     176}}}
     177
     178Open the .mozconfig-orfox-release file and replace the $NDK_BASE and $SDK_BASE with the path to the installed Android NDK and SDK, respectively.
     179
     180Now we can build it and generate the APK
     181
     182{{{
     183./mach configure
     184./mach build
     185./mach package
     186./mach build-backend -b AndroidEclipse
     187}}}
     188
     189That is it, if you want to run it, you can use the Android adb tool or
     190
     191{{{
     192./mach run
     193}}}
     194
     195It will install and run in your android device.
     196
     197== Orbot ==
     198
     199If you want to modify Orbot, this section is for you:
     200
     201=== Dependencies ===
     202
     203||= Dependency =||= version =||
     204|| Android SDK Tools || 25      ||
     205|| Android Build Tools || 26.0.2 ||
     206|| Android NDK || r11b ||
     207
     208
     209=== Fetching and Building ===
     210
     211First, you need to check out a copy of the orbot repo with:
     212
     213{{{
     214git clone https://github.com/n8fr8/orbot.git
     215cd orbot
     216git submodule update --init --recursive
     217}}}
     218
     219To build it (in debug mode), from the top directory of the orbot repo, do:
     220
     221{{{
     222./gradlew assembleDebug
     223}}}
     224
     225The command will generate an APK (self signed) that can be used in you device or simulator.
    150226
    151227= Running Multiple Tor Browsers =