From 7f7a85b5c9645299b16a275e7e40ed6a230727ee Mon Sep 17 00:00:00 2001 From: WalkerWatch Date: Tue, 3 Jan 2017 08:52:57 -0500 Subject: [PATCH] Clarfying Jetty Home v Base Signed-off-by: WalkerWatch --- .../startup/startup-base-vs-home.adoc | 15 ++++++++++++--- .../security/jetty-home-and-jetty-base.adoc | 4 ++-- .../getting-started/jetty-running.adoc | 6 ++++++ 3 files changed, 20 insertions(+), 5 deletions(-) diff --git a/jetty-documentation/src/main/asciidoc/administration/startup/startup-base-vs-home.adoc b/jetty-documentation/src/main/asciidoc/administration/startup/startup-base-vs-home.adoc index f8832fcca6a..4ecf5ed0232 100644 --- a/jetty-documentation/src/main/asciidoc/administration/startup/startup-base-vs-home.adoc +++ b/jetty-documentation/src/main/asciidoc/administration/startup/startup-base-vs-home.adoc @@ -17,7 +17,8 @@ [[startup-base-and-home]] === Managing Jetty Base and Jetty Home -Starting with Jetty 9.1, it is possible to maintain a separation between the binary installation of the standalone Jetty (known as `${jetty.home}`), and the customizations for your specific environment (known as `${jetty.base}`). +Instead of managing multiple Jetty implementations out of several different distribution locations, it is possible to maintain a separation between the binary installation of the standalone Jetty (known as `${jetty.home}`), and the customizations for your specific environment(s) (known as `${jetty.base}`). +There should always only be one Jetty Home, but there can be multiple Jetty Base directories that references. Jetty Base:: * Also known as the `${jetty.base}` property. @@ -26,6 +27,14 @@ Jetty Home:: * Also known as the `${jetty.home}` property. * This is the location for the Jetty distribution binaries, default XML IoC configurations, and default module definitions. +____ +[IMPORTANT] +Jetty Home should always be treated as a standard of truth. +All configuration modifications, changes and additions should be made in the appropriate Jetty Base directory. +____ + +[[base-vs-home-resolution]] + Potential configuration is resolved from these 2 directory locations. Check Jetty Base:: @@ -241,8 +250,8 @@ jetty.dump.stop=false --module=annotations .... -The `${jetty.base}/start.ini` is the main startup configuration entry point for Jetty. -In this example you will see that we are enabling a few modules for Jetty, specifying some properties, and also referencing some Jetty IoC XML files (namely the `etc/demo-rewrite-rules.xml` and `etc/test-realm.xml` files) +In this example, `${jetty.base}/start.ini` is the main startup configuration entry point for Jetty. +You will see that we are enabling a few modules for Jetty, specifying some properties, and also referencing some Jetty IoC XML files (namely the `etc/demo-rewrite-rules.xml` and `etc/test-realm.xml` files) When Jetty's `start.jar` resolves the entries in the `start.ini`, it will follow the link:#base-vs-home-resolution[resolution rules above]. diff --git a/jetty-documentation/src/main/asciidoc/configuring/security/jetty-home-and-jetty-base.adoc b/jetty-documentation/src/main/asciidoc/configuring/security/jetty-home-and-jetty-base.adoc index ac20510efb8..93d9dbb8871 100644 --- a/jetty-documentation/src/main/asciidoc/configuring/security/jetty-home-and-jetty-base.adoc +++ b/jetty-documentation/src/main/asciidoc/configuring/security/jetty-home-and-jetty-base.adoc @@ -18,9 +18,9 @@ === Using the $\{jetty.home} and $\{jetty.base} Concepts to Configure Security -Jetty 9.1 introduced `${jetty.base}` and `${jetty.home}`. +Jetty implementations are structured around the idea of `${jetty.base}` and `${jetty.home}` directories. -* `${jetty.home}` is the directory location for the jetty distribution (the binaries). +* `${jetty.home}` is the directory location for the Jetty distribution (the binaries) should not be modified. * `${jetty.base}` is the directory location for your customizations to the distribution. This separation: diff --git a/jetty-documentation/src/main/asciidoc/quick-start/getting-started/jetty-running.adoc b/jetty-documentation/src/main/asciidoc/quick-start/getting-started/jetty-running.adoc index 97b15f32440..dc1e4dbe9be 100644 --- a/jetty-documentation/src/main/asciidoc/quick-start/getting-started/jetty-running.adoc +++ b/jetty-documentation/src/main/asciidoc/quick-start/getting-started/jetty-running.adoc @@ -105,6 +105,12 @@ jetty.home:: jetty.base:: The property that defines the location of a specific instance of a jetty server, its configuration, logs and web applications (typically start.ini, start.d, logs and webapps) +____ +[IMPORTANT] +Your Jetty Home directory should be treated as a standard of truth and remain unmodified or changed. +Changes or additions to your configuration should take place in the Jetty Base directory. +____ + The `jetty.home` and `jetty.base` properties may be explicitly set on the command line, or they can be inferred from the environment if used with commands like: [source, screen, subs="{sub-order}"]