Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation update. Resolves #1549

This commit is contained in:
WalkerWatch 2017-11-09 13:19:29 -05:00
parent 1fb8b2e4ad
commit 64858a5f56
2 changed files with 26 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
jetty-documentation/src/main/asciidoc/administration/runner/jetty-runner.adoc
View File

@ -200,7 +200,7 @@ To link:#how-to-configure-connectors[configure a https connector], use a Jetty x
.... ....
===== Configuring Stop ===== Configuring Stop
You can configure a port number for jetty to listen on for a stop command, so you are able to stop it from a different terminal. You can configure a port number for Jetty to listen on for a stop command, so you are able to stop it from a different terminal.
This requires the use of a "secret" key, to prevent malicious or accidental termination. This requires the use of a "secret" key, to prevent malicious or accidental termination.
Use the `--stop-port` and `--stop-key` (or `-DSTOP.PORT=` and `-DSTOP.KEY=`, respectively) parameters as arguments to the `jetty-runner`: Use the `--stop-port` and `--stop-key` (or `-DSTOP.PORT=` and `-DSTOP.KEY=`, respectively) parameters as arguments to the `jetty-runner`:

27
jetty-documentation/src/main/asciidoc/administration/startup/start-jar.adoc
View File

@ -208,17 +208,40 @@ The port to use to stop the running Jetty server.
This is an internal port, opened on localhost, used solely for stopping the running Jetty server. This is an internal port, opened on localhost, used solely for stopping the running Jetty server.
Choose a port that you do not use to serve web traffic. Choose a port that you do not use to serve web traffic.
+ +
Required for --stop to function. Required for `--stop` to function.
STOP.KEY=<alphanumeric>;; STOP.KEY=<alphanumeric>;;
The passphrase defined to stop the server. The passphrase defined to stop the server.
+ +
Required for --stop to function. Required for `--stop` to function.
STOP.WAIT=<number>;; STOP.WAIT=<number>;;
The time (in seconds) to wait for confirmation that the running Jetty server has stopped. The time (in seconds) to wait for confirmation that the running Jetty server has stopped.
If not specified, the stopper waits indefinitely for the server to stop. If not specified, the stopper waits indefinitely for the server to stop.
+ +
If the time specified elapses, without a confirmation of server stop, then the `--stop` command exits with a non-zero return code. If the time specified elapses, without a confirmation of server stop, then the `--stop` command exits with a non-zero return code.
You can configure a port number for Jetty to listen on for a stop command, so you are able to stop it from a different terminal.
This requires the use of a "secret" key, to prevent malicious or accidental termination.
Use the `STOP.PORT` and `STOP.KEY` (or `-DSTOP.PORT=` and `-DSTOP.KEY=`, respectively, which will set these as system parameters) parameters as arguments to the `start.jar`:
[source, screen, subs="{sub-order}"]
....
> java -jar ${JETTY_HOME}/start.jar STOP.PORT=1234 STOP.KEY=secretpassword
....
Then, to stop Jetty from a different terminal, you need to supply this port and key information.
You can either use a copy of the Jetty distribution, the link:#jetty-maven-plugin[jetty-maven-plugin], the link:#jetty-ant[jetty-ant plugin], or a custom class to accomplish this.
Here's how to use the Jetty distribution, leveraging `start.jar`, to perform a stop:
[source, screen, subs="{sub-order}"]
....
> java -jar start.jar STOP.PORT=8181 STOP.KEY=abc123 --stop
....
____
[NOTE]
To perform a graceful shutdown of Jetty, the `stats` link:#startup-modules[module] *must* be enabled.
____
===== Advanced Commands ===== Advanced Commands
--lib=<classpath>:: --lib=<classpath>::