trafficcontrol

(โ˜… 1,153)

Apache Traffic Control is an Open Source implementation of a Content Delivery Network

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

  • .asf.yaml
  • .codecov.yml
  • .dependency_license
  • .env
  • .gitignore
  • .golangci.yml
  • .mailmap
  • .readthedocs.yaml
  • BUILD.md
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • doap_Traffic_Control.rdf
  • docker-compose.yml
  • go.mod
  • go.sum
  • GO_VERSION
  • LICENSE
  • Makefile
  • NOTICE
  • pkg
  • pkg.ps1
  • PULL_REQUEST_TEMPLATE.md
  • README.md
  • SECURITY.md
  • VERSION

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/apache/trafficcontrol

Downloads the entire project code from GitHub to your computer.

cd trafficcontrol

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
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 compose -f cache-config/testing/docker/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

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

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd experimental/traffic-portal/build

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

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r docs/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <์‹คํ–‰ํ•  ํŒŒ์ผ๋ช…>.py # README์—์„œ ์ •ํ™•ํ•œ ์‹คํ–‰ ํŒŒ์ผ๋ช…์„ ํ™•์ธํ•˜์„ธ์š”

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.

5. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

6. 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).
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