i2p.plugins.tor-updater/README.md

# i2p.plugins.tor-updater

A Tor package updater and runner as an I2P Plugin. This plugin is
still being changed rapidly but it should be usable on most Linux
distributions as of 23 Jan, 2022.

Usage:
------

```sh
Usage of ./i2p.plugins.tor-manager:

  -apparmor
    	Generate apparmor rules
  -arch string
    	OS/arch to download (default "64")
  -bemirror
    	Act as an in-I2P mirror when you're done downloading
  -directory string
    	Directory operate in
  -host string
    	Host to serve on (default "127.0.0.1")
  -i2pbrowser
    	Open I2P in Tor Browser
  -lang string
    	Language to download
  -os string
    	OS/arch to download (default "linux")
  -port int
    	Port to serve on (default 7695)
  -shortcuts
    	Create desktop shortcuts
  -torbrowser
    	Open Tor Browser
  -verbose
    	Verbose output
```

Status:
-------

![Screenshot 2](screenshot-console.png)

Linux: Usable, most things work.
Windows: Unstable, mostly usable, does not work in some important cirumstances, cannot run from a flash drive
OSX: Unstable, untested, not usable, WIP.

Other systems are not targeted and should use a Tor binary built from source,
provided by TPO or, their prefered package management system and not this plugin.
The plugin will not start a Tor instance if a SOCKS proxy is open on port 9050.

![Screenshot](screenshot-i2pbrowser.png)

### Primary Goals

1. Ship known-good public keys, download a current Tor for the platform in the background, authenticate it, and launch it only if necessary.
 - Works on Windows, Linux, probably also OSX
2. Supervise Tor as a ShellService plugin to I2P
 - Works on Linux, Windows
3. Keep Tor up-to-date
 - Works on Windows, Linux, probably also OSX
4. Work as an I2P Plugin OR as a freestanding app to be compatible with all I2P distributions
 - Works on Linux, Windows
5. Download Tor Browser from an in-I2P mirror(or one of a network of in-I2P mirrors)
 - Not done

### Secondary Goals:

1. Launch Tor Browser
 - Works on Linux, Windows, maybe OSX
2. Configure and launch Tor browser for use with I2P
 - Works on Linux, Windows.

#### Optional Features I might add if there is interest

1. Mirror the files which it downloads to an I2P Site
2. Mirror the files which it downloads to I2P torrents
3. Set up an onion site which announces an I2P mirror exists
4. Use Bittorrent-over-I2P to download the Tor Browser software

### Similar Projects:

- https://github.com/micahflee/torbrowser-launcher
- https://github.com/whonix/tb-updater

<a href="https://www.flaticon.com/free-icons/garlic" title="garlic icons">Garlic icons created by Icongeek26 - Flaticon</a>
<a href="https://www.flaticon.com/free-icons/onion" title="onion icons">Onion icons created by Freepik - Flaticon</a>

### More Screenshots:

- ![Screenshot](screenshot.png)
- ![Screenshot](screenshot-dark.png)