For any details on this repository, contact [email protected].

To be able to update to a new version or publish to RTBkit, you'll need a fork on github. This fork will be public and will provide a way to sync back and forth with the official one.

This repository contains a subtree of RTBkit i.e. all commits. Updating it to a new version means importing commits from the updated fork of RTBkit or from RTBkit directly. This can be done with subtree pull:

git remote add upstream https://github.com/your-fork/rtbkit.git
git subtree pull --prefix rtbkit upstream master --squash

Sometimes, it's useful to be able to upstream changes to RTBkit so that they get integrated in the official repository. The first step is to extract and upstream commits (with their history limited to rtbkit) to your fork. This can be done with subtree pull:

git subtree push --prefix rtbkit upstream master

Then, create a pull request and submit it for review.

RTBkit comes with its own build system i.e. jml-build. There is a makefile at the root that allows building RTBkit and running RTBkit test suite.

make rtbkit
make rtbkit-tests

There are a few scripts supplied with this installation to ease deployments. They assume that the user has a ~/prod directory. That directory must contains 2 complete versions of the codebase called:

rtb-black
rtb-white

There is also a symbolic link named rtb that links to the version currently in production i.e. it either points to rtb-black or rtb-white. Under normal operations, deployment happens in the color that's not in production. The script uses the prod branch unless one is specified. The branch is fetched, checkout and the code is built. Beware that any pending modifications will be lost.

deploy-rtb COLOR [--branch NAME]

Once deployed, you can restart the stack on that new color. Note that if nothing is specified, the script will restart the stack on the currently active color.

launch-rtb [COLOR]

If deployment failed for whatever reason, you can quickly revert to the previous color.

launch-rtb other

We included a BasicBiddingAgent that uses RTBkit to perform the following tasks:

• reads its configuration from a JSON file
• sends its configuration to the agent configuration service
• sets the budget of the campaign account
• transfers a small amount of money every minute (pacing)

Include (at least) one bidding agent per campaign for it to start spending. The agent configuration file is specified on the command line (see configs/launch-sequence.json) and contains an AgentConfig object that RTBkit understands. It contains an ext field that this agent will use to configure the following:

• budget
• pace (how much money is transfers every minute)
• price
• priority (to choose who will have the priority)

The code is included in the plugins directory and uses cmake. To build, make sure rtbkit is already build and do the following:

cd plugins
cmake -G "Unix Makefiles"
make