Skip to content

Commit

Permalink
renamed README.txt to README.TXT and updated contents
Browse files Browse the repository at this point in the history
  • Loading branch information
gregw committed Aug 28, 2013
1 parent c84063a commit e5b4f37
Show file tree
Hide file tree
Showing 10 changed files with 90 additions and 80 deletions.
File renamed without changes.
21 changes: 21 additions & 0 deletions jetty-distribution/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,27 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>exec</goal>
</goals>
</execution>
</executions>
<configuration>
<executable>java</executable>
<workingDirectory>${assembly-directory}</workingDirectory>
<arguments>
<argument>-jar</argument>
<argument>start.jar</argument>
<argument>--ini=http,demo</argument>
</arguments>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
Expand Down
53 changes: 53 additions & 0 deletions jetty-distribution/src/main/resources/README.TXT
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@

JETTY
=====
The Jetty project is a 100% Java HTTP Server, HTTP Client
and Servlet Container from the eclipse foundation

http://www.eclipse.org/jetty/

Jetty is open source and is dual licensed using the apache 2.0 and
eclipse public license 1.0. You may choose either license when distributing
jetty.



RUNNING JETTY
=============
The run directory is either the top-level of a binary release
or jetty-distribution/target/assembly-prep directory when built from
source.

To run with the default options:

java -jar start.jar

To see the available options and the default arguments
provided by the start.ini file:

java -jar start.jar --help


Many Jetty features can be enabled by using the --ini command to create
template configurations in the start.d directory. For example:

java -jar start.jar --ini=https

Will enable HTTPS and its dependencies in the files start.d/http.ini and start.d/ssl.ini
To list the know modules:

java -jar start.jar --list-modules



JETTY BASE
==========

If the property jetty.base is defined on the command line, then the jetty start.jar
mechanism will look for start.ini, start.d, webapps and etc files relative to the
jetty.home directory

java -jar start.jar jetty.base=/opt/myjettybase/



62 changes: 0 additions & 62 deletions jetty-distribution/src/main/resources/README.txt

This file was deleted.

32 changes: 15 additions & 17 deletions jetty-distribution/src/main/resources/start.d/README.TXT
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
Jetty start.d ini directory
===========================

This start.d directory contains modular ini files that are appended to the effective command line
This start.d directory contains *.ini files that are appended to the effective command line
used to start jetty by the command:

java -jar start.jar

Each line in these files is prepended to the real command line as arguments, and may be either:
+ A property like: name=value
+ A module to enable like: --module=jmx
+ An XML configuration file like: etc/jetty-feature.xml
+ A start.jar option like: --exec

If --exec or --dry-run are used, then these files may also contain lines with:
+ A JVM option like: -Xmx2000m
+ A System Property like: -Dcom.sun.management.jmxremote

The modules are executed in alphabetic order and the 'NNN-' prefixes are a convention to make that ordering
explicit regardless of module name.

All modules ending with '.ini' will be executed and it is a convention that disabled modules are renamed to
end with '.ini.disabled'. The start.jar mechanism can be used to enable/disable modules with commands like:
A template ini file may be created for known modules by using the --ini option.
For example to create an ini templates for https use the command

java -jar start.jar --enable=ssl --enable=spdy
java -jar start.jar --ini=https

Note that the numeric prefix can be skipped in such commands.


The ini modules have a simple dependency mechanism so a module can declare if it depends on or conflicts with
other modules. For example the spdy module includes the entries:

EXCLUDE=https
DEPEND=npn,ssl

This says that spdy cannot be used with the https module (both use the same port and spdy provides https) and
that the npn and ssl modules must also be enabled.
2 changes: 1 addition & 1 deletion jetty-distribution/src/main/resources/start.ini
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# java -jar start.jar --help
#
# Each line in these files is prepended to the command line
# as arguments, which may be either:
# as arguments and may be either:
# + A property like: name=value
# + A module to enable like: --module=jmx
# + An XML configuration file like: etc/jetty-feature.xml
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit e5b4f37

Please sign in to comment.