Binary Buildpack

Page last updated:

Use the binary buildpack for running arbitrary binary web servers.

Push an App

Unlike most other Cloud Foundry buildpacks, you must specify the binary buildpack to use it when staging your binary file. On a command line, use cf push APP-NAME with the -b option to specify the buildpack.

For example:

$ cf push my_app -b

You can provide Cloud Foundry with the shell command to execute your binary in the following two ways:

  • Procfile: In the root directory of your app, add a Procfile that specifies a web task:
web: ./app
  • Command line: Use cf push APP-NAME with the -c option:
$ cf push my_app -c './app' -b binary-buildpack

Compile your Binary

Cloud Foundry expects your binary to bind to the port specified by the PORT environment variable.

The following example in Go binds a binary to the PORT environment variable:

package main

import (

func handler(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintf(w, "Hello, %s", "world!")

func main() {
    http.HandleFunc("/", handler)
    http.ListenAndServe(":"+os.Getenv("PORT"), nil)

Your binary should run without any additional runtime dependencies on the cflinuxfs2 or lucid64 root filesystem (rootfs). Any such dependencies should be statically linked to the binary.

To boot a docker container running the cflinuxfs2 filesystem, run the following command:

$ docker run -it cloudfoundry/cflinuxfs2 bash

To boot a docker container running the lucid64 filesystem, run the following command:

$ docker run -it cloudfoundry/lucid64 bash

To compile the above Go application on the rootfs, golang must be installed. apt-get install golang and go build app.go will produce an app binary.

When deploying your binary to Cloud Foundry, use cf push with the -s option to specify the root filesystem it should run against.

$ cf push my_app -s (cflinuxfs2|lucid64)

To run docker on Mac OS X, we recommend boot2docker.

BOSH Configured Custom Trusted Certificate Support

Your platform operator can configure the platform to add the custom certificates into the application container. The custom trusted certificates will be added to the /etc/ssl/certs directory and can be used by binary applications.

Help and Support

Join the #buildpacks channel in our Slack community if you need any further assistance.

For more information about using and extending the binary buildpack in Cloud Foundry, see the binary-buildpack GitHub repository.

You can find current information about this buildpack on the binary buildpack release page in GitHub.

Create a pull request or raise an issue on the source for this page in GitHub