Add Jetty documentation

This commit is contained in:
Mike Dillon 2015-02-06 00:25:18 -08:00
parent 085e98427d
commit bf6870d37f
5 changed files with 132 additions and 0 deletions

1
jetty/README-short.txt Normal file
View File

@ -0,0 +1 @@
Jetty provides a Web server and javax.servlet container, plus support for SPDY, WebSocket, OSGi, JMX, JNDI, JAAS and many other integrations.

86
jetty/README.md Normal file
View File

@ -0,0 +1,86 @@
# Supported tags and respective `Dockerfile` links
For more information about this image and its history, please see the [relevant
manifest file
(`library/jetty`)](https://github.com/docker-library/official-images/blob/master/library/jetty)
in the [`docker-library/official-images` GitHub
repo](https://github.com/docker-library/official-images).
# 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)](https://en.wikipedia.org/wiki/Jetty_(web_server))
![logo](https://raw.githubusercontent.com/docker-library/docs/master/jetty/logo.png)
Logo © Eclipse Foundation
# How to use this image.
Run the default Jetty server (`CMD ["jetty.sh", "run"]`):
docker run -d jetty:9
You can test it by visiting `http://container-ip:8080` in a browser or, if you
need access outside the host, on port 8888:
docker run -d -p 8888:8080 jetty:9
You can then go to `http://localhost:8888` or `http://host-ip:8888` in a
browser.
The default Jetty environment in the image is:
JETTY_HOME = /usr/local/jetty
JETTY_CONF = /usr/local/jetty/etc/jetty.conf
JETTY_STATE = /usr/local/jetty/jetty.state
JETTY_ARGS =
JAVA_OPTIONS =
TMPDIR = /tmp
Webapps can be [deployed](https://wiki.eclipse.org/Jetty/Howto/Deploy_Web_Applications)
in `/usr/local/jetty/webapps`.
# License
View [license information](http://eclipse.org/jetty/licenses.php) for the
software contained in this image.
# Supported Docker versions
This image is officially supported on Docker version 1.4.1.
Support for older versions (down to 1.0) is provided on a best-effort basis.
# User Feedback
## Issues
If you have any problems with or questions about this image, please contact us
through a [GitHub issue](https://github.com/docker-library/jetty/issues).
You can also reach many of the official image maintainers via the
`#docker-library` IRC channel on [Freenode](https://freenode.net).
## 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](https://github.com/docker-library/jetty/issues), 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.

43
jetty/content.md Normal file
View File

@ -0,0 +1,43 @@
# 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)](https://en.wikipedia.org/wiki/Jetty_(web_server))
%%LOGO%%
Logo © Eclipse Foundation
# How to use this image.
Run the default Jetty server (`CMD ["jetty.sh", "run"]`):
docker run -d jetty:9
You can test it by visiting `http://container-ip:8080` in a browser or, if you
need access outside the host, on port 8888:
docker run -d -p 8888:8080 jetty:9
You can then go to `http://localhost:8888` or `http://host-ip:8888` in a
browser.
The default Jetty environment in the image is:
JETTY_HOME = /usr/local/jetty
JETTY_CONF = /usr/local/jetty/etc/jetty.conf
JETTY_STATE = /usr/local/jetty/jetty.state
JETTY_ARGS =
JAVA_OPTIONS =
TMPDIR = /tmp
Webapps can be [deployed](https://wiki.eclipse.org/Jetty/Howto/Deploy_Web_Applications)
in `/usr/local/jetty/webapps`.

2
jetty/license.md Normal file
View File

@ -0,0 +1,2 @@
View [license information](http://eclipse.org/jetty/licenses.php) for the
software contained in this image.

BIN
jetty/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB