jetty.project/README.md

67 lines
2.2 KiB
Markdown
Raw Normal View History

Eclipse Jetty Canonical Repository
==================================
2017-08-09 17:41:25 -04:00
This is the canonical repository for the Jetty project, feel free to fork and contribute now!
2016-02-12 09:15:03 -05:00
2017-03-01 15:47:09 -05:00
Submitting a patch or pull request?
2017-03-01 15:47:09 -05:00
Make sure you have an Eclipse Contributor Agreement (ECA) on file.
2017-03-01 15:47:09 -05:00
- [eclipse.org/legal/ecafaq](https://www.eclipse.org/legal/ecafaq.php)
2016-02-12 09:15:03 -05:00
2014-12-11 13:43:55 -05:00
Project description
-------------------
2013-08-30 10:04:21 -04:00
Jetty is a lightweight highly scalable java based web server and servlet engine.
2017-08-09 17:41:25 -04:00
Our goal is to support web protocols like HTTP, HTTP/2 and WebSocket in a high volume low latency way that provides maximum performance while retaining the ease of use and compatibility with years of servlet development.
Jetty is a modern fully async web server that has a long history as a component oriented technology easily embedded into applications while still offering a solid traditional distribution for webapp deployment.
2014-12-11 13:43:55 -05:00
- [https://projects.eclipse.org/projects/rt.jetty](https://projects.eclipse.org/projects/rt.jetty)
Webapp Example
--------------
```shell
$ mkdir base && cd base
$ java -jar $JETTY_HOME/start.jar --add-modules=http,deploy
$ cp ~/src/myproj/target/mywebapp.war webapps
$ java -jar $JETTY_HOME/start.jar
```
Embedded Example
----------------
```java
Server server = new Server(port);
ServletContextHandler context = new ServletContextHandler(server, "/");
context.addServlet(MyServlet.class, "/*");
server.start();
```
2014-12-11 13:43:55 -05:00
Documentation
-------------
2014-12-11 13:43:55 -05:00
Project documentation is available on the Jetty Eclipse website.
2014-12-11 13:43:55 -05:00
2019-11-05 17:23:49 -05:00
- [https://www.eclipse.org/jetty/documentation](https://www.eclipse.org/jetty/documentation)
2016-07-20 00:02:13 -04:00
Building
========
To build, use:
2017-03-01 15:47:09 -05:00
``` shell
2016-07-20 00:02:13 -04:00
mvn clean install
```
Eclipse Jetty will be built in `jetty-home/target/jetty-home`.
2016-07-20 00:02:13 -04:00
The first build may take a longer than expected as Maven downloads all the dependencies.
2016-07-20 00:02:13 -04:00
The build tests do a lot of stress testing, and on some machines it is necessary to set the file descriptor limit to greater than 2048 for the tests to all pass successfully.
2016-07-20 00:02:13 -04:00
It is possible to bypass tests by building with `mvn clean install -DskipTests`.
2014-12-11 13:43:55 -05:00
Professional Services
---------------------
2014-12-11 13:43:55 -05:00
2019-11-05 17:23:49 -05:00
Expert advice and production support are available through [Webtide.com](https://webtide.com).