# README
Cloud Foundry Experimental Nginx Buildpack
A Cloud Foundry buildpack for apps requiring custom nginx.
Buildpack User Documentation
To use this buildpack, you will need to include an nginx.conf
file in your
app. You can see sample apps in the fixtures directory,
mainline,
including a sample nginx.conf
file.
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 .envrc
To simplify the process in the future, install direnv which will automatically source .envrc when you change directories.
-
Install buildpack-packager
./scripts/install_tools.sh
-
Build the buildpack
buildpack-packager build [ --cached=(true|false) ]
-
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 .envrc
To 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
Reporting Issues
Open an issue on this project
Active Development
The project backlog is on Pivotal Tracker
Disclaimer
This buildpack is experimental and not yet intended for production use.