From 14d5355655070ab83d6064e8d4bd7ec475ed83ba Mon Sep 17 00:00:00 2001 From: Jan Larwig Date: Sat, 3 May 2025 21:44:30 +0200 Subject: [PATCH] docs: add note about version obfuscation to footer option (#3051) Signed-off-by: Jan Larwig --- docs/docs/configuration/overview.md | 2 +- docs/versioned_docs/version-7.6.x/configuration/overview.md | 2 +- docs/versioned_docs/version-7.7.x/configuration/overview.md | 2 +- docs/versioned_docs/version-7.8.x/configuration/overview.md | 2 +- docs/versioned_docs/version-7.9.x/configuration/overview.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docs/configuration/overview.md b/docs/docs/configuration/overview.md index 33f87072..bea70617 100644 --- a/docs/docs/configuration/overview.md +++ b/docs/docs/configuration/overview.md @@ -174,7 +174,7 @@ Provider specific options can be found on their respective subpages. | flag: `--custom-sign-in-logo`
toml: `custom_sign_in_logo` | string | path or a URL to an custom image for the sign_in page logo. Use `"-"` to disable default logo. | | flag: `--custom-templates-dir`
toml: `custom_templates_dir` | string | path to custom html templates | | | flag: `--display-htpasswd-form`
toml: `display_htpasswd_form` | bool | display username / password login form if an htpasswd file is provided | true | -| flag: `--footer`
toml: `footer` | string | custom (html) footer string. Use `"-"` to disable default footer. | | +| flag: `--footer`
toml: `footer` | string | custom (html) footer string. Use `"-"` to disable default footer. (Can be used to obfuscate the version) | | | flag: `--show-debug-on-error`
toml: `show_debug_on_error` | bool | show detailed error information on error pages (WARNING: this may contain sensitive information - do not use in production) | false | ### Probe Options diff --git a/docs/versioned_docs/version-7.6.x/configuration/overview.md b/docs/versioned_docs/version-7.6.x/configuration/overview.md index e43a71c4..b7891156 100644 --- a/docs/versioned_docs/version-7.6.x/configuration/overview.md +++ b/docs/versioned_docs/version-7.6.x/configuration/overview.md @@ -172,7 +172,7 @@ Provider specific options can be found on their respective subpages. | flag: `--custom-sign-in-logo`
toml: `custom_sign_in_logo` | string | path or a URL to an custom image for the sign_in page logo. Use `"-"` to disable default logo. | | flag: `--custom-templates-dir`
toml: `custom_templates_dir` | string | path to custom html templates | | | flag: `--display-htpasswd-form`
toml: `display_htpasswd_form` | bool | display username / password login form if an htpasswd file is provided | true | -| flag: `--footer`
toml: `footer` | string | custom (html) footer string. Use `"-"` to disable default footer. | | +| flag: `--footer`
toml: `footer` | string | custom (html) footer string. Use `"-"` to disable default footer. (Can be used to obfuscate the version) | | | flag: `--show-debug-on-error`
toml: `show_debug_on_error` | bool | show detailed error information on error pages (WARNING: this may contain sensitive information - do not use in production) | false | ### Probe Options diff --git a/docs/versioned_docs/version-7.7.x/configuration/overview.md b/docs/versioned_docs/version-7.7.x/configuration/overview.md index d43e86ce..7c7b396f 100644 --- a/docs/versioned_docs/version-7.7.x/configuration/overview.md +++ b/docs/versioned_docs/version-7.7.x/configuration/overview.md @@ -172,7 +172,7 @@ Provider specific options can be found on their respective subpages. | flag: `--custom-sign-in-logo`
toml: `custom_sign_in_logo` | string | path or a URL to an custom image for the sign_in page logo. Use `"-"` to disable default logo. | | flag: `--custom-templates-dir`
toml: `custom_templates_dir` | string | path to custom html templates | | | flag: `--display-htpasswd-form`
toml: `display_htpasswd_form` | bool | display username / password login form if an htpasswd file is provided | true | -| flag: `--footer`
toml: `footer` | string | custom (html) footer string. Use `"-"` to disable default footer. | | +| flag: `--footer`
toml: `footer` | string | custom (html) footer string. Use `"-"` to disable default footer. (Can be used to obfuscate the version) | | | flag: `--show-debug-on-error`
toml: `show_debug_on_error` | bool | show detailed error information on error pages (WARNING: this may contain sensitive information - do not use in production) | false | ### Probe Options diff --git a/docs/versioned_docs/version-7.8.x/configuration/overview.md b/docs/versioned_docs/version-7.8.x/configuration/overview.md index 69f218bf..97b166df 100644 --- a/docs/versioned_docs/version-7.8.x/configuration/overview.md +++ b/docs/versioned_docs/version-7.8.x/configuration/overview.md @@ -173,7 +173,7 @@ Provider specific options can be found on their respective subpages. | flag: `--custom-sign-in-logo`
toml: `custom_sign_in_logo` | string | path or a URL to an custom image for the sign_in page logo. Use `"-"` to disable default logo. | | flag: `--custom-templates-dir`
toml: `custom_templates_dir` | string | path to custom html templates | | | flag: `--display-htpasswd-form`
toml: `display_htpasswd_form` | bool | display username / password login form if an htpasswd file is provided | true | -| flag: `--footer`
toml: `footer` | string | custom (html) footer string. Use `"-"` to disable default footer. | | +| flag: `--footer`
toml: `footer` | string | custom (html) footer string. Use `"-"` to disable default footer. (Can be used to obfuscate the version) | | | flag: `--show-debug-on-error`
toml: `show_debug_on_error` | bool | show detailed error information on error pages (WARNING: this may contain sensitive information - do not use in production) | false | ### Probe Options diff --git a/docs/versioned_docs/version-7.9.x/configuration/overview.md b/docs/versioned_docs/version-7.9.x/configuration/overview.md index 33f87072..bea70617 100644 --- a/docs/versioned_docs/version-7.9.x/configuration/overview.md +++ b/docs/versioned_docs/version-7.9.x/configuration/overview.md @@ -174,7 +174,7 @@ Provider specific options can be found on their respective subpages. | flag: `--custom-sign-in-logo`
toml: `custom_sign_in_logo` | string | path or a URL to an custom image for the sign_in page logo. Use `"-"` to disable default logo. | | flag: `--custom-templates-dir`
toml: `custom_templates_dir` | string | path to custom html templates | | | flag: `--display-htpasswd-form`
toml: `display_htpasswd_form` | bool | display username / password login form if an htpasswd file is provided | true | -| flag: `--footer`
toml: `footer` | string | custom (html) footer string. Use `"-"` to disable default footer. | | +| flag: `--footer`
toml: `footer` | string | custom (html) footer string. Use `"-"` to disable default footer. (Can be used to obfuscate the version) | | | flag: `--show-debug-on-error`
toml: `show_debug_on_error` | bool | show detailed error information on error pages (WARNING: this may contain sensitive information - do not use in production) | false | ### Probe Options