From 0fdbfee5cae7677282055cb33ec07321e24d619e Mon Sep 17 00:00:00 2001 From: Sean Arms <67096+lesserwhirls@users.noreply.github.com> Date: Fri, 17 Jan 2025 12:34:17 -0700 Subject: [PATCH] Fix info, note, etc. content to build with variable substitution --- .../installation_upgrade/TdsBehindProxy.md | 5 +++-- .../site/pages/reference/TomcatManagerApp.md | 6 +++--- .../site/pages/securing/DigestedPasswords.md | 7 ++++--- .../site/pages/securing/RestrictAccessToTds.md | 9 ++++----- .../ModifyingTomcatAccessLogs.md | 8 +++----- .../getting_started/DeployingTheTds.md | 7 ++++--- .../getting_started/InstallJavaTomcat.md | 12 +++++++----- .../getting_started/TomcatManagerApp.md | 11 ++++++----- .../ModifyingTomcatAccessLogs.md | 8 +++----- docs/quickstart/src/site/pages/TLSEncryption.md | 5 ++++- .../getting_started/DeployingTheTds.md | 7 ++++--- .../getting_started/InstallJavaTomcat.md | 5 +++-- .../getting_started/TomcatManagerApp.md | 11 ++++++----- .../ModifyingTomcatAccessLogs.md | 8 +++----- .../production/DigestedPasswords.md | 7 ++++--- .../production/EnableTLSEncryption.md | 17 ++++++++++------- .../production/RestrictAccessToTds.md | 8 ++++---- .../tds_tutorial/production/TdsBehindProxy.md | 5 +++-- .../getting_started/DeployingTheTds.md | 7 ++++--- .../getting_started/InstallJavaTomcat.md | 5 +++-- .../getting_started/TomcatManagerApp.md | 11 ++++++----- .../ModifyingTomcatAccessLogs.md | 8 +++----- .../production/DigestedPasswords.md | 7 ++++--- .../production/EnableTLSEncryption.md | 15 +++++++++------ .../production/RestrictAccessToTds.md | 8 ++++---- .../tds_tutorial/production/TdsBehindProxy.md | 5 +++-- 26 files changed, 114 insertions(+), 98 deletions(-) diff --git a/docs/adminguide/src/site/pages/installation_upgrade/TdsBehindProxy.md b/docs/adminguide/src/site/pages/installation_upgrade/TdsBehindProxy.md index 23494fb215..6694311a59 100644 --- a/docs/adminguide/src/site/pages/installation_upgrade/TdsBehindProxy.md +++ b/docs/adminguide/src/site/pages/installation_upgrade/TdsBehindProxy.md @@ -188,9 +188,10 @@ The following example shows how to implement a proxy using the Apache HTTPD serv protocol="AJP/1.3" /> ~~~ - {% include info.html content=" + {% capture ajp_connector %} Consult the Tomcat documentation for more information about the [AJP Connector](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/ajp.html){:target='_blank'} configuration options. - " %} + {% endcapture %} + {% include info.html content=ajp_connector %} 2. Disable any active `Java HTTP/1.1 Connector` and the `SSL HTTP/1.1 Connector` Tomcat connectors. diff --git a/docs/adminguide/src/site/pages/reference/TomcatManagerApp.md b/docs/adminguide/src/site/pages/reference/TomcatManagerApp.md index 986bd24a26..597a272fb5 100644 --- a/docs/adminguide/src/site/pages/reference/TomcatManagerApp.md +++ b/docs/adminguide/src/site/pages/reference/TomcatManagerApp.md @@ -57,10 +57,10 @@ This will be done in the following 2 steps: ~~~ - {%include note.html content=" + {% capture context_config %} For more information about web application context configuration files and their security options, please review the [Tomcat Manager App How-To](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/manager-howto.html#Introduction){:target='_blank'} documentation. - " %} - + {% endcapture %} + {% include info.html content=context_config %} #### II. Modify `tomcat-users.xml` diff --git a/docs/adminguide/src/site/pages/securing/DigestedPasswords.md b/docs/adminguide/src/site/pages/securing/DigestedPasswords.md index 48e6997f09..3d7e6e6fc4 100644 --- a/docs/adminguide/src/site/pages/securing/DigestedPasswords.md +++ b/docs/adminguide/src/site/pages/securing/DigestedPasswords.md @@ -97,9 +97,10 @@ A Tomcat Realm represents a "database" of usernames, passwords, and roles assign supersecretpassword:bb7a2b6cf8da7122125c663fc1585808170b2027677195e0ad121f87b27320ae$1$55003acb56e907b19d29d3b4211dc98c837354690bc90579742d6747efeec4ea ~~~ - {% include note.html content=" - To use a different algorithm, a salt, or to limit the length of the resulting password hash, consult the [syntax options](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/realm-howto.html#Digested_Passwords){:target='_blank'} for the `tomcat_home/bin/digest.[bat|sh]` script. - " %} + {% capture algo %} + To use a different algorithm, a salt, or to limit the length of the resulting password hash, consult the [syntax options](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/realm-howto.html#Digested_Passwords){:target='_blank'} for the `tomcat_home/bin/digest.[bat|sh]` script. + {% endcapture %} + {% include info.html content=algo %} 3. Update `${tomcat_home}/conf/tomcat-users.xml` to replace your clear-text password with the encrypted version: diff --git a/docs/adminguide/src/site/pages/securing/RestrictAccessToTds.md b/docs/adminguide/src/site/pages/securing/RestrictAccessToTds.md index 9784b5676d..1fbd2848a8 100644 --- a/docs/adminguide/src/site/pages/securing/RestrictAccessToTds.md +++ b/docs/adminguide/src/site/pages/securing/RestrictAccessToTds.md @@ -64,11 +64,10 @@ The `RemoteHostValve` compares the client hostname against one or more regular e deny=".*\.bandwidthhogs\.com" /> ~~~ -{% capture remote_host_valve %} - Consult the Tomcat [Remote Host Valve](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/valve.html#Remote_Host_Valve){:target='_blank'} documentation for more information about valve syntax and options. -{% endcapture %} - - {% include info.html content=remote_host_valve%} + {% capture remote_host_valve %} + Consult the Tomcat [Remote Host Valve](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/valve.html#Remote_Host_Valve){:target='_blank'} documentation for more information about valve syntax and options. + {% endcapture %} + {% include info.html content=remote_host_valve%} ## Limit Access To Parts Or Entire TDS By User/Role diff --git a/docs/adminguide/src/site/pages/support_troubleshooting/ModifyingTomcatAccessLogs.md b/docs/adminguide/src/site/pages/support_troubleshooting/ModifyingTomcatAccessLogs.md index 5db4a6c1cb..9a3afcd072 100644 --- a/docs/adminguide/src/site/pages/support_troubleshooting/ModifyingTomcatAccessLogs.md +++ b/docs/adminguide/src/site/pages/support_troubleshooting/ModifyingTomcatAccessLogs.md @@ -108,12 +108,10 @@ The access log entry format we are using is almost identical to the standard com pattern="%h %l %u %t "%r" %s %b "%{Referer}i" "%{User-Agent}i" %D" ~~~ - - -{%include note.html content=" +{% capture logfmt %} For more information on access log format configuration, see the Tomcat [Valve Component](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/valve.html){:target='_blank'} documentation. -" %} - +{% endcapture %} +{% include info.html content=logfmt %} The above pattern makes use of the following codes: diff --git a/docs/devguide/src/site/pages/tds_tutorial/getting_started/DeployingTheTds.md b/docs/devguide/src/site/pages/tds_tutorial/getting_started/DeployingTheTds.md index 5fdb89bd0e..e40c8eeffa 100644 --- a/docs/devguide/src/site/pages/tds_tutorial/getting_started/DeployingTheTds.md +++ b/docs/devguide/src/site/pages/tds_tutorial/getting_started/DeployingTheTds.md @@ -38,10 +38,11 @@ This section assumes you have successfully installed the JDK and Tomcat Servlet ~~~ - {%include note.html content=" + {% capture context %} Consult the Tomcat documentation about [web application context](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/context.html){:target='_blank'} for more information about the `META-INF/context.xml` file. - " %} - + {% endcapture %} + {% include info.html content=context %} + The down-side of renaming the WAR file to merely `thredds.war` is that a quick glance at the WAR file will not tell you (the server administrator) which version of the TDS is deployed. diff --git a/docs/devguide/src/site/pages/tds_tutorial/getting_started/InstallJavaTomcat.md b/docs/devguide/src/site/pages/tds_tutorial/getting_started/InstallJavaTomcat.md index 0917657b5d..ec6e889728 100644 --- a/docs/devguide/src/site/pages/tds_tutorial/getting_started/InstallJavaTomcat.md +++ b/docs/devguide/src/site/pages/tds_tutorial/getting_started/InstallJavaTomcat.md @@ -25,9 +25,10 @@ While there are different distributors of Java and servlet containers, Unidata d The following example shows the JDK installation on a linux system. The installation is being performed as the `root` user. -{% include note.html content=" -For installation of the JDK on Windows or Mac OS, see the [JDK Installation Guide](https://https://adoptium.net/installation/){:target='_blank'}. -" %} +{% capture tomcatinstall %} +For installation of Tomcat on Windows, see the [Tomcat Setup Guide](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/setup.html#Windows){:target='_blank'}. +{% endcapture %} +{% include info.html content=tomcatinstall %} 1. [Download](https://adoptium.net/){:target="_blank"} current OpenJDK {{ site.java_version }} (LTS) JDK version from the Adoptium site. @@ -82,9 +83,10 @@ The following example shows Tomcat installation on a linux system. (This type of installation will work on Mac OS systems as well.) The installation is performed as the `root` user. -{% include note.html content=" +{% capture tomcatinstall %} For installation of Tomcat on Windows, see the [Tomcat Setup Guide](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/setup.html#Windows){:target='_blank'}. -" %} +{% endcapture %} +{% include info.html content=tomcatinstall %} {%- assign tomcat_version_split = site.tomcat_version | split: '.' -%} {%- assign tomcat_version_split = tomcat_version_split[0] -%} diff --git a/docs/devguide/src/site/pages/tds_tutorial/getting_started/TomcatManagerApp.md b/docs/devguide/src/site/pages/tds_tutorial/getting_started/TomcatManagerApp.md index fd13dd5988..0a3b0405a3 100644 --- a/docs/devguide/src/site/pages/tds_tutorial/getting_started/TomcatManagerApp.md +++ b/docs/devguide/src/site/pages/tds_tutorial/getting_started/TomcatManagerApp.md @@ -19,9 +19,10 @@ This section assumes you have successfully installed the JDK and Tomcat Servlet * Allows Tomcat administrators to deploy, un-deploy, or reload web applications such as the TDS without having to shut down and restart Tomcat. * Provides server status statistics for the JVM and each connector you have configured in `${tomcat_home}/conf/server.xml`. -{%include note.html content= +{% capture tcmanager %} "For more information about the Tomcat manager application, see the [Tomcat Manager App HOW-TO](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/manager-howto.html){:target='_blank'} documentation. -" %} +{% endcapture %} +{% include info.html content=tcmanager %} ## Accessing The Manager Application @@ -57,10 +58,10 @@ This will be done in the following 2 steps: ~~~ - {%include note.html content=" + {% capture context_config %} For more information about web application context configuration files and their security options, please review the [Tomcat Manager App How-To](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/manager-howto.html#Introduction){:target='_blank'} documentation. - " %} - + {% endcapture %} + {% include info.html content=context_config %} #### II. Modify `tomcat-users.xml` diff --git a/docs/devguide/src/site/pages/tds_tutorial/monitoring_and_debugging/ModifyingTomcatAccessLogs.md b/docs/devguide/src/site/pages/tds_tutorial/monitoring_and_debugging/ModifyingTomcatAccessLogs.md index d156674c61..7fdb460c86 100644 --- a/docs/devguide/src/site/pages/tds_tutorial/monitoring_and_debugging/ModifyingTomcatAccessLogs.md +++ b/docs/devguide/src/site/pages/tds_tutorial/monitoring_and_debugging/ModifyingTomcatAccessLogs.md @@ -103,12 +103,10 @@ The access log entry format we are using is almost identical to the standard com pattern="%h %l %u %t "%r" %s %b "%{Referer}i" "%{User-Agent}i" %D" ~~~ - - -{%include note.html content=" +{% capture logfmt %} For more information on access log format configuration, see the Tomcat [Valve Component](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/valve.html){:target='_blank'} documentation. -" %} - +{% endcapture %} +{% include info.html content=logfmt %} The above pattern makes use of the following codes: diff --git a/docs/quickstart/src/site/pages/TLSEncryption.md b/docs/quickstart/src/site/pages/TLSEncryption.md index 3b3d2790ff..0ebfdce95b 100644 --- a/docs/quickstart/src/site/pages/TLSEncryption.md +++ b/docs/quickstart/src/site/pages/TLSEncryption.md @@ -97,8 +97,11 @@ The following example demonstrates enabling Transport Layer Security in the Tomc ~~~ - Note: Tomcat also offers a `SSL/TLS HTTP/1.1 Connector` which utilizes `APR/native implementation`. + {% capture connector %} + Tomcat also offers a `SSL/TLS HTTP/1.1 Connector` which utilizes `APR/native implementation`. Consult the [Documentation](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/http.html){:target='_blank'} to see if you should use this connector in lieu of the `NIO implementation SSL HTTP/1.1` connector. + {% endcapture %} + {% include info.html content=connector %} Specify the keystore file in the `certificateKeystoreFile` attribute of the `Certificate` element to tell Tomcat where to find your keystore (the path will be relative to `${tomcat_home}` directory). diff --git a/docs/quickstart/src/site/pages/tds_tutorial/getting_started/DeployingTheTds.md b/docs/quickstart/src/site/pages/tds_tutorial/getting_started/DeployingTheTds.md index b9e8c2f6c1..2e19ddfd25 100644 --- a/docs/quickstart/src/site/pages/tds_tutorial/getting_started/DeployingTheTds.md +++ b/docs/quickstart/src/site/pages/tds_tutorial/getting_started/DeployingTheTds.md @@ -37,10 +37,11 @@ This section assumes you have successfully installed the JDK and Tomcat Servlet ~~~ - - {%include note.html content=" + + {% capture context %} Consult the Tomcat documentation about [web application context](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/context.html){:target='_blank'} for more information about the `META-INF/context.xml` file. - " %} + {% endcapture %} + {% include info.html content=context %} The down-side of renaming the WAR file to merely `thredds.war` is that a quick glance at the WAR file will not tell you (the server administrator) which version of the TDS is deployed. diff --git a/docs/quickstart/src/site/pages/tds_tutorial/getting_started/InstallJavaTomcat.md b/docs/quickstart/src/site/pages/tds_tutorial/getting_started/InstallJavaTomcat.md index 3356d6efbe..39df6df7b9 100644 --- a/docs/quickstart/src/site/pages/tds_tutorial/getting_started/InstallJavaTomcat.md +++ b/docs/quickstart/src/site/pages/tds_tutorial/getting_started/InstallJavaTomcat.md @@ -82,9 +82,10 @@ The following example shows Tomcat installation on a linux system. (This type of installation will work on Mac OS systems as well.) The installation is performed as the `root` user. -{% include note.html content=" +{% capture tomcatinstall %} For installation of Tomcat on Windows, see the [Tomcat Setup Guide](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/setup.html#Windows){:target='_blank'}. -" %} +{% endcapture %} +{% include info.html content=tomcatinstall %} {%- assign tomcat_version_split = site.tomcat_version | split: '.' -%} {%- assign tomcat_version_split = tomcat_version_split[0] -%} diff --git a/docs/quickstart/src/site/pages/tds_tutorial/getting_started/TomcatManagerApp.md b/docs/quickstart/src/site/pages/tds_tutorial/getting_started/TomcatManagerApp.md index 9497bdb619..a99a5fa762 100644 --- a/docs/quickstart/src/site/pages/tds_tutorial/getting_started/TomcatManagerApp.md +++ b/docs/quickstart/src/site/pages/tds_tutorial/getting_started/TomcatManagerApp.md @@ -19,9 +19,10 @@ This section assumes you have successfully installed the JDK and Tomcat Servlet * Allows Tomcat administrators to deploy, un-deploy, or reload web applications such as the TDS without having to shut down and restart Tomcat. * Provides server status statistics for the JVM and each connector you have configured in `${tomcat_home}/conf/server.xml`. -{%include note.html content= +{% capture tcmanager %} "For more information about the Tomcat manager application, see the [Tomcat Manager App HOW-TO](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/manager-howto.html){:target='_blank'} documentation. -" %} +{% endcapture %} +{% include info.html content=tcmanager %} ## Accessing The Manager Application @@ -57,10 +58,10 @@ This will be done in the following 2 steps: ~~~ - {%include note.html content=" + {% capture context_config %} For more information about web application context configuration files and their security options, please review the [Tomcat Manager App How-To](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/manager-howto.html#Introduction){:target='_blank'} documentation. - " %} - + {% endcapture %} + {% include info.html content=context_config %} #### II. Modify `tomcat-users.xml` diff --git a/docs/quickstart/src/site/pages/tds_tutorial/monitoring_and_debugging/ModifyingTomcatAccessLogs.md b/docs/quickstart/src/site/pages/tds_tutorial/monitoring_and_debugging/ModifyingTomcatAccessLogs.md index 85f8a09097..0c77485409 100644 --- a/docs/quickstart/src/site/pages/tds_tutorial/monitoring_and_debugging/ModifyingTomcatAccessLogs.md +++ b/docs/quickstart/src/site/pages/tds_tutorial/monitoring_and_debugging/ModifyingTomcatAccessLogs.md @@ -103,12 +103,10 @@ The access log entry format we are using is almost identical to the standard com pattern="%h %l %u %t "%r" %s %b "%{Referer}i" "%{User-Agent}i" %D" ~~~ - - -{%include note.html content=" +{% capture logfmt %} For more information on access log format configuration, see the Tomcat [Valve Component](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/valve.html){:target='_blank'} documentation. -" %} - +{% endcapture %} +{% include info.html content=logfmt %} The above pattern makes use of the following codes: diff --git a/docs/quickstart/src/site/pages/tds_tutorial/production/DigestedPasswords.md b/docs/quickstart/src/site/pages/tds_tutorial/production/DigestedPasswords.md index 4be08789b5..c9ce7bd17f 100644 --- a/docs/quickstart/src/site/pages/tds_tutorial/production/DigestedPasswords.md +++ b/docs/quickstart/src/site/pages/tds_tutorial/production/DigestedPasswords.md @@ -92,9 +92,10 @@ A Tomcat Realm represents a "database" of usernames, passwords, and roles assign supersecretpassword:bb7a2b6cf8da7122125c663fc1585808170b2027677195e0ad121f87b27320ae$1$55003acb56e907b19d29d3b4211dc98c837354690bc90579742d6747efeec4ea ~~~ - {% include note.html content=" - To use a different algorithm, a salt, or to limit the length of the resulting password hash, consult the [syntax options](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/realm-howto.html#Digested_Passwords){:target='_blank'} for the `tomcat_home/bin/digest.[bat|sh]` script. - " %} + {% capture algo %} + To use a different algorithm, a salt, or to limit the length of the resulting password hash, consult the [syntax options](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/realm-howto.html#Digested_Passwords){:target='_blank'} for the `tomcat_home/bin/digest.[bat|sh]` script. + {% endcapture %} + {% include info.html content=algo %} 3. Update `${tomcat_home}/conf/tomcat-users.xml` to replace your clear-text password with the encrypted version: diff --git a/docs/quickstart/src/site/pages/tds_tutorial/production/EnableTLSEncryption.md b/docs/quickstart/src/site/pages/tds_tutorial/production/EnableTLSEncryption.md index 4bb5010b77..912a2d2a87 100644 --- a/docs/quickstart/src/site/pages/tds_tutorial/production/EnableTLSEncryption.md +++ b/docs/quickstart/src/site/pages/tds_tutorial/production/EnableTLSEncryption.md @@ -49,11 +49,12 @@ Tomcat uses the keystore file for TLS/SSL transactions. ## Enabling TLS/SSL In Tomcat -The following example demonstrates enabling TLS/SSL in the Tomcat Servlet Container on a linux system as the `root` user. +The following example demonstrates enabling TLS/SSL in the Tomcat Servlet Container on a linux system as the `root` user. -{%include note.html content=" +{% capture cert %} This section assumes you have already imported your CA-signed certificate into the [keystore](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/ssl-howto.html#Prepare_the_Certificate_Keystore){:target='_blank'} file. -" %} +{% endcapture %} +{% include info.html content=cert %} 1. Modify the Tomcat configuration to enable TLS/SSL: @@ -84,10 +85,12 @@ This section assumes you have already imported your CA-signed certificate into t ~~~ - - {%include note.html content=" - Tomcat also offers a `SSL/TLS HTTP/1.1 Connector` which utilizes `APR/native implementation`. Consult the [Documentation](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/http.html){:target='_blank'} to see if you should use this connector in lieu of the `NIO implementation SSL HTTP/1.1` connector. - " %} + + {% capture connector %} + Tomcat also offers a `SSL/TLS HTTP/1.1 Connector` which utilizes `APR/native implementation`. + Consult the [Documentation](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/http.html){:target='_blank'} to see if you should use this connector in lieu of the `NIO implementation SSL HTTP/1.1` connector. + {% endcapture %} + {% include info.html content=connector %} Specify the keystore file in the `certificateKeystoreFile` attribute of the `Certificate` element to tell Tomcat where to find your keystore (the path will be relative to `${tomcat_home}` directory). diff --git a/docs/quickstart/src/site/pages/tds_tutorial/production/RestrictAccessToTds.md b/docs/quickstart/src/site/pages/tds_tutorial/production/RestrictAccessToTds.md index a552573415..71d7fbe684 100644 --- a/docs/quickstart/src/site/pages/tds_tutorial/production/RestrictAccessToTds.md +++ b/docs/quickstart/src/site/pages/tds_tutorial/production/RestrictAccessToTds.md @@ -62,10 +62,10 @@ The `RemoteHostValve` compares the client hostname against one or more regular e deny=".*\.bandwidthhogs\.com" /> ~~~ - {%include note.html content=" - Consult the Tomcat [Remote Host Valve](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/valve.html#Remote_Host_Valve){:target='_blank'} documentation for more information about valve syntax and options. - " %} - + {% capture remote_host_valve %} + Consult the Tomcat [Remote Host Valve](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/valve.html#Remote_Host_Valve){:target='_blank'} documentation for more information about valve syntax and options. + {% endcapture %} + {% include info.html content=remote_host_valve%} ## Restrict Access Via Web Application Deployment Descriptor diff --git a/docs/quickstart/src/site/pages/tds_tutorial/production/TdsBehindProxy.md b/docs/quickstart/src/site/pages/tds_tutorial/production/TdsBehindProxy.md index 1410049ade..18f9002a84 100644 --- a/docs/quickstart/src/site/pages/tds_tutorial/production/TdsBehindProxy.md +++ b/docs/quickstart/src/site/pages/tds_tutorial/production/TdsBehindProxy.md @@ -210,9 +210,10 @@ The following example shows how to implement a proxy using the Apache HTTPD serv protocol="AJP/1.3" /> ~~~ - {% include note.html content=" + {% capture ajp_connector %} Consult the Tomcat documentation for more information about the [AJP Connector](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/ajp.html){:target='_blank'} configuration options. - " %} + {% endcapture %} + {% include info.html content=ajp_connector %} 2. Disable any active `Java HTTP/1.1 Connector` and the `SSL HTTP/1.1 Connector` Tomcat connectors. diff --git a/docs/userguide/src/site/pages/tds_tutorial/getting_started/DeployingTheTds.md b/docs/userguide/src/site/pages/tds_tutorial/getting_started/DeployingTheTds.md index b4070ce310..743ef1b47c 100644 --- a/docs/userguide/src/site/pages/tds_tutorial/getting_started/DeployingTheTds.md +++ b/docs/userguide/src/site/pages/tds_tutorial/getting_started/DeployingTheTds.md @@ -37,10 +37,11 @@ This section assumes you have successfully installed the JDK and Tomcat Servlet ~~~ - - {%include note.html content=" + + {% capture context %} Consult the Tomcat documentation about [web application context](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/context.html){:target='_blank'} for more information about the `META-INF/context.xml` file. - " %} + {% endcapture %} + {% include info.html content=context %} The down-side of renaming the WAR file to merely `thredds.war` is that a quick glance at the WAR file will not tell you (the server administrator) which version of the TDS is deployed. diff --git a/docs/userguide/src/site/pages/tds_tutorial/getting_started/InstallJavaTomcat.md b/docs/userguide/src/site/pages/tds_tutorial/getting_started/InstallJavaTomcat.md index 8a6c941490..5da2b903ce 100644 --- a/docs/userguide/src/site/pages/tds_tutorial/getting_started/InstallJavaTomcat.md +++ b/docs/userguide/src/site/pages/tds_tutorial/getting_started/InstallJavaTomcat.md @@ -82,9 +82,10 @@ The following example shows Tomcat installation on a linux system. (This type of installation will work on Mac OS systems as well.) The installation is performed as the `root` user. -{% include note.html content=" +{% capture tomcatinstall %} For installation of Tomcat on Windows, see the [Tomcat Setup Guide](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/setup.html#Windows){:target='_blank'}. -" %} +{% endcapture %} +{% include info.html content=tomcatinstall %} {%- assign tomcat_version_split = site.tomcat_version | split: '.' -%} {%- assign tomcat_version_split = tomcat_version_split[0] -%} diff --git a/docs/userguide/src/site/pages/tds_tutorial/getting_started/TomcatManagerApp.md b/docs/userguide/src/site/pages/tds_tutorial/getting_started/TomcatManagerApp.md index ca1a7fabb7..c7954e15a8 100644 --- a/docs/userguide/src/site/pages/tds_tutorial/getting_started/TomcatManagerApp.md +++ b/docs/userguide/src/site/pages/tds_tutorial/getting_started/TomcatManagerApp.md @@ -19,9 +19,10 @@ This section assumes you have successfully installed the JDK and Tomcat Servlet * Allows Tomcat administrators to deploy, un-deploy, or reload web applications such as the TDS without having to shut down and restart Tomcat. * Provides server status statistics for the JVM and each connector you have configured in `${tomcat_home}/conf/server.xml`. -{%include note.html content= +{% capture tcmanager %} "For more information about the Tomcat manager application, see the [Tomcat Manager App HOW-TO](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/manager-howto.html){:target='_blank'} documentation. -" %} +{% endcapture %} +{% include info.html content=tcmanager %} ## Accessing The Manager Application @@ -57,10 +58,10 @@ This will be done in the following 2 steps: ~~~ - {%include note.html content=" + {% capture context_config %} For more information about web application context configuration files and their security options, please review the [Tomcat Manager App How-To](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/manager-howto.html#Introduction){:target='_blank'} documentation. - " %} - + {% endcapture %} + {% include info.html content=context_config %} #### II. Modify `tomcat-users.xml` diff --git a/docs/userguide/src/site/pages/tds_tutorial/monitoring_and_debugging/ModifyingTomcatAccessLogs.md b/docs/userguide/src/site/pages/tds_tutorial/monitoring_and_debugging/ModifyingTomcatAccessLogs.md index a561fe3c6e..4b3424e3fe 100644 --- a/docs/userguide/src/site/pages/tds_tutorial/monitoring_and_debugging/ModifyingTomcatAccessLogs.md +++ b/docs/userguide/src/site/pages/tds_tutorial/monitoring_and_debugging/ModifyingTomcatAccessLogs.md @@ -103,12 +103,10 @@ The access log entry format we are using is almost identical to the standard com pattern="%h %l %u %t "%r" %s %b "%{Referer}i" "%{User-Agent}i" %D" ~~~ - - -{%include note.html content=" +{% capture logfmt %} For more information on access log format configuration, see the Tomcat [Valve Component](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/valve.html){:target='_blank'} documentation. -" %} - +{% endcapture %} +{% include info.html content=logfmt %} The above pattern makes use of the following codes: diff --git a/docs/userguide/src/site/pages/tds_tutorial/production/DigestedPasswords.md b/docs/userguide/src/site/pages/tds_tutorial/production/DigestedPasswords.md index 9d26bd0f95..779d3b466c 100644 --- a/docs/userguide/src/site/pages/tds_tutorial/production/DigestedPasswords.md +++ b/docs/userguide/src/site/pages/tds_tutorial/production/DigestedPasswords.md @@ -92,9 +92,10 @@ A Tomcat Realm represents a "database" of usernames, passwords, and roles assign supersecretpassword:bb7a2b6cf8da7122125c663fc1585808170b2027677195e0ad121f87b27320ae$1$55003acb56e907b19d29d3b4211dc98c837354690bc90579742d6747efeec4ea ~~~ - {% include note.html content=" - To use a different algorithm, a salt, or to limit the length of the resulting password hash, consult the [syntax options](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/realm-howto.html#Digested_Passwords){:target='_blank'} for the `tomcat_home/bin/digest.[bat|sh]` script. - " %} + {% capture algo %} + To use a different algorithm, a salt, or to limit the length of the resulting password hash, consult the [syntax options](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/realm-howto.html#Digested_Passwords){:target='_blank'} for the `tomcat_home/bin/digest.[bat|sh]` script. + {% endcapture %} + {% include info.html content=algo %} 3. Update `${tomcat_home}/conf/tomcat-users.xml` to replace your clear-text password with the encrypted version: diff --git a/docs/userguide/src/site/pages/tds_tutorial/production/EnableTLSEncryption.md b/docs/userguide/src/site/pages/tds_tutorial/production/EnableTLSEncryption.md index 29d989d727..b566673e51 100644 --- a/docs/userguide/src/site/pages/tds_tutorial/production/EnableTLSEncryption.md +++ b/docs/userguide/src/site/pages/tds_tutorial/production/EnableTLSEncryption.md @@ -51,9 +51,10 @@ Tomcat uses the keystore file for TLS/SSL transactions. The following example demonstrates enabling TLS/SSL in the Tomcat Servlet Container on a linux system as the `root` user. -{%include note.html content=" +{% capture cert %} This section assumes you have already imported your CA-signed certificate into the [keystore](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/ssl-howto.html#Prepare_the_Certificate_Keystore){:target='_blank'} file. -" %} +{% endcapture %} +{% include info.html content=cert %} 1. Modify the Tomcat configuration to enable TLS/SSL: @@ -84,10 +85,12 @@ This section assumes you have already imported your CA-signed certificate into t ~~~ - - {%include note.html content=" - Tomcat also offers a `SSL/TLS HTTP/1.1 Connector` which utilizes `APR/native implementation`. Consult the [Documentation](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/http.html){:target='_blank'} to see if you should use this connector in lieu of the `NIO implementation SSL HTTP/1.1` connector. - " %} + + {% capture connector %} + Tomcat also offers a `SSL/TLS HTTP/1.1 Connector` which utilizes `APR/native implementation`. + Consult the [Documentation](http://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/http.html){:target='_blank'} to see if you should use this connector in lieu of the `NIO implementation SSL HTTP/1.1` connector. + {% endcapture %} + {% include info.html content=connector %} Specify the keystore file in the `certificateKeystoreFile` attribute of the `Certificate` element to tell Tomcat where to find your keystore (the path will be relative to `${tomcat_home}` directory). diff --git a/docs/userguide/src/site/pages/tds_tutorial/production/RestrictAccessToTds.md b/docs/userguide/src/site/pages/tds_tutorial/production/RestrictAccessToTds.md index 5b2a7d4b17..a9de0c02a9 100644 --- a/docs/userguide/src/site/pages/tds_tutorial/production/RestrictAccessToTds.md +++ b/docs/userguide/src/site/pages/tds_tutorial/production/RestrictAccessToTds.md @@ -62,10 +62,10 @@ The `RemoteHostValve` compares the client hostname against one or more regular e deny=".*\.bandwidthhogs\.com" /> ~~~ - {%include note.html content=" - Consult the Tomcat [Remote Host Valve](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/valve.html#Remote_Host_Valve){:target='_blank'} documentation for more information about valve syntax and options. - " %} - + {% capture remote_host_valve %} + Consult the Tomcat [Remote Host Valve](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/valve.html#Remote_Host_Valve){:target='_blank'} documentation for more information about valve syntax and options. + {% endcapture %} + {% include info.html content=remote_host_valve%} ## Restrict Access Via Web Application Deployment Descriptor diff --git a/docs/userguide/src/site/pages/tds_tutorial/production/TdsBehindProxy.md b/docs/userguide/src/site/pages/tds_tutorial/production/TdsBehindProxy.md index 80a715b6cc..bee76cb631 100644 --- a/docs/userguide/src/site/pages/tds_tutorial/production/TdsBehindProxy.md +++ b/docs/userguide/src/site/pages/tds_tutorial/production/TdsBehindProxy.md @@ -210,9 +210,10 @@ The following example shows how to implement a proxy using the Apache HTTPD serv protocol="AJP/1.3" /> ~~~ - {% include note.html content=" + {% capture ajp_connector %} Consult the Tomcat documentation for more information about the [AJP Connector](https://tomcat.apache.org/tomcat-{{ site.tomcat_version }}-doc/config/ajp.html){:target='_blank'} configuration options. - " %} + {% endcapture %} + {% include info.html content=ajp_connector %} 2. Disable any active `Java HTTP/1.1 Connector` and the `SSL HTTP/1.1 Connector` Tomcat connectors.