Converted README to md

Signed-off-by: Greg Wilkins <gregw@webtide.com>
This commit is contained in:
Greg Wilkins 2020-09-25 16:07:54 +02:00
parent ffd92d304d
commit c17bcc7db8
2 changed files with 66 additions and 48 deletions

View File

@ -0,0 +1,66 @@
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=<modulename>,...
```
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
```

View File

@ -1,48 +0,0 @@
ECLIPSE JETTY
=============
The Eclipse 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
Eclipse Public License 2.0 (https://www.eclipse.org/legal/epl-2.0)
and the Apache License v2.0 (https://www.apache.org/licenses/LICENSE-2.0)
You may choose either license when distributing Jetty.
RUNNING JETTY
=============
To run jetty you need to create a jetty base directory, that holds the
configuration separately from this jetty home distribution directory.
The following creates the jetty demonstration in a temporary base:
$ export JETTY_HOME=$PWD
$ mkdir /tmp/demo-base
$ cd /tmp/demo-base
$ java -jar $JETTY_HOME/start.jar --add-module=demo
$ java -jar $JETTY_HOME/start.jar
To create a minimal configuration that will support WAR deployment:
$ export JETTY_HOME=$PWD
$ mkdir /tmp/jetty-base
$ cd /tmp/jetty-base
$ java -jar $JETTY_HOME/start.jar --add-module=http,deploy
$ java -jar $JETTY_HOME/start.jar
Other modules can be added with the command:
$ java -jar $JETTY_HOME/start.jar --add-module=<modulename>,...
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