Update README.md

This commit is contained in:
Florian Heinemann 2014-11-18 19:32:20 -05:00
parent 1ed618d5f3
commit 6ed8f5fa6d
1 changed files with 2 additions and 2 deletions

View File

@ -1,12 +1,12 @@
# NGINX Buildpack for Dokku - Hosting static pages
This buildpack has been successfully run on Digital Ocean instances of Ubuntu 14.04 (Status: Nov 2014). It might also work in different configurations.
This buildpack has been successfully run on Digital Ocean instances of Ubuntu 14.04 (Status: Nov 2014). It might also work with different configurations.
## Purpose
`buildpack-nginx` provides a simple, low overhead way of hosting stages pages and websites on Dokku. Just add the `.env` and `.static` file to the root directory of your website as described below.
## Usage
1. Add a file with the name `.env` in the root of your directory with the following content: `export BUILDPACK_URL=https://github.com/florianheinemann/buildpack-nginx.git`
2. Add another, *empty* file called `.static` in your root directory of your web project
2. Add another, *empty* file called `.static` to your root directory of your web project
3. Push your project to Dokku
All static files that you want to serve should be in the root directory of your repository. No need to use a seperate `www` folder. `buildpack-nginx` will automatically download the buildpack, download NGINX, compile it, and install it. The next time you push your project, the buildpack will reuse the precompiled binaries.