Jump to: navigation, search

Difference between revisions of "Jetty/Howto/Run Jetty"

< Jetty‎ | Howto
 
(11 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Jetty}}
+
{{Jetty Howto
 +
| introduction =
  
==Standalone Startup==
+
{{Jetty Redirect|http://www.eclipse.org/jetty/documentation/current/quickstart-running-jetty.html}}
  
===Using the Start.jar===
+
This howto covers how to start up Jetty as standalone, and links to pages which cover alternative methods of startup.
 +
| steps =
 +
===Standalone Startup===
  
The easiest way to start jetty, is to use the start.jar that comes with the distribution.
+
====Using the Start.jar====
  
  [jetty-distribution-7.0.0.M3]$ '''java -jar start.jar'''
+
The easiest way to start Jetty, is to use the start.jar that comes with the distribution.
  
===Command Line Options===
+
<source lang="bash">
 +
java -jar start.jar
 +
</source>
  
  $ java -jar start.jar --help
+
The default options may be specified in the start.ini file, or if that is not present, they are defined in the start.config file that is within the start.jar.
  Usage: java -jar start.jar [--help|--stop|--version] [OPTIONS=option,...] [name=value ...] [config ...]
+
  
==== Command Line Option Help ====
+
To see the command line options for start.jar and help text for start.jar use:
 +
<source lang="bash">
 +
java -jar start.jar --help
 +
</source>
  
; --help
+
For a full description of start.jar features see [[Jetty/Feature/Start.jar|Jetty Start.jar Feature Guide]].
: Help / Usage Information
+
; --stop
+
: Stop the actively running Jetty Server (started with a previous use of start.jar)
+
; --version
+
: Show the version information about Jetty
+
; OPTIONS=option,....
+
: OPTIONS allows you to specify the jetty classpath entries that you want to use when starting up Jetty.
+
: OPTIONS lets you specify which bits and pieces of Jetty you want to use.
+
: Default OPTIONS set is "default,*
+
: NOTE: the "*" Option is always appended to the OPTIONS list.
+
  
==== Command Line OPTIONS Modes ====
+
====More start.jar examples ====
; *
+
: Special mode for various required entries. (always present)
+
; All
+
: Special mode name that includes all resources found in the following other modes
+
; default
+
: Default mode of operation, includes dependencies to run the core Server with Servlet API, WebApp, Continuations, Deployment, Security, and a collection of useful Jetty Servlet Filters. (see [[Jetty/Servlets]] for more info)
+
: Also includes the /lib/ext/ and /resources/ folders into the classpath
+
; Server
+
: Similar to '''default'' mode, with the addition of being able to configure the Jetty Server via XML configurations, and removal of /lib/ext/ and /resources/ folders.
+
; ext
+
: A meta mode that simply adds the contents of the /lib/ext/ folder to the classpath.
+
; resources
+
: A meta mode that adds the /resources/ folder to the classpath.
+
; xml
+
: Adds XML Configuration Support.
+
; security
+
: Adds Authorization and Authentication Support.
+
; servlet
+
: Adds Servlet Support via a ServletContext and a DefaultServlet implementation.
+
; webapp
+
: Adds WebApp (WAR File) Support
+
; deploy
+
: Adds Context and WebApp (WAR File) Deployer support
+
; servlets
+
: Adds various useful Servlet Filters and Servlet Implementations (DoS, Gzip, Put, UserAgent, QoS, Multipart, Proxy, etc...)
+
; rewrite
+
: Adds jetty handler support for rewriting and redirecting requests based on rules.
+
; jmx
+
: Adds JMX Support
+
; ajp
+
: Adds Apache JServ Protocol version 1.3 Support
+
; slf4j
+
: Adds Simple Logging Facade for Java Support
+
; jsp
+
: Adds JSP Support
+
; jsp-2.1
+
: Adds JSP Support (Identical to '''jsp''' mode.)
+
; plus
+
: Adds JAAS and JNDI Support
+
; annotations
+
: Adds Java Annotations Support to WebApps and Servlets for configuring themselves
+
; client
+
: Adds the Jetty Async HTTP Client Support for Handlers, WebApps, and Servlets to use to initiate outgoing HTTP connections.
+
; policy
+
: Adds SecurityManager Policy Support.
+
  
The exact JARs and classpath entries that will be activated for each mode are listed in the [[Jetty/Reference/Running Jetty Modes|Running Jetty Modes reference]] .
+
To run jetty with all options enabled:
==Alternative Startup Techniques==
+
  
===Embedded Startup===
+
<source lang="bash"> 
Jetty can be configured and started as an embedded Web App Server from within another Java program.
+
java -jar start.jar OPTIONS=All
See [[Jetty/Howto/Embed|Embedded Jetty]] for more details.
+
</source>
  
===Eclipse Startup===
+
To run with JSP support (if available)
  
Eclipse can be started up from within Eclipse using a variety of techniques, see [[Jetty/Howto/Embed|Use Jetty with Eclipse IDE]] for details.
+
<source lang="bash">
 +
java -jar start.jar OPTIONS=Server,jsp
 +
</source>
  
===JUnit Startup===
+
To run with JMX support
 +
 
 +
<source lang="bash">
 +
java -jar start.jar OPTIONS=Server,jmx etc/jetty-jmx.xml etc/jetty.xml
 +
</source>
 +
 
 +
To run with JSP & JMX support
 +
 
 +
<source lang="bash">
 +
java -jar start.jar OPTIONS=Server,jsp,jmx etc/jetty-jmx.xml etc/jetty.xml
 +
</source>
 +
 
 +
 
 +
 
 +
===Alternative Startup Techniques===
 +
 
 +
====Embedded Startup====
 +
Jetty can be configured and started as an embedded webapp server from within another Java program. See [[Jetty/Tutorial/Embedding_Jetty|Embedding Jetty Tutoral]] for more details.  Once you have a main that runs Jetty, it is very easy to run this from your IDE, debugger and/or profiler.
 +
 
 +
====Eclipse Startup====
 +
 
 +
Jetty can be started up from within Eclipse using a variety of techniques; see [[Jetty/Howto/Use Jetty with Eclipse|How to Use Jetty with Eclipse IDE]] for details.
 +
 
 +
====Jetty Maven Plugin====
 +
 
 +
You can run jetty directly on your maven webapp project - without even needing to assemble it into a war - see [[Jetty/Feature/Jetty Maven Plugin | The Jetty Maven Plugin]] for details.
 +
 
 +
====Jetty Ant Plugin====
 +
 
 +
You can run jetty directly on your ant webapp project - see [[Jetty/Howto/Use Jetty with Ant|The Jetty Ant Plugin]] for details.
 +
 
 +
====Jetty Runner====
 +
 
 +
You can run jetty from a single jar file on one or more webapps and contexts using the [[Jetty/Howto/Using Jetty Runner|Jetty Runner Jar]].
 +
 
 +
====JUnit Startup====
 +
 
 +
}}

Latest revision as of 12:44, 23 April 2013



Introduction


This howto covers how to start up Jetty as standalone, and links to pages which cover alternative methods of startup.


Steps

Standalone Startup

Using the Start.jar

The easiest way to start Jetty, is to use the start.jar that comes with the distribution.

java -jar start.jar

The default options may be specified in the start.ini file, or if that is not present, they are defined in the start.config file that is within the start.jar.

To see the command line options for start.jar and help text for start.jar use:

java -jar start.jar --help

For a full description of start.jar features see Jetty Start.jar Feature Guide.

More start.jar examples

To run jetty with all options enabled:

 
java -jar start.jar OPTIONS=All

To run with JSP support (if available)

 
java -jar start.jar OPTIONS=Server,jsp

To run with JMX support

 
java -jar start.jar OPTIONS=Server,jmx etc/jetty-jmx.xml etc/jetty.xml

To run with JSP & JMX support

 
java -jar start.jar OPTIONS=Server,jsp,jmx etc/jetty-jmx.xml etc/jetty.xml


Alternative Startup Techniques

Embedded Startup

Jetty can be configured and started as an embedded webapp server from within another Java program. See Embedding Jetty Tutoral for more details. Once you have a main that runs Jetty, it is very easy to run this from your IDE, debugger and/or profiler.

Eclipse Startup

Jetty can be started up from within Eclipse using a variety of techniques; see How to Use Jetty with Eclipse IDE for details.

Jetty Maven Plugin

You can run jetty directly on your maven webapp project - without even needing to assemble it into a war - see The Jetty Maven Plugin for details.

Jetty Ant Plugin

You can run jetty directly on your ant webapp project - see The Jetty Ant Plugin for details.

Jetty Runner

You can run jetty from a single jar file on one or more webapps and contexts using the Jetty Runner Jar.

JUnit Startup