Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGreg Wilkins2013-08-28 14:32:36 +0000
committerGreg Wilkins2013-08-28 14:32:36 +0000
commite5b4f37b624527247748c65cf1dd0faf415ead0c (patch)
tree6101922a7f015fa5e26f94e80da6a7e0cb265f11 /jetty-distribution
parentc84063a5f82085f39ec405649fb76bec2c5923d8 (diff)
downloadorg.eclipse.jetty.project-e5b4f37b624527247748c65cf1dd0faf415ead0c.tar.gz
org.eclipse.jetty.project-e5b4f37b624527247748c65cf1dd0faf415ead0c.tar.xz
org.eclipse.jetty.project-e5b4f37b624527247748c65cf1dd0faf415ead0c.zip
renamed README.txt to README.TXT and updated contents
Diffstat (limited to 'jetty-distribution')
-rw-r--r--jetty-distribution/pom.xml21
-rw-r--r--jetty-distribution/src/main/resources/README.TXT53
-rw-r--r--jetty-distribution/src/main/resources/README.txt62
-rw-r--r--jetty-distribution/src/main/resources/start.d/README.TXT32
-rw-r--r--jetty-distribution/src/main/resources/start.ini2
5 files changed, 90 insertions, 80 deletions
diff --git a/jetty-distribution/pom.xml b/jetty-distribution/pom.xml
index 8481ab2313..68da23956f 100644
--- a/jetty-distribution/pom.xml
+++ b/jetty-distribution/pom.xml
@@ -462,6 +462,27 @@
</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>
<configuration>
diff --git a/jetty-distribution/src/main/resources/README.TXT b/jetty-distribution/src/main/resources/README.TXT
new file mode 100644
index 0000000000..5b476754c2
--- /dev/null
+++ b/jetty-distribution/src/main/resources/README.TXT
@@ -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/
+
+
+
diff --git a/jetty-distribution/src/main/resources/README.txt b/jetty-distribution/src/main/resources/README.txt
deleted file mode 100644
index 9656bab431..0000000000
--- a/jetty-distribution/src/main/resources/README.txt
+++ /dev/null
@@ -1,62 +0,0 @@
-
-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.
-
-
-
-BUILDING JETTY
-==============
-Jetty uses maven 2 as its build system. Maven will fetch
-the dependancies, build the server and assemble a runnable
-version:
-
- mvn install
-
-
-
-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
-
-
-Most start options can be configured in the start.ini file or they can be appended to the start line.
-
-To run with extra configuration file(s) appended, eg SSL
-
- java -jar start.jar etc/jetty-https.xml
-
-To run with properties
-
- java -jar start.jar jetty.port=8081
-
-To run with extra configuration file(s) prepended, eg logging & jmx
-
- java -jar start.jar --pre=etc/jetty-logging.xml --pre=etc/jetty-jmx.xml
-
-To run without the args from start.ini
-
- java -jar start.jar --ini OPTIONS=Server,websocket etc/jetty.xml etc/jetty-deploy.xml etc/jetty-ssl.xml
-
-to list the know OPTIONS:
-
- java -jar start.jar --list-options
-
diff --git a/jetty-distribution/src/main/resources/start.d/README.TXT b/jetty-distribution/src/main/resources/start.d/README.TXT
index 28e2492913..4a6256c5a6 100644
--- a/jetty-distribution/src/main/resources/start.d/README.TXT
+++ b/jetty-distribution/src/main/resources/start.d/README.TXT
@@ -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.
diff --git a/jetty-distribution/src/main/resources/start.ini b/jetty-distribution/src/main/resources/start.ini
index 4818161a83..01cf21feb8 100644
--- a/jetty-distribution/src/main/resources/start.ini
+++ b/jetty-distribution/src/main/resources/start.ini
@@ -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

Back to the top