Skip to content
Deploy static HTML/JS/CSS apps to Cloud Foundry
Branch: master
Clone or download
tillyt and kardolus Bump version to 1.4.43 [#166400785]
Co-authored-by: Guillermo Kardolus <gkardolus@pivotal.io>
Latest commit e482e8f Jun 5, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Vendor with go modules Jan 8, 2019
fixtures Changes include headers to allow for a root directory Oct 26, 2018
scripts update install_go.sh script to use go 1.12.4 May 3, 2019
src/staticfile Merge pull request #154 from lrgar/release Apr 3, 2019
vendor Update libbuildpack May 28, 2019
.envrc
.gitallowed Update libbuildpack May 23, 2017
.gitignore Convert to using cutlass for integration tests and buildpack-packager Jul 31, 2017
CHANGELOG
CONTRIBUTING.md Fix worging in CONTRIBUTING.md Nov 9, 2016
ISSUE_TEMPLATE Update ISSUE_TEMPLATE with request for actual CF version Dec 23, 2016
LICENSE Update LICENSE Jun 18, 2018
NOTICE Correct copyright NOTICE Dec 21, 2016
PULL_REQUEST_TEMPLATE Fix worging in CONTRIBUTING.md Nov 9, 2016
README.md
VERSION
go.mod Update libbuildpack May 28, 2019
go.sum Update libbuildpack May 28, 2019
manifest.yml Change default nginx version to 1.15.x [#166292306] May 28, 2019

README.md

Cloud Foundry Staticfile Buildpack

CF Slack Join us on Slack

A Cloud Foundry buildpack for static content such as websites (HTML/JS/CSS).

Buildpack User Documentation

Official buildpack documentation can be found at staticfile buildpack docs.

Building the Buildpack

To build this buildpack, run the following commands from the buildpack's directory:

  1. Source the .envrc file in the buildpack directory.

    source .envrc

    To simplify the process in the future, install direnv which will automatically source .envrc when you change directories.

  2. Install buildpack-packager

    go install github.com/cloudfoundry/libbuildpack/packager/buildpack-packager
  3. Build the buildpack

    buildpack-packager build [ --cached=(true|false) ]
  4. Use in Cloud Foundry

    Upload the buildpack to your Cloud Foundry and optionally specify it by name

    cf create-buildpack [BUILDPACK_NAME] [BUILDPACK_ZIP_FILE_PATH] 1
    cf push my_app [-b BUILDPACK_NAME]

Testing

To test this buildpack, run the following commands from the buildpack's directory:

  1. Source the .envrc file in the buildpack directory.

    source .envrc

    To simplify the process in the future, install direnv which will automatically source .envrc when you change directories.

  2. Run unit tests

    ./scripts/unit.sh
  3. Run integration tests

    Buildpacks use the Cutlass framework for running integration tests against Cloud Foundry. Before running the integration tests, you need to login to your Cloud Foundry using the cf cli:

    cf login -a https://api.your-cf.com -u name@example.com -p pa55woRD

    Note that your user requires permissions to run cf create-buildpack and cf update-buildpack. To run the integration tests, run the following command from the buildpack's directory:

    ./scripts/integration.sh

More information can be found on here.

Contributing

Find our guidelines here.

Help and Support

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

Reporting Issues

Open a GitHub issue on this project here.

Active Development

The project backlog is on Pivotal Tracker.

Acknowledgements

This buildpack is based heavily upon Jordon Bedwell's Heroku buildpack and the modifications by David Laing for Cloud Foundry nginx-buildpack (deprecated). It has been tuned for usability (configurable with Staticfile) and to be included as a default buildpack (detects Staticfile rather than the presence of an index.html). Thanks for the buildpack Jordon! If you require additional custom NGINX configuration, use the new nginx-buildpack.

You can’t perform that action at this time.