From 8ab13421101a4bca28678f3d3b650bb987e26389 Mon Sep 17 00:00:00 2001 From: Gurpreet Atwal Date: Sat, 18 Jul 2020 13:25:35 -0700 Subject: [PATCH] docs: add more details to `nginx-dokku-template-source` trigger [ci skip] --- docs/development/plugin-triggers.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/development/plugin-triggers.md b/docs/development/plugin-triggers.md index 862c78978..05dd41e2b 100644 --- a/docs/development/plugin-triggers.md +++ b/docs/development/plugin-triggers.md @@ -856,9 +856,9 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x ### `nginx-dokku-template-source` -- Description: Customize the source location of the `dokku.conf` nginx configuration file +- Description: Return the path to a `sigil` template that should be used to generate the `dokku.conf` nginx configuration file. - Invoked by: `nginx-vhosts#install` -- Arguments: +- Arguments: None, however the `sigil` template can make use of the following variables: `$.DOKKU_ROOT $.NGINX_ROOT` - Example: ```shell @@ -866,9 +866,11 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x -# TODO +echo "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/dokku.conf.sigil" ``` +The default template is viewable here: [plugins/nginx-vhosts/templates/dokku.conf.sigil](https://github.com/dokku/dokku/blob/master/plugins/nginx-vhosts/templates/dokku.conf.sigil) + ### `nginx-hostname` - Description: Allows you to customize the hostname for a given app