]> git.lizzy.rs Git - torbrowser-launcher.git/blobdiff - README.md
Give more intelligence errors if connection error while using socks proxy
[torbrowser-launcher.git] / README.md
index 586b99f11c5857aed7cb41a24ea772762ae50252..9ca9f3aefd80e45fe368fdd0bfe61ccab54a5007 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,71 +1,25 @@
-Tor Browser Launcher
-====================
-Tor Browser Launcher is intended to make the Tor Browser Bundle (TBB) easier to
-maintain and use for GNU/Linux users. You install ```torbrowser-launcher``` from your
-distribution's package manager and it handles everything else, including:
+# Tor Browser Launcher
 
-* Downloading the most recent version of TBB for you, in your language and for
-  your architecture
-* Automatically updating (while preserving your bookmarks and preferences)
-* Verifying the TBB's [GnuPG signature](http://www.gnupg.org/gph/en/manual/x135.html)
-* Adding a "Tor Browser" application launcher to your desktop environment's menu
+Tor Browser Launcher is intended to make Tor Browser easier to install and use for GNU/Linux users. You install ```torbrowser-launcher``` from your distribution's package manager and it handles everything else:
 
-Tor Browser Launcher isn't in any Debian repositories yet, but it will be soon.
+* Downloads and installs the most recent version of Tor Browser in your language and for your computer's architecture, or launches Tor Browser if it's already installed (Tor Browser will automatically update itself)
+* Verifies Tor Browser's [signature](https://www.torproject.org/docs/verifying-signatures.html.en) for you, to ensure the version you downloaded was cryptographically signed by Tor developers and was not tampered with
+* Adds "Tor Browser" and "Tor Browser Launcher Settings" application launcher to your desktop environment's menu
+* Includes AppArmor profiles to make a Tor Browser compromise not as bad
+* Optionally plays a modem sound when you open Tor Browser (because Tor is so slow)
 
-Quick Start
------------
+Tor Browser Launcher is included in Ubuntu, Debian, and Fedora. To install it in any other distribution, see the [build instructions](/BUILD.md).
 
-If you're using a Debian-based distro like Debian, Ubuntu, or Linux Mint, the
-following instructions will install dependencies, clone this repo, build a .deb, and
-install it with dpkg.
+You might want to check out the [security design doc](/security_design.md).
 
-    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
-    git clone https://github.com/micahflee/torbrowser-launcher.git
-    cd torbrowser-launcher
-    ./build_and_install.sh
+![Tor Browser Launcher screenshot](/screenshot.png)
 
-Installing in Ubuntu
---------------------
+# Installing in Ubuntu
 
-I've created a PPA where I'm maintaining torbrowser-launcher binaries. You can install in an Ubuntu-based distribution like this:
+If you want to always have the latest version of the `torbrowser-launcher` package before your distribution gets it, you can use my PPA:
 
-    sudo add-apt-repository ppa:micahflee/ppa
-    sudo apt-get update
-    sudo apt-get install torbrowser-launcher
-
-Enabling AppArmor Profiles
---------------------------
-
-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.
-
-    sudo apt-get install apparmor-utils
-    sudo aa-enforce /etc/apparmor.d/usr.bin.torbrowser-launcher
-    sudo aa-enforce /etc/apparmor.d/torbrowser.start-tor-browser
-    sudo aa-enforce /etc/apparmor.d/torbrowser.Browser.firefox
-    sudo aa-enforce /etc/apparmor.d/torbrowser.Tor.tor
-
-Building
-========
-
-Dependencies
-------------
-
-You need to have ```stdeb``` installed. If you're using Debian or Ubuntu you can
-install it like this:
-
-    apt-get install python-stdeb
-
-Also install the ```torbrowser-launcher``` dependencies:
-
-    apt-get install python-gtk2 python-psutil python-twisted python-lzma wmctrl gnupg fakeroot
-
-Debian packages
----------------
-
-To build a Debian source and binary packages:
-
-    python setup.py --command-packages=stdeb.command sdist_dsc bdist_deb
-
-Once you've made a ```.deb```, you can install by running this as root:
-
-    dpkg -i deb_dist/torbrowser-launcher_VERSION_all.deb
+```sh
+sudo add-apt-repository ppa:micahflee/ppa
+sudo apt-get update
+sudo apt-get install torbrowser-launcher
+```