diff --git a/jetty-documentation/src/main/asciidoc/distribution-guide/startup/custom-modules.adoc b/jetty-documentation/src/main/asciidoc/distribution-guide/startup/custom-modules.adoc index 5792be01571..f8388b7e6e9 100644 --- a/jetty-documentation/src/main/asciidoc/distribution-guide/startup/custom-modules.adoc +++ b/jetty-documentation/src/main/asciidoc/distribution-guide/startup/custom-modules.adoc @@ -56,7 +56,7 @@ When using the `--list-modules` command, modules will be groups by the first tag Modules can also be listed specifically by these tags using `--list-modules=` on the command line. Ini Variables - `[ini]`:: The `[ini]` section is used to add or change server parameters at startup. -The `[ini]` section can also include a the path of a file or several files which should be made available to the server only. +The `[ini]` section can also include a the path of a file or several files which should be made available to the _server_ only. This is helpful when you want to control what jars are available to deployed webapps. Jetty INI Template - `[ini-template]`:: Each module can optionally declare a startup ini template that is used to insert/append/inject sample configuration elements into the `start.ini` or `start.d/*.ini` files when using the `--add-to-start=` command line argument in `start.jar`. @@ -68,7 +68,7 @@ Ensure Directory Exists;; If you add a pathname that ends in `"/"` (slash), such as `"webapps/"`, then that directory will be created if it does not yet exist in `${jetty.base}/` (eg: `"webapps/"` will result in `${jetty.base}/webapps/` being created). Download File;; There is a special syntax to allow you to download a file into a specific location if it doesn't exist yet: `:`. -Currently, the `` must be a `http://` scheme URL (please link:#bugs[let us know] if you need more schemes supported). +Currently, the `` must be a `http://` scheme URL. The `` portion follows the link:#base-vs-home-resolution[Jetty Base and Jetty Home path resolution rules]. Example: `http://repo.corp.com/maven/corp-security-policy-1.0.jar:lib/corp-security-policy.jar` This will check for the existence of `lib/corp-security-policy.jar`, and if it doesn't exist, it will download the jar file from `http://repo.corp.com/maven/corp-security-policy-1.0.jar` @@ -215,7 +215,7 @@ INFO : Base directory was modified ---- ==== Dependencies -When dependent modules are enabled, they are done so transitively by default. +When dependent modules are enabled, they are done so *transitively* by default. This means that any `ini` files for dependent modules are not created in the `${JETTY_BASE}/start.d` directory (or added to `${JETTY_BASE}/start.ini`) and are as such not configurable. For Jetty to create/add the `ini-template` parameters to `start.d` or `start.ini` the associated module must be enabled explicitly. diff --git a/jetty-documentation/src/main/asciidoc/quickstart-guide/introduction/what-is-jetty.adoc b/jetty-documentation/src/main/asciidoc/quickstart-guide/introduction/what-is-jetty.adoc index 319ead4c0ca..78ff2bd84df 100644 --- a/jetty-documentation/src/main/asciidoc/quickstart-guide/introduction/what-is-jetty.adoc +++ b/jetty-documentation/src/main/asciidoc/quickstart-guide/introduction/what-is-jetty.adoc @@ -19,29 +19,23 @@ [[what-is-jetty]] === What is Jetty? -Jetty is an open-source project providing an HTTP server, HTTP client, and javax.servlet container. +Eclipse Jetty is an open-source project providing an HTTP server, HTTP client, and servlet container. -This guide is broken up in to five parts: +The Jetty documentation is broken up in to four parts: -* The link:#quick-start[first section] emphasizes beginning to use Jetty. +* The link:{QUICKGUIDE}[Quick Start Guide] emphasizes beginning to use Jetty. It provides information about what Jetty is and where you can download it, and where to find Jetty in repositories like Central Maven. It also provides a Quick Start guide on how to get Jetty up and running as well as an overview of how and what to configure in Jetty. -* The link:#jetty-config-guide[second section] of the guide deals with configuring Jetty at a more granular level. -It explains how to use Jetty to deploy web applications, configure contexts and connects, and how to implement SSL and other security measures. - -* Administration of Jetty is the focus of the link:#jetty-admin-guide[third section] of the guide. -From server startup to session management, logging, HTTP/2 support and Jetty optimization, these chapters will help administrators get the most out of their Jetty server instances. +* The link:{DISTGUIDE}[Distribution Guide] details configuring Jetty as a distributed package at a more granular level. +From server startup to session management, logging, HTTP/2 support and Jetty optimization, these chapters will help administrators get the most out of their distributed Jetty server instances. This section also covers configuring many of the most common servlet container features such as JNDI and JMX. -* Aimed at advanced users of Jetty, the link:#jetty-dev-guide[fourth section] of the guide focuses on Jetty development. +* Aimed at advanced users of Jetty, the link:{EMBEDGUIDE}[Embedded Guide] focuses on Jetty development. A large portion of this section is focused on using Jetty as an embedded server in existing applications. It contains several examples and how-to guides for making the most out of the Jetty framework. This section also includes a guide on using the Jetty Maven plugin as well as information on debugging Jetty. -* The link:#jetty-ref-guide[final section] of the guide is a reference section. -Included there are guides on Jetty architecture and Jetty XML syntax, alternate distributions of Jetty and even troubleshooting of common issues. -There is also a chapter on getting involved in the Jetty community including information on how to contribute code and how to find help. - -Feedback is always welcome! -Additionally, if you are interested in how to contribute to the open source project there is a link:#community[section on that as well!] +* The link:#{CONTRIBGUIDE}[Contribution Guide] is aimed at those who want to contribute to the Jetty open source project. +It includes instructions on interacting with the community, how to raise bugs, and how to report security issues. +In addition, it also details source control and build information for the project. diff --git a/jetty-documentation/src/main/asciidoc/quickstart-guide/introduction/what-version.adoc b/jetty-documentation/src/main/asciidoc/quickstart-guide/introduction/what-version.adoc index ae9e28f4106..9f1902392ba 100644 --- a/jetty-documentation/src/main/asciidoc/quickstart-guide/introduction/what-version.adoc +++ b/jetty-documentation/src/main/asciidoc/quickstart-guide/introduction/what-version.adoc @@ -19,9 +19,9 @@ [[what-jetty-version]] === What Version Do I Use? -Jetty 9 is the most recent version of Jetty and has a great many improvements over previous versions. -This documentation which focuses on Jetty 9. -While many people continue to use older versions of Jetty, we generally recommend using Jetty 9 as it represents the version of Jetty that we will actively maintain and improve over the next few years. +Jetty 10 and 11 are the most recent versions of Jetty and has a great many improvements over previous versions. +This documentation which focuses on Jetty 10. +While many people continue to use older versions of Jetty, we generally recommend using Jetty 10 or 11 (more on the differences later) as they represent the version of Jetty that we will actively maintain and improve over the next few years. _____ [IMPORTANT] @@ -33,7 +33,7 @@ _____ [width="100%",cols="12%,9%,15%,6%,21%,10%,6%,21%",options="header",] |======================================================================= |Version |Year |Home |Min JVM |Protocols |Servlet |JSP |Status -|11 |2020- |Eclipse |11 ^(2)^ |HTTP/1.1 (RFC 7230), HTTP/2 (RFC 7540), WebSocket (RFC 6455, JSR 356), FastCGI, *JakartaEE Namespace*^(1)^ |4.0.2 |2.3 |*UNSTABLE / Alpha* +|11 |2020- |Eclipse |11 ^(2)^ |HTTP/1.1 (RFC 7230), HTTP/2 (RFC 7540), WebSocket (RFC 6455, JSR 356), FastCGI, *JakartaEE Namespace*^(1)^ |4.0.2 |2.3 |*UNSTABLE / Beta* |10 |2019- |Eclipse |11 ^(2)^ |HTTP/1.1 (RFC 7230), HTTP/2 (RFC 7540), WebSocket (RFC 6455, JSR 356), FastCGI |4.0.2 |2.3 |*UNSTABLE / Beta* |9.4 |2016- |Eclipse |1.8 |HTTP/1.1 (RFC 7230), HTTP/2 (RFC 7540), WebSocket (RFC 6455, JSR 356), FastCGI |3.1 |2.3 |Stable |9.3 |2015- |Eclipse |1.8 ^(3)^ |HTTP/1.1 (RFC 7230), HTTP/2 (RFC 7540), WebSocket (RFC 6455, JSR 356), FastCGI |3.1 |2.3 |Deprecated