[GitHub] tomcat pull request #117: Enhance the CATALINA_BASE documentation
GitHub user m-czernek opened a pull request: https://github.com/apache/tomcat/pull/117 Enhance the CATALINA_BASE documentation As per the mailing list discussion, we'd like to enhance the catalina.home and catalina.base documentation so that it is present in the main html documentation, and not only in RUNNING.txt and various script files. Feel free to request corrections or further changes. What do you think? You can merge this pull request into a Git repository by running: $ git pull https://github.com/m-czernek/tomcat catalina_base Alternatively you can review and apply these changes as the patch at: https://github.com/apache/tomcat/pull/117.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #117 commit 151997326bb2b5f9678cf2c7cfc2fcbb78f6609c Author: Marek Czernek Date: 2018-08-02T13:08:56Z Enhance the CATALINA_BASE documentation --- - To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
[GitHub] tomcat pull request #117: Enhance the CATALINA_BASE documentation
Github user m-czernek commented on a diff in the pull request: https://github.com/apache/tomcat/pull/117#discussion_r209532683 --- Diff: webapps/docs/introduction.xml --- @@ -89,6 +80,122 @@ same as $CATALINA_HOME. + + Throughout the documentation, there are references to the two following +properties: + + +CATALINA_HOME: Represents the root of your Tomcat +installation, for example /home/tomcat/apache-tomcat-9.0.10 +or C:\Program Files\apache-tomcat-9.0.10. + + +CATALINA_BASE: Represents the root of a runtime +configuration of a specific Tomcat instance. If you want to have +multiple Tomcat instances on one machine, use the CATALINA_BASE +property. + + + + +If you set the properties to different locations, the CATALINA_HOME location +contains static sources, such as .jar files, or binary files. +The CATALINA_BASE location contains configuration files, log files, deployed +applications, and other runtime requirements. + + + + By default, CATALINA_HOME and CATALINA_BASE point to the same directory. + Set CATALINA_BASE manually when you require running multiple Tomcat + instances on one machine. Doing so provides the following benefits: + + + +Easier management of upgrading to a newer version of Tomcat. Because all +instances with single CATALINA_HOME location share one set of +.jar files and binary files, you can easily upgrade the files +to newer version and have the change propagated to all Tomcat instances +using the same CATALIA_HOME directory. + + +Avoiding duplication of the same static .jar files. + + +The possibility to share certain settings, for example the setenv shell +or bat script file (depending on your operating system). + + + + + + Before you start using CATALINA_BASE, create the directory you want to use + as CATALINA_BASE for the particular Tomcat instance. At minimum, it must + contain: + +conf/server.xml +conf/web.xml + + That includes the conf directory. Otherwise, Tomcat may + fail to start. + + + Additionally, it may also contain the following: + --- End diff -- Could you please be a bit more specific? It's interesting because before putting anything in the docs, I always try it out (just to turn it on and see if there are any errors). Strictly speaking, conf/server.xml is the only file necessary for no errors during startup. Which other dirs/files would you recommend marking as required? --- - To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
[GitHub] tomcat pull request #117: Enhance the CATALINA_BASE documentation
Github user m-czernek commented on a diff in the pull request: https://github.com/apache/tomcat/pull/117#discussion_r209548456 --- Diff: webapps/docs/introduction.xml --- @@ -89,6 +80,122 @@ same as $CATALINA_HOME. + + Throughout the documentation, there are references to the two following +properties: + + +CATALINA_HOME: Represents the root of your Tomcat +installation, for example /home/tomcat/apache-tomcat-9.0.10 +or C:\Program Files\apache-tomcat-9.0.10. + + +CATALINA_BASE: Represents the root of a runtime +configuration of a specific Tomcat instance. If you want to have +multiple Tomcat instances on one machine, use the CATALINA_BASE +property. + + + + +If you set the properties to different locations, the CATALINA_HOME location +contains static sources, such as .jar files, or binary files. +The CATALINA_BASE location contains configuration files, log files, deployed +applications, and other runtime requirements. + + + + By default, CATALINA_HOME and CATALINA_BASE point to the same directory. + Set CATALINA_BASE manually when you require running multiple Tomcat + instances on one machine. Doing so provides the following benefits: + + + +Easier management of upgrading to a newer version of Tomcat. Because all +instances with single CATALINA_HOME location share one set of +.jar files and binary files, you can easily upgrade the files +to newer version and have the change propagated to all Tomcat instances +using the same CATALIA_HOME directory. + + +Avoiding duplication of the same static .jar files. + + +The possibility to share certain settings, for example the setenv shell +or bat script file (depending on your operating system). + + + + + + Before you start using CATALINA_BASE, create the directory you want to use + as CATALINA_BASE for the particular Tomcat instance. At minimum, it must + contain: + +conf/server.xml +conf/web.xml + + That includes the conf directory. Otherwise, Tomcat may + fail to start. + + + Additionally, it may also contain the following: + + + The bin directory with the setenv.sh, + setenv.bat, and tomcat-juli.jar files. + + + The lib directory with further resources to be added on + classpath. + + + The logs directory for instance-specific log files. + + + The webapps directory for automatically loaded web + applications. + + + The work directory that contains temporary working + directories for the deployed web applications. + + + The temp directory used by the JVM for temporary files. + + + + + We recommend you not to change the tomcat-juli.jar file. + However, in case you require your own logging implementation, you can + replace the tomcat-juli.jar file in a CATALINA_BASE location + for the specific Tomcat instance. + + + We also recommend you not to copy over any configuration file that is identical + for multiple Tomcat instances, with the exception of the mandatory files. + For example, copy over the conf/logging.properties only if + you require the particular Tomcat instance to have specific logging settings. + --- End diff -- Incorporated. --- - To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
[GitHub] tomcat pull request #117: Enhance the CATALINA_BASE documentation
Github user m-czernek commented on a diff in the pull request: https://github.com/apache/tomcat/pull/117#discussion_r212238007 --- Diff: webapps/docs/introduction.xml --- @@ -89,6 +80,122 @@ same as $CATALINA_HOME. + + Throughout the documentation, there are references to the two following +properties: + + +CATALINA_HOME: Represents the root of your Tomcat +installation, for example /home/tomcat/apache-tomcat-9.0.10 +or C:\Program Files\apache-tomcat-9.0.10. + + +CATALINA_BASE: Represents the root of a runtime +configuration of a specific Tomcat instance. If you want to have +multiple Tomcat instances on one machine, use the CATALINA_BASE +property. + + + + +If you set the properties to different locations, the CATALINA_HOME location +contains static sources, such as .jar files, or binary files. +The CATALINA_BASE location contains configuration files, log files, deployed +applications, and other runtime requirements. + + + + By default, CATALINA_HOME and CATALINA_BASE point to the same directory. + Set CATALINA_BASE manually when you require running multiple Tomcat + instances on one machine. Doing so provides the following benefits: + + + +Easier management of upgrading to a newer version of Tomcat. Because all +instances with single CATALINA_HOME location share one set of +.jar files and binary files, you can easily upgrade the files +to newer version and have the change propagated to all Tomcat instances +using the same CATALIA_HOME directory. + + +Avoiding duplication of the same static .jar files. + + +The possibility to share certain settings, for example the setenv shell +or bat script file (depending on your operating system). + + + + + + Before you start using CATALINA_BASE, create the directory you want to use + as CATALINA_BASE for the particular Tomcat instance. At minimum, it must + contain: + +conf/server.xml +conf/web.xml + + That includes the conf directory. Otherwise, Tomcat may + fail to start. + + + Additionally, it may also contain the following: + --- End diff -- Thank you for your thorough review and my apologies for the delay in implementing it. I think what you said does make sense. I have implemented your feedback, just please check whether what I wrote is indeed correct. I provided the "order of lookup" note for directories where it made sense. Not sure there is any lookup going on in logs, for example (Imho that's rather scope than lookup, while for lib, lookup makes sense to me). What do you think? --- - To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
[GitHub] tomcat pull request #125: Provide port offset functionality (BZ-61171)
GitHub user m-czernek opened a pull request: https://github.com/apache/tomcat/pull/125 Provide port offset functionality (BZ-61171) This PR resolves [BZ61171](https://bz.apache.org/bugzilla/show_bug.cgi?id=61171) and adds the port offset functionality. The implementation is deliberately done such that the current behavior is left unchanged, i.e. `getPort()` always returns the port without offset. However, if you set `portOffset` on the `StandardServer` element, all connectors get the offset, and are listening at port+portOffset port. To get port with offset, one specifically has to call `getPortWithOffset()`. This behavior is also signified in the logs, which now show, for example, `"http-nio-8080-offset-100"` rather than `"http-nio-8180"`. User-facing documentation will follow when and if this PR gets merged. Thoughts? As always, I'm keen on feedback and request for changes. Alternatively, feel free to change any part of the PR. You can merge this pull request into a Git repository by running: $ git pull https://github.com/m-czernek/tomcat bz61171_portOffset Alternatively you can review and apply these changes as the patch at: https://github.com/apache/tomcat/pull/125.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #125 commit a9162b7112719a5cb649af2cc673239db92b5f0e Author: Marek Czernek Date: 2018-02-13T15:19:34Z Provide port offset functionality --- - To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
[GitHub] tomcat issue #125: Provide port offset functionality (BZ-61171)
Github user m-czernek commented on the issue: https://github.com/apache/tomcat/pull/125 @markt-asf I'll check your review into a lot more detail later, possibly tonight, but at this moment: - You set `portOffset` on Server - All connectors are offset There is no portOffset on individual Connectors. When each connector gets initialized, it starts with `portWithOffset`, basically `port` and `offset` being exposed for legacy reasons. You suggest to provide `offset` for individual connectors as well? Because for that, we don't have to have a portOffset, we can just change the ports manually :). I think I'm just misunderstanding here; I'll have to check out the `Connector` <-> `Endpoint` relationship. This is, by the way, in line with Wildfly, where you set one property with 'portOffset' (or you specify it in the upper-most xml element of socket binding group) and all the ports get offset. Another possible, and very simple, solution is also to include in the default configuration some system property, that will be simply added to all ports if the property is set. Or, simply add the property value to all port numbers if the property exists... --- - To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
[GitHub] tomcat pull request #97: Bz48672
GitHub user m-czernek opened a pull request: https://github.com/apache/tomcat/pull/97 Bz48672 Providing documentation patch for the https://bz.apache.org/bugzilla/show_bug.cgi?id=48672 bugzilla (and removing the TODO from the HTML interface). Feel free to suggest any changes to the documentation, or further enhance it afterwards. You can merge this pull request into a Git repository by running: $ git pull https://github.com/m-czernek/tomcat bz48672 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/tomcat/pull/97.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #97 commit 914d26a0f3504771d640734e5912f1638fe54428 Author: Marek Czernek Date: 2018-02-02T16:33:41Z Providing host-manager introduction commit 01360e872414e57448f48084b4582dee8d1fb3e1 Author: Marek Czernek Date: 2018-02-06T15:29:21Z Continue WIP doc commit cf58e42d469d586d2ebc14b05087e9ccbba07756 Author: Marek Czernek Date: 2018-02-07T08:19:44Z Finishing text and html interface documentation commit fddc77702f1fb733d49a24cf7686563322ab3af9 Author: Marek Czernek Date: 2018-02-07T08:21:16Z Remove TODO from the Virtual Host Manager web interface --- - To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
[GitHub] tomcat pull request #98: Fix for BZ62048
GitHub user m-czernek opened a pull request: https://github.com/apache/tomcat/pull/98 Fix for BZ62048 Hi, providing a small workaround for https://bz.apache.org/bugzilla/show_bug.cgi?id=62048 as suggested by Christopher in the BZ. I tried to make the logout link unobtrusive (example screenshot: https://ctrlv.cz/U4VN). As usual, feel free to suggest or make any changes. What do you think? You can merge this pull request into a Git repository by running: $ git pull https://github.com/m-czernek/tomcat bz62048 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/tomcat/pull/98.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #98 commit e9f9fd033d2af6e0cb89c411028133fa74c8c996 Author: endhalf Date: 2018-02-07T21:08:20Z Add logout for Host Manager commit 6bf8f12ae438350c66d7e5cd8870724f7378f454 Author: Marek Czernek Date: 2018-02-09T10:13:18Z Add logout for Manager commit a8a41c212d0084b614f54f14580afe98840c2076 Author: Marek Czernek Date: 2018-02-09T10:18:32Z Add docs --- - To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
[GitHub] tomcat issue #98: Fix for BZ62048
Github user m-czernek commented on the issue: https://github.com/apache/tomcat/pull/98 I see this is still open. I'm closing this PR, refactor, and re-open at another time. In the meantime, please follow discussion in https://bz.apache.org/bugzilla/show_bug.cgi?id=62048 . Thank you. --- - To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
[GitHub] tomcat pull request #98: Fix for BZ62048
Github user m-czernek closed the pull request at: https://github.com/apache/tomcat/pull/98 --- - To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
