]> git.lizzy.rs Git - torbrowser-launcher.git/blobdiff - README.md
Merge pull request #583 from kpcyrd/github-actions
[torbrowser-launcher.git] / README.md
index 4144c53c0b79400202c1187474aebb04f43e41ba..b293a04ad3ad4ea9191c219e35efa94069239920 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,71 +1,37 @@
 # 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:
+_**Are you getting an error?** Sometimes updates in Tor Browser itself will break Tor Browser Launcher. There's a good chance that the problem you're experiencing has already been fixed in the [newest version](https://github.com/micahflee/torbrowser-launcher/releases). Try installing from Flatpak (instructions below), or [build from source](/BUILD.md)._
 
-* 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:
 
-If you use Ubuntu, you can install it now from my PPA (see "Installing in Ubuntu" below). [Soon](https://github.com/micahflee/torbrowser-launcher/issues/31) it will be in Debian. To install it in any other distribution, follow the "Quick Start" instructions.
+* 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).
 
-First, clone the repository:
+You might want to check out the [security design doc](/security_design.md).
 
-    git clone https://github.com/micahflee/torbrowser-launcher.git
-    cd torbrowser-launcher
+![Tor Browser Launcher screenshot](/screenshot.png)
 
-Then install dependencies, build a package, and install:
+# Installing
 
-### Debian, Ubuntu, Linux Mint, etc.
+You can install `torbrowser-launcher` from your operating system's package manager, but it might be out-of-date and have issues working. If you want to make sure you always have the latest version, use Flatpak:
 
-    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
-    ./build_deb.sh
-    sudo dpkg -i deb_dist/torbrowser-launcher_*.deb
+## Installing in any Linux distro using Flatpak
 
-### Red Hat, Fedora, CentOS, etc.
+Install Flatpak using these [instructions](https://flatpak.org/setup/).
 
-    sudo yum install python-psutil python-twisted pygame wmctrl gnupg fakeroot
-    ./build_rpm.sh
-    sudo yum install dist/torbrowser-launcher-*.rpm
+Then install `torbrowser-launcher` like this:
 
-## Installing in Ubuntu
+```
+flatpak install flathub com.github.micahflee.torbrowser-launcher -y
+```
 
-I've created a PPA where I'm maintaining torbrowser-launcher binaries. You can install in an Ubuntu-based distribution like this:
+Run `torbrowser-launcher` either by using the GUI desktop launcher, or by running:
 
-    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 in Debian
-
-## 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
+```
+flatpak run com.github.micahflee.torbrowser-launcher
+```