diff --git a/README.md b/README.md index 61517bc..e659d37 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,17 @@ 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 (for example `dokku config:set NGINX_ROOT=_site` if you are deploying a Jekyll site). +### Custom nginx root + +You can override the nginx root via setting the `NGINX_ROOT` environment variable. This should be a relative path in your repository. + +```shell +# where the app is named `static-app` +# and the root dir is _site +dokku config:set static-app NGINX_ROOT=_site +```` + +### Custom nginx config file You may completely override the built-in nginx config by placing an `app-nginx.conf.sigil` file in the root, modeled after our own [`conf/app-nginx.conf.sigil`](https://github.com/dokku/buildpack-nginx/blob/master/conf/app-nginx.conf.sigil). This will be used inside of the container, and not by the host Dokku instance. See the [sigil project](https://github.com/gliderlabs/sigil) for more information concerning the sigil format.