Skip to content
This repository has been archived by the owner on Nov 23, 2018. It is now read-only.
/ floodgate Public archive

🌊 Cross-platform, configurable, and reliable bandwidth limiting.

Notifications You must be signed in to change notification settings

calibreapp/floodgate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

9 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Yarn

Cross-platform, configurable, and reliable bandwidth limiting.


Features

  • Cross-platform and self-contained. Floodgate is a single statically compiled binary with no external dependencies, and is released for macOS, Linux and Windows. Don't want to install Node, Python or anything else? Unzip and start using right away!
  • Real-world connection profiles. Floodgate ships with pre-defined connection profiles that Calibre uses as part of Test Profiles.

πŸƒ Install

Floodgate is packaged as pre-compiled binaries that work on all major operating systems. There are no dependencies to install, it just works. Everywhere.

Operating system download
Mac OS Download
Linux Download
Windows Download

Unzip, copy the binary, and run!

Yarn

πŸ–₯ Usage

Usage of floodgate:
  -latency string
    	Latency to add to operations, in ms (required)
  -listen string
    	address to listen on, e.g 127.0.0.1:8000 (required)
  -rate string
    	rate to limit to, in kpbs (required)

Using floodgate with Google Chrome

If you wish to reliably limit the bandwidth available to Chrome or Chromium, you can do so by starting Chrome with the --proxy-server flag.

  1. Start floodgate ./floodgate
  2. Start Chrome:
google-chrome-canary --proxy-server="socks://localhost:8000" https://calibreapp.com
  1. The browser is now using a bandwidth limited connection.

πŸ€” FAQs

  • Why not use the network limiting feature in Google Chrome?

Because Chrome has many connection types (h2, h2 with server push, http, longpoll, SSE, etc) and it attempts to limit the connection on a per-tab basis, it is really difficult to reliably limit the connection speed for your site. Floodgate circumvents that by providing a proxy server that limits all traffic that it processes.

  • Can I use this with browsers that aren't Chrome?

Yes! Start floodgate and then configure your browser of choice to use a SOCKS5 proxy.

πŸ’ƒ Want to contribute?

Great! Please submit an issue (but preferably, a pull request) with your ideas or fixes. We'll do our best to review and discuss.

About

🌊 Cross-platform, configurable, and reliable bandwidth limiting.

Topics

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published