booster

command module
v0.6.992 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 26, 2019 License: AGPL-3.0 Imports: 1 Imported by: 0

README

Booster

GoDoc Build Status Go Report Card Release

Abstract

While more and more people today have a fast Internet connection, there are plenty of other people that do not. The aim of this project is to create a solution that combines multiple Internet access points (such as Wifi or mobile devices) into one single faster Internet connection, that it is easy to use, and fast to configure.

Highscores

First things first: this section is reserved for the highest download speed that we managed to obtain in our office. Without booster our WIFI's download speed reaches ~34Mbps, but with booster... 🎉

Installation

(Windows is not yet supported)

Binary

Pick your release.

Snap

Get it from the Snap Store
Note: at the moment booster is not able to bind to an interface that points to an Apple device without root privileges. To overcome the issue install the snap as root. You can always inspect the logs using:

snap logs booster -f
From source

First install go, then type this commands into your command line:

git clone https://github.com/booster-proj/booster.git && cd booster # Clone
make test # Test
make # Build

Usage

Recap: when booster spawns, it identifies the network interfaces available in the system that provide an active internet connection. It then starts a proxy server that speaks either socks5 or http. According to some particular strategy (still not configurable), and a set of policies (configurable), the server is able to distribute the incoming network traffic across the network interfaces collected.

Note that booster runs as daemon when installed through snap, otherwise you'll have to start it manually:

bin/booster

Note: get help with the --help flag.

Once started, booster can be remotely controller through its public HTTP Json API. The documentation is available in the Wiki.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package core provides components useful for containing and retrieving entities, i.e.
Package core provides components useful for containing and retrieving entities, i.e.
Package dialer provides a connection dialer that opens new `net.Conn`s using the sources provided by its Balancer.
Package dialer provides a connection dialer that opens new `net.Conn`s using the sources provided by its Balancer.
Package metrics provides what in prometheus terms is called a metrics exporter.
Package metrics provides what in prometheus terms is called a metrics exporter.
Package remote provides HTTP endpoints to control booster remotely.
Package remote provides HTTP endpoints to control booster remotely.
Package listener provides a functionalities to discover and inspect sources.
Package listener provides a functionalities to discover and inspect sources.
Package store is the main component that orchestrates sources.
Package store is the main component that orchestrates sources.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL