Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudfoundry/staticfile-buildpack
Deploy static HTML/JS/CSS apps to Cloud Foundry
https://github.com/cloudfoundry/staticfile-buildpack
v2b
Last synced: about 2 months ago
JSON representation
Deploy static HTML/JS/CSS apps to Cloud Foundry
- Host: GitHub
- URL: https://github.com/cloudfoundry/staticfile-buildpack
- Owner: cloudfoundry
- License: apache-2.0
- Created: 2014-08-10T01:01:27.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-17T16:57:02.000Z (2 months ago)
- Last Synced: 2024-07-18T06:11:56.478Z (2 months ago)
- Topics: v2b
- Language: Go
- Homepage:
- Size: 47.7 MB
- Stars: 200
- Watchers: 55
- Forks: 329
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-ibmcloud - staticfile-buildpack - Deploy static HTML/JS/CSS apps to Cloud Foundry. (Platform)
README
# Cloud Foundry Staticfile Buildpack
[ Join us on Slack](https://cloudfoundry.slack.com/messages/buildpacks/)
A Cloud Foundry [buildpack](https://docs.cloudfoundry.org/buildpacks/) for static content such as websites (HTML/JS/CSS).
### Buildpack User Documentation
Official buildpack documentation can be found at [staticfile buildpack docs](https://docs.cloudfoundry.org/buildpacks/staticfile/index.html).
### 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.
```bash
source .envrc
```
To simplify the process in the future, install [direnv](https://direnv.net/) which will automatically source .envrc when you change directories.
1. Install buildpack-packager
```bash
go install github.com/cloudfoundry/libbuildpack/packager/buildpack-packager
```
1. Build the buildpack
```bash
buildpack-packager build [ --cached=(true|false) ]
```
1. 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
To test this buildpack, run the following commands from the buildpack's directory:
1. Source the .envrc file in the buildpack directory.
```bash
source .envrc
```
To simplify the process in the future, install [direnv](https://direnv.net/) which will automatically source .envrc when you change directories.
1. Run unit tests
```bash
./scripts/unit.sh
```
1. Run integration tests
Buildpacks use the [Cutlass](https://github.com/cloudfoundry/libbuildpack/tree/master/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](https://github.com/cloudfoundry/cli):
```bash
cf login -a https://api.your-cf.com -u [email protected] -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:
```bash
./scripts/integration.sh
```
More information can be found on [here](https://github.com/cloudfoundry/libbuildpack/tree/master/cutlass).
### Contributing
Find our guidelines [here](./CONTRIBUTING.md).
### Help and Support
Join the #buildpacks channel in our [Slack community](https://slack.cloudfoundry.org/) if you need any further assistance.
### Reporting Issues
Open a GitHub issue on this project [here](https://github.com/cloudfoundry/staticfile/issues/new).
### Active Development
The project backlog is on [Pivotal Tracker](https://www.pivotaltracker.com/projects/1042066).
### Acknowledgements
This buildpack is based heavily upon Jordon Bedwell's Heroku buildpack and the modifications by David Laing for Cloud Foundry [nginx-buildpack (deprecated)](https://github.com/cloudfoundry-community/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!
If you require additional custom NGINX configuration, use the new [nginx-buildpack](https://github.com/cloudfoundry/nginx-buildpack).