diff --git a/jetty-documentation/src/main/asciidoc/operations-guide/begin/chapter.adoc b/jetty-documentation/src/main/asciidoc/operations-guide/begin/chapter.adoc index fa985c705a3..2ced8b0f344 100644 --- a/jetty-documentation/src/main/asciidoc/operations-guide/begin/chapter.adoc +++ b/jetty-documentation/src/main/asciidoc/operations-guide/begin/chapter.adoc @@ -21,6 +21,10 @@ This section will get you started with Eclipse Jetty. +include::../../../../../../jetty-home/src/main/resources/README.adoc[tags=quick] + +The following sections will guide you in details about downloading, installing and starting Jetty, as well as deploying your web applications to Jetty. + include::download.adoc[] include::install.adoc[] include::architecture.adoc[] diff --git a/jetty-home/src/main/resources/README.adoc b/jetty-home/src/main/resources/README.adoc new file mode 100644 index 00000000000..91656aff7a4 --- /dev/null +++ b/jetty-home/src/main/resources/README.adoc @@ -0,0 +1,46 @@ +=== ECLIPSE JETTY + +The link:https://www.eclipse.org/jetty/[Eclipse Jetty] Project provides a: + +* Java HTTP & WebSocket Server +* Servlet Container +* Java HTTP & WebSocket Client + +Jetty is available under an open source link:LICENSE.txt[LICENSE], and the full source code is available at link:https://github.com/eclipse/jetty.project[GitHub]. + +The Jetty documentation is available at link:https://www.eclipse.org/jetty/documentation[]. + +// tag::quick[] +==== Quick Jetty Setup + +Jetty is distributed in an artifact that expands in a directory called `$JETTY_HOME`, which should not be modified. + +Configuration for Jetty is typically done in one (or more) other directories called `$JETTY_BASE`. + +The following commands can be used to setup a `$JETTY_BASE` directory that supports deployment of `+*.war+` files and a clear-text HTTP connector: + +---- +$ export JETTY_HOME=/path/to/jetty-home +$ mkdir /path/to/jetty-base +$ cd /path/to/jetty-base +$ java -jar $JETTY_HOME/start.jar --add-module=server,http,deploy +---- + +This will create a `$JETTY_BASE/start.d/` directory and other directories that contain the configuration of the server, including the `$JETTY_BASE/webapps/` directory, in which standard `+*.war+` files can be deployed. + +To deploy Jetty's demo web applications, run this command: + +---- +$ java -jar $JETTY_HOME/start.jar --add-module=demo +---- + +Now you can start the Jetty server with: + +---- +$ java -jar $JETTY_HOME/start.jar +---- + +Point your browser at `+http://localhost:8080+` to see the web applications deployed in Jetty. + +The Jetty server can be stopped with `ctrl-c` in the terminal window. +// end::quick[] diff --git a/jetty-home/src/main/resources/README.md b/jetty-home/src/main/resources/README.md deleted file mode 100644 index 25255452d34..00000000000 --- a/jetty-home/src/main/resources/README.md +++ /dev/null @@ -1,66 +0,0 @@ -ECLIPSE JETTY -============= -The [Eclipse Jetty](http://www.eclipse.org/jetty/) project provides a: - + Java HTTP Server - + Servlet Container - + Java HTTP Client - -Jetty made available under an open source [LICENSE](LICENSE.txt)s -and the full source code is available at [github](https://github.com/eclipse/jetty.project). - -Jetty Documentation is available at [https://www.eclipse.org/jetty/documentation](https://www.eclipse.org/jetty/documentation). - -RUNNING A JETTY SERVER -====================== -Jetty is distributed in a directory called jetty-home, which should not need -to be modified. Configuration for jetty is typically done in one (or more) other -directories often called jetty-base. The following UNIX commands can be used -to setup a jetty-base directory that supports deployment of WAR files and a HTTP -connector: - -``` -$ export JETTY_HOME=/path/to/jetty-home -$ mkdir /path/to/jetty-base -$ cd /path/to/jetty-base -$ java -jar $JETTY_HOME/start.jar --add-module=server,http,deploy -``` - -This will create a start.d directory and other directories that contain the -configuration of the server. Specifically the `webapps` directory is created -in which standard WAR files can be deployed. - -Once a jetty-base directory is created, the jetty server can be run with: -``` - $ java -jar $JETTY_HOME/start.jar -``` - -A browser may now be pointed at [http://localhost:8080](http://localhost:8080). -The server can be stopped with ctrl-C - - -To create a jetty-base directory with several demo webapps: - -``` -$ java -jar $JETTY_HOME/start.jar --add-module=demo -``` - -Other modules can be added with the command: -``` -$ java -jar $JETTY_HOME/start.jar --add-module=,... -``` - -To see what modules are available -``` -$ java -jar $JETTY_HOME/start.jar --list-modules -``` - -To see what the current configuration is -``` -$ java -jar $JETTY_HOME/start.jar --list-config -``` - -To see more start options -``` -$ java -jar $JETTY_HOME/start.jar --help -``` - diff --git a/pom.xml b/pom.xml index 403e3295710..cf40e9e4d43 100644 --- a/pom.xml +++ b/pom.xml @@ -41,7 +41,7 @@ benchmarks 2.0.0 5.7.0 - 3.6.0 + 3.6.3 1.3.1 4.0.0.Beta1 3.4.1.Final @@ -359,11 +359,10 @@ **/*.adoc - jetty-util/src/main/java/org/eclipse/jetty/util/security/UnixCrypt.java - jetty-policy/src/main/java/org/eclipse/jetty/policy/loader/DefaultPolicyLoader.java - jetty-policy/src/main/java/org/eclipse/jetty/policy/loader/PolicyFileScanner.java jetty-ant/** + jetty-home/src/main/resources/README.adoc jetty-infinispan/** + jetty-util/src/main/java/org/eclipse/jetty/util/security/UnixCrypt.java tests/test-sessions/test-infinispan-sessions/** @@ -1078,6 +1077,16 @@ ${transaction-api.version} + + org.codehaus.plexus + plexus-component-annotations + 2.1.0 + + + org.codehaus.plexus + plexus-utils + 3.3.0 + org.apache.maven maven-plugin-api