prebid-server

README

Prebid Server

Prebid Server is an open source implementation of Server-Side Header Bidding. It is managed by Prebid.org, and upholds the principles from the Prebid Code of Conduct.

This project does not support the same set of Bidders as Prebid.js, although there is overlap. The current set can be found in the adapters package. If you don't see the one you want, feel free to contribute it.

For more information, see:

• What is Prebid?
• Prebid Server Overview
• Current Bidders

Please consider registering your Prebid Server to get on the mailing list for updates, etc.

Installation

First install Go version 1.19 or newer.

Note that prebid-server is using Go modules. We officially support the most recent two major versions of the Go runtime. However, if you'd like to use a version <1.13 and are inside GOPATH GO111MODULE needs to be set to GO111MODULE=on.

Download and prepare Prebid Server:

cd YOUR_DIRECTORY
git clone https://github.com/prebid/prebid-server src/github.com/prebid/prebid-server
cd src/github.com/prebid/prebid-server

Run the automated tests:

./validate.sh

Or just run the server locally:

go build .
./prebid-server

Run format:

make format

or

./scripts/format.sh -f true

Load the landing page in your browser at http://localhost:8000/. For the full API reference, see the endpoint documentation

Go Modules

The packages within this repository are intended to be used as part of the Prebid Server compiled binary. If you choose to import Prebid Server packages in other projects, please understand we make no promises on the stability of exported types.

Contributing

Want to add an adapter? Found a bug? Great!

Report bugs, request features, and suggest improvements on Github.

Or better yet, open a pull request with the changes you'd like to see.

IDE Recommendations

The quickest way to start developing Prebid Server in a reproducible environment isolated from your host OS is by using Visual Studio Code with Remote Container Setup.