Supported tags and respective `Dockerfile` links

For more information about this image and its history, please see the relevant manifest file (library/jetty). This image is updated via pull requests to the docker-library/official-images GitHub repo.

For detailed information about the virtual/transfer sizes and individual layers of each of the above supported tags, please see the jetty/tag-details.md file in the docker-library/docs GitHub repo.

What is Jetty?

Jetty is a pure Java-based HTTP (Web) server and Java Servlet container. While Web Servers are usually associated with serving documents to people, Jetty is now often used for machine to machine communications, usually within larger software frameworks. Jetty is developed as a free and open source project as part of the Eclipse Foundation. The web server is used in products such as Apache ActiveMQ, Alfresco, Apache Geronimo, Apache Maven, Apache Spark, Google App Engine, Eclipse, FUSE, Twitter's Streaming API and Zimbra. Jetty is also the server in open source projects such as Lift, Eucalyptus, Red5, Hadoop and I2P. Jetty supports the latest Java Servlet API (with JSP support) as well as protocols SPDY and WebSocket.

wikipedia.org/wiki/Jetty_(web_server)

Logo © Eclipse Foundation

How to use this image.

To run the default Jetty server in the background, use the following command:

$ docker run -d jetty

You can test it by visiting http://container-ip:8080 or https://container-ip:8443/ in a browser. To expose your Jetty server to outside requests, use a port mapping as follows:

$ docker run -d -p 80:8080 -p 443:8443 jetty

This will map port 8080 inside the container as port 80 on the host and container port 8443 as host port 443. You can then go to http://host-ip or https://host-ip in a browser.

Environment

The default Jetty environment in the image is:

JETTY_HOME    =  /usr/local/jetty
JETTY_BASE    =  /var/lib/jetty
TMPDIR        =  /tmp/jetty

Deployment

Webapps can be deployed under /var/lib/jetty/webapps in the usual ways (WAR file, exploded WAR directory, or context XML file). To deploy your application to the / context, use the name ROOT.war, the directory name ROOT, or the context file ROOT.xml (case insensitive).

For older EOL'd images based on Jetty 7 or Jetty 8, please follow the legacy instructions on the Eclipse Wiki and deploy under /usr/local/jetty/webapps instead of /var/lib/jetty/webapps.

Configuration

The configuration of the Jetty server can be reported by running with the --list-config option:

$ docker run -d jetty --list-config

Configuration such as parameters and additional modules may also be passed in via the command line. For example:

$ docker run -d jetty --modules=jmx jetty.threadPool.maxThreads=500

To update the server configuration in a derived Docker image, the Dockerfile may enable additional modules with RUN commands like:

FROM jetty

RUN java -jar "$JETTY_HOME/start.jar" --add-to-startd=jmx,stats

Modules may be configured in a Dockerfile by editing the properties in the corresponding /var/lib/jetty/start.d/*.mod file or the module can be deactivated by removing that file.

Read-only container

To run jetty as a read-only container, have Docker create the /tmp/jetty and /run/jetty directories as volumes:

$ docker run -d --read-only -v /tmp/jetty -v /run/jetty jetty

Since the container is read-only, you'll need to either mount in your webapps directory with -v /path/to/my/webapps:/var/lib/jetty/webapps or by populating /var/lib/jetty/webapps in a derived image.

HTTP/2 Support

Starting with version 9.3, Jetty comes with built-in support for HTTP/2. However, due to potential license compatiblity issues with the ALPN library used to implement HTTP/2, the module is not enabled by default. In order to enable HTTP/2 support in a derived Dockerfile for private use, you can add a RUN command that enables the http2 module and approve its license as follows:

FROM jetty

RUN java -jar \$JETTY_HOME/start.jar --add-to-startd=http2 --approve-all-licenses

This will add an http2.ini file to the $JETTY_BASE/start.d directory and download the required ALPN libraries into $JETTY_BASE/lib/alpn, allowing the use of HTTP/2. HTTP/2 connections should be made via the same port as normal HTTPS connections (container port 8443). If you would like to enable the http2 module via $JETTY_BASE/start.ini instead, substitute --add-to-start in place of --add-to-startd in the RUN command above.

Once OpenJDK 9 becomes generally available with built-in support for ALPN, this image will be updated to enable HTTP/2 support by default.

Security

By default, this image starts as user root and uses Jetty's setuid module to drop privileges to user jetty after initialization. The JETTY_BASE directory at /var/lib/jetty is owned by jetty:jetty (uid 999, gid 999).

If you would like the image to start immediately as user jetty instead of starting as root, you can start the container with -u jetty:

$ docker run -d -u jetty jetty

License

View license information for the software contained in this image.

Supported Docker versions

This image is officially supported on Docker version 1.9.1.

Support for older versions (down to 1.6) is provided on a best-effort basis.

Please see the Docker installation documentation for details on how to upgrade your Docker daemon.

User Feedback

Documentation

Documentation for this image is stored in the jetty/ directory of the docker-library/docs GitHub repo. Be sure to familiarize yourself with the repository's README.md file before attempting a pull request.

Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue.

You can also reach many of the official image maintainers via the #docker-library IRC channel on Freenode.

Contributing

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

README.md 7.9 KB History Raw

Supported tags and respective Dockerfile links