Cloud Foundry Staticfile Buildpack

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

1. Install buildpack-packager

   (cd src/staticfile/vendor/github.com/cloudfoundry/libbuildpack/packager/buildpack-packager && go install)

2. Build the buildpack

   buildpack-packager [ --cached | --uncached ]

3. Use in Cloud Foundry

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

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

Testing

Buildpacks use the Cutlass framework for running integration tests.

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

1. Install ginkgo

   (cd src/staticfile/vendor/github.com/onsi/ginkgo/ginkgo && go install)

2. Run unit tests

   ./scripts/unit.sh

3. Run integration tests

   ./scripts/integration.sh

More information can be found on github cutlass.

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. 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!