kawaiipunk/buildpack-nginx
1
0
Fork 0
mirror of https://github.com/dokku/buildpack-nginx.git synced 2024-12-26 14:05:24 +00:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jose Diaz-Gonzalez 2016-06-30 14:27:22 -04:00 committed by GitHub
parent 513791b391
commit d4f83febf9
1 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,20 +1,34 @@
# NGINX Buildpack for Dokku - Hosting static pages
This buildpack has been successfully run on Digital Ocean instances of Ubuntu 14.04 (Status: Jan 2015). It might also work with different configurations.
# Dokku Buildpack: nginx
## Purpose
`buildpack-nginx` provides a simple, low overhead way of hosting static pages and websites on Dokku. Just add the `.env` and `.static` file to the root directory of your website as described below.
This is the official dokku buildpack for static websites, powered by nginx.
## 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/dokku/buildpack-nginx.git`
2. Add another, *empty* file called `.static` to your root directory of your web project. It signals that this buildpack shall be used
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.
## NGINX CONFIGURATION
Override default configuration by adding `nginx.conf.erb` in the root directory. You can also override the nginx root by setting `$NGINX_ROOT`
### Dokku
To trigger detection of this buildpack in Dokku, you have two options:
- Automatic: Add an *empty* file called `.static` to your root directory of your web project.
- Manual: Set your `BUILDPACK_URL` via `dokku config:set BUILDPACK_URL=https://github.com/dokku/buildpack-nginx.git`
### Heroku
Heroku users can use this buildpack by running the following command:
```
heroku buildpacks:set https://github.com/dokku/buildpack-nginx.git
```
## Configuration
You can override the nginx root via setting the `NGINX_ROOT` environment variable. This should be a relative path in your repository.
You may completely override the built-in nginx config by placing an `nginx.conf.erb` file in the root, modeled after our own [`conf/nginx.config.erb`](https://github.com/dokku/buildpack-nginx/blob/master/conf/nginx.conf.erb). This will be used inside of the container, and not by the host Dokku instance.
## Credits and License
`buildpack-nginx` is licensed under the CC0 1.0 Universal license and has been informed by many similar projects on the web
`buildpack-nginx` is licensed under the CC0 1.0 Universal license and has been informed by many similar projects on the web.
[Florian Heinemann](http://twitter.com/TheSumOfAll/)