]> git.lizzy.rs Git - torbrowser-launcher.git/blob - README.md
Merge pull request #82 from lazlolazlolazlo/pep8
[torbrowser-launcher.git] / README.md
1 Tor Browser Launcher
2 ====================
3 Tor Browser Launcher is intended to make the Tor Browser Bundle (TBB) easier to
4 maintain and use for GNU/Linux users. You install ```torbrowser-launcher``` from your
5 distribution's package manager and it handles everything else, including:
6
7 * Downloading the most recent version of TBB for you, in your language and for
8   your architecture
9 * Automatically updating (while preserving your bookmarks and preferences)
10 * Verifying the TBB's [GnuPG signature](http://www.gnupg.org/gph/en/manual/x135.html)
11 * Adding a "Tor Browser" application launcher to your desktop environment's menu
12
13 Tor Browser Launcher isn't in any Debian repositories yet, but it will be soon.
14
15 Quick Start
16 -----------
17
18 If you're using a Debian-based distro like Debian, Ubuntu, or Linux Mint, the
19 following instructions will install dependencies, clone this repo, build a .deb, and
20 install it with dpkg.
21
22     sudo apt-get install build-essential python-all python-stdeb python-gtk2 python-psutil python-twisted python-pygame python-lzma python-parsley python-txsocksx wmctrl gnupg fakeroot
23     git clone https://github.com/micahflee/torbrowser-launcher.git
24     cd torbrowser-launcher
25     ./build_and_install.sh
26
27 Installing in Ubuntu
28 --------------------
29
30 I've created a PPA where I'm maintaining torbrowser-launcher binaries. You can install in an Ubuntu-based distribution like this:
31
32     sudo add-apt-repository ppa:micahflee/ppa
33     sudo apt-get update
34     sudo apt-get install torbrowser-launcher
35
36 Enabling AppArmor Profiles
37 --------------------------
38
39 AppArmor is a Linux kernel hardening technology that lets you confine specific programs to only use specific resources. For example, if you visit a website that exploits a bug in the Tor Browser to get arbitrary code execution, the attacker won't be able to access files in ~/.gnupg. Here's how you turn on the AppArmor profiles for Tor Browser Launcher and for the programs bundled in the TBB.
40
41     sudo apt-get install apparmor-utils
42     sudo aa-enforce /etc/apparmor.d/usr.bin.torbrowser-launcher
43     sudo aa-enforce /etc/apparmor.d/torbrowser.start-tor-browser
44     sudo aa-enforce /etc/apparmor.d/torbrowser.Browser.firefox
45     sudo aa-enforce /etc/apparmor.d/torbrowser.Tor.tor
46
47 Building
48 ========
49
50 Dependencies
51 ------------
52
53 You need to have ```stdeb``` installed. If you're using Debian or Ubuntu you can
54 install it like this:
55
56     apt-get install python-stdeb
57
58 Also install the ```torbrowser-launcher``` dependencies:
59
60     apt-get install python-gtk2 python-psutil python-twisted python-lzma wmctrl gnupg fakeroot
61
62 Debian packages
63 ---------------
64
65 To build a Debian source and binary packages:
66
67     python setup.py --command-packages=stdeb.command sdist_dsc bdist_deb
68
69 Once you've made a ```.deb```, you can install by running this as root:
70
71     dpkg -i deb_dist/torbrowser-launcher_VERSION_all.deb