diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index b78209d87..47fd451f7 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -32,7 +32,7 @@ ### Additional information - Container Inspect Output (if applicable) via `dokku ps:inspect APP_NAME` -- The nginx configuration (if applicable) via `dokku nginx:show-conf APP_NAME` +- The nginx configuration (if applicable) via `dokku nginx:show-config APP_NAME` - Link to the exact repository being deployed (if possible/applicable): - If a deploy is failing or behaving unexpectedly: - Application name diff --git a/docs/appendices/0.20.0-migration-guide.md b/docs/appendices/0.20.0-migration-guide.md index 79abc6bfc..16ff323b6 100644 --- a/docs/appendices/0.20.0-migration-guide.md +++ b/docs/appendices/0.20.0-migration-guide.md @@ -1,8 +1,8 @@ # 0.20.0 Migration Guide -## Deprecated command removal +## Removals -The following commands have been deprecated and were removed in this release. +The following commands were previously deprecated and were removed in this release. - `apps`: Use `apps:list` instead. - `certs`: Use `certs:report` instead. @@ -13,3 +13,7 @@ The following commands have been deprecated and were removed in this release. - `plugin`: Use `plugin:list` instead. - `proxy`: Use `proxy:report` instead. - `trace`: Use `trace:on` or `trace:off` instead. + +## Deprecations + +- `nginx:show-conf` has been deprecated in favor of `nginx:show-config`. diff --git a/docs/configuration/nginx.md b/docs/configuration/nginx.md index b8e99825c..8a620f185 100644 --- a/docs/configuration/nginx.md +++ b/docs/configuration/nginx.md @@ -8,7 +8,7 @@ nginx:build-config # (Re)builds nginx config for given app nginx:error-logs [-t] # Show the nginx error logs for an application (-t follows) nginx:report [] [] # Displays a nginx report for one or more apps nginx:set () # Set or clear an nginx property for an app -nginx:show-conf # Display app nginx config +nginx:show-config # Display app nginx config nginx:validate [] [--clean] # Validates and optionally cleans up invalid nginx configurations ``` @@ -92,10 +92,10 @@ dokku nginx:build-config node-js-app ## Showing the nginx config -For debugging purposes, it may be useful to show the nginx config. This can be achieved via the `nginx:show-conf` command. +For debugging purposes, it may be useful to show the nginx config. This can be achieved via the `nginx:show-config` command. ```shell -dokku nginx:show-conf node-js-app +dokku nginx:show-config node-js-app ``` ## Validating nginx configs diff --git a/plugins/nginx-vhosts/help-functions b/plugins/nginx-vhosts/help-functions index d8e660210..5f62064f1 100755 --- a/plugins/nginx-vhosts/help-functions +++ b/plugins/nginx-vhosts/help-functions @@ -32,7 +32,7 @@ fn-help-content() { nginx:error-logs [-t], Show the nginx error logs for an application (-t follows) nginx:report [] [], Displays an nginx report for one or more apps nginx:set (), Set or clear an nginx property for an app - nginx:show-conf , Display app nginx config + nginx:show-config , Display app nginx config nginx:validate [] [--clean], Validates and optionally cleans up invalid nginx configurations help_content } diff --git a/plugins/nginx-vhosts/internal-functions b/plugins/nginx-vhosts/internal-functions index 7fe7401a1..2c1e344de 100755 --- a/plugins/nginx-vhosts/internal-functions +++ b/plugins/nginx-vhosts/internal-functions @@ -70,6 +70,24 @@ cmd-nginx-report-single() { fi } +cmd-nginx-show-config() { + declare desc="display app nginx config" + declare cmd="nginx:show-config" + [[ "$1" == "$cmd" ]] && shift 1 + if [[ "$1" == "nginx:show-conf" ]]; then + dokku_log_warn "Deprecated: Please use nginx:show-config" + shift 1 + fi + declare APP="$1" + + verify_app_name "$APP" + if [[ ! -f "$DOKKU_ROOT/$APP/nginx.conf" ]]; then + dokku_log_fail "No nginx.conf exists for $APP" + fi + + cat "$DOKKU_ROOT/$APP/nginx.conf" +} + fn-nginx-vhosts-manage-hsts() { declare APP="$1" SSL_ENABLED="$2" local HSTS="$(fn-plugin-property-get-default "nginx" "$APP" "hsts" "true")" diff --git a/plugins/nginx-vhosts/subcommands/show-conf b/plugins/nginx-vhosts/subcommands/show-conf index 355463078..408a012e0 100755 --- a/plugins/nginx-vhosts/subcommands/show-conf +++ b/plugins/nginx-vhosts/subcommands/show-conf @@ -2,19 +2,6 @@ set -eo pipefail [[ $DOKKU_TRACE ]] && set -x source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions" +source "$PLUGIN_AVAILABLE_PATH/nginx-vhosts/internal-functions" -cmd-nginx-show-conf() { - declare desc="display app nginx config" - declare cmd="nginx:show-conf" - [[ "$1" == "$cmd" ]] && shift 1 - declare APP="$1" - - verify_app_name "$APP" - if [[ ! -f "$DOKKU_ROOT/$APP/nginx.conf" ]]; then - dokku_log_fail "No nginx.conf exists for $APP" - fi - - cat "$DOKKU_ROOT/$APP/nginx.conf" -} - -cmd-nginx-show-conf "$@" +cmd-nginx-show-config "$@" diff --git a/plugins/nginx-vhosts/subcommands/show-config b/plugins/nginx-vhosts/subcommands/show-config new file mode 100755 index 000000000..408a012e0 --- /dev/null +++ b/plugins/nginx-vhosts/subcommands/show-config @@ -0,0 +1,7 @@ +#!/usr/bin/env bash +set -eo pipefail +[[ $DOKKU_TRACE ]] && set -x +source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions" +source "$PLUGIN_AVAILABLE_PATH/nginx-vhosts/internal-functions" + +cmd-nginx-show-config "$@" diff --git a/tests/unit/40_nginx-vhosts_2.bats b/tests/unit/40_nginx-vhosts_2.bats index 15b4d91a5..32645a3ab 100644 --- a/tests/unit/40_nginx-vhosts_2.bats +++ b/tests/unit/40_nginx-vhosts_2.bats @@ -35,7 +35,7 @@ teardown() { add_domain "node-js-app.dokku.me" add_domain "test.dokku.me" deploy_app - dokku nginx:show-conf $TEST_APP + dokku nginx:show-config $TEST_APP assert_ssl_domain "node-js-app.dokku.me" assert_http_redirect "http://test.dokku.me" "https://test.dokku.me:443/" } @@ -45,7 +45,7 @@ teardown() { add_domain "wildcard1.dokku.me" add_domain "wildcard2.dokku.me" deploy_app - dokku nginx:show-conf $TEST_APP + dokku nginx:show-config $TEST_APP assert_ssl_domain "wildcard1.dokku.me" assert_ssl_domain "wildcard2.dokku.me" } @@ -55,8 +55,8 @@ teardown() { TEST_APP="${TEST_APP}.example.com" setup_test_tls wildcard deploy_app nodejs-express dokku@dokku.me:$TEST_APP - run /bin/bash -c "dokku nginx:show-conf $TEST_APP | grep -e '*.dokku.me' | wc -l" - dokku nginx:show-conf $TEST_APP + run /bin/bash -c "dokku nginx:show-config $TEST_APP | grep -e '*.dokku.me' | wc -l" + dokku nginx:show-config $TEST_APP assert_output "0" } @@ -200,7 +200,7 @@ teardown() { echo "status: $status" assert_success - run /bin/bash -c "dokku nginx:show-conf $TEST_APP" + run /bin/bash -c "dokku nginx:show-config $TEST_APP" echo "output: $output" echo "status: $status" assert_output_contains "[::1]:80;" @@ -221,7 +221,7 @@ teardown() { echo "status: $status" assert_success - run /bin/bash -c "dokku nginx:show-conf $TEST_APP" + run /bin/bash -c "dokku nginx:show-config $TEST_APP" echo "output: $output" echo "status: $status" assert_output_contains "[::1]:80;" 0