README
¶
Cloud Foundry Staticfile Buildpack
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 command from the buildpack's directory:
-
Source the .envrc file in the buildpack directory.
source .envrcTo simplify the process in the future, install direnv which will automatically source .envrc when you change directories.
-
Install buildpack-packager
(cd src/staticfile/vendor/github.com/cloudfoundry/libbuildpack/packager/buildpack-packager && go install) -
Build the buildpack
buildpack-packager [ --cached | --uncached ] -
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
Buildpacks use the Cutlass framework for running integration tests.
To test this buildpack, run the following command from the buildpack's directory:
-
Source the .envrc file in the buildpack directory.
source .envrcTo simplify the process in the future, install direnv which will automatically source .envrc when you change directories.
-
Run unit tests
./scripts/unit.sh -
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!
Directories