github.com/prebid/prebid-server@v0.275.0/README.md (about)

     1  [![Build](https://img.shields.io/github/actions/workflow/status/prebid/prebid-server/validate.yml?branch=master&style=flat-square)](https://github.com/prebid/prebid-server/actions/workflows/validate.yml)
     2  [![Go Report Card](https://goreportcard.com/badge/github.com/prebid/prebid-server?style=flat-square)](https://goreportcard.com/report/github.com/prebid/prebid-server)
     3  ![Go Version](https://img.shields.io/github/go-mod/go-version/prebid/prebid-server?style=flat-square)
     4  
     5  # Prebid Server
     6  
     7  Prebid Server is an open source implementation of Server-Side Header Bidding.
     8  It is managed by [Prebid.org](https://prebid.org/about/),
     9  and upholds the principles from the [Prebid Code of Conduct](https://prebid.org/code-of-conduct/).
    10  
    11  This project does not support the same set of Bidders as Prebid.js, although there is overlap.
    12  The current set can be found in the [adapters](./adapters) package. If you don't see the one you want, feel free to [contribute it](https://docs.prebid.org/prebid-server/developers/add-new-bidder-go.html).
    13  
    14  For more information, see:
    15  
    16  - [What is Prebid?](https://docs.prebid.org/overview/intro.html)
    17  - [Prebid Server Overview](https://docs.prebid.org/prebid-server/overview/prebid-server-overview.html)
    18  - [Current Bidders](https://docs.prebid.org/dev-docs/pbs-bidders.html)
    19  
    20  Please consider [registering your Prebid Server](https://docs.prebid.org/prebid-server/hosting/pbs-hosting.html#optional-registration) to get on the mailing list for updates, etc.
    21  
    22  ## Installation
    23  
    24  First install [Go](https://golang.org/doc/install) version 1.19 or newer.
    25  
    26  Note that prebid-server is using [Go modules](https://blog.golang.org/using-go-modules).
    27  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`.
    28  
    29  Download and prepare Prebid Server:
    30  
    31  ```bash
    32  cd YOUR_DIRECTORY
    33  git clone https://github.com/prebid/prebid-server src/github.com/prebid/prebid-server
    34  cd src/github.com/prebid/prebid-server
    35  ```
    36  
    37  Run the automated tests:
    38  
    39  ```bash
    40  ./validate.sh
    41  ```
    42  
    43  Or just run the server locally:
    44  
    45  ```bash
    46  go build .
    47  ./prebid-server
    48  ```
    49  
    50  Run format:
    51  ```
    52  make format
    53  ```
    54  or
    55  ```bash
    56  ./scripts/format.sh -f true
    57  ```
    58  
    59  Load the landing page in your browser at `http://localhost:8000/`.
    60  For the full API reference, see [the endpoint documentation](https://docs.prebid.org/prebid-server/endpoints/pbs-endpoint-overview.html)
    61  
    62  ## Go Modules
    63  
    64  The packages within this repository are intended to be used as part of the Prebid Server compiled binary. If you
    65  choose to import Prebid Server packages in other projects, please understand we make no promises on the stability
    66  of exported types.
    67  
    68  ## Contributing
    69  
    70  Want to [add an adapter](https://docs.prebid.org/prebid-server/developers/add-new-bidder-go.html)? Found a bug? Great!
    71  
    72  Report bugs, request features, and suggest improvements [on Github](https://github.com/prebid/prebid-server/issues).
    73  
    74  Or better yet, [open a pull request](https://github.com/prebid/prebid-server/compare) with the changes you'd like to see.
    75  
    76  ## IDE Recommendations
    77  
    78  The quickest way to start developing Prebid Server in a reproducible environment isolated from your host OS
    79  is by using Visual Studio Code with [Remote Container Setup](devcontainer.md).