doorman

(β˜… 1,950)

Doorman: Global Distributed Client Side Rate Limiting.

Showing a partial file list β€” download the zip above to see everything.

  • .gitignore
  • .gitmodules
  • .travis.yml
  • AUTHORS
  • CONTRIBUTING.md
  • CONTRIBUTORS
  • glide.lock
  • glide.yaml
  • LICENSE
  • README.md

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/youtube/doorman

Downloads the entire project code from GitHub to your computer.

cd doorman

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew install go

Installs the pre-built package via Homebrew β€” no source build required.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f doc/loadtest/docker/client/Dockerfile -t doorman .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 doorman

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd simulation

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation