From a8f08bd5a86546178030b7ea1c45dd1a3c36c38a Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Tue, 21 Apr 2015 02:38:47 -0400 Subject: [PATCH] [ci skip] Add documentation for custom nginx.conf files Closes #998 Closes #1000 --- docs/nginx.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/nginx.md b/docs/nginx.md index 7f176a54f..947e7d15f 100644 --- a/docs/nginx.md +++ b/docs/nginx.md @@ -77,6 +77,12 @@ server { The above is a sample http configuration that adds an `X-Served-By` header to requests. The template file **must** be owned by the user `dokku:dokku`. +A few tips for custom nginx templates: + +- Special characters - dollar signs, spaces inside of quotes, etc. - should be escaped with a single backslash or can cause deploy failures. +- Templated files will be validated via `nginx -t`. +- Application environment variables can be used within your nginx configuration. + ## Customizing hostnames Applications typically have the following structure for their hostname: