Skip to content

Commit

Permalink
fix usage
Browse files Browse the repository at this point in the history
Signed-off-by: olivier lamy <olamy@apache.org>
  • Loading branch information
olamy committed Mar 18, 2019
1 parent 7f7e2d6 commit bcc6443
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 28 deletions.
59 changes: 35 additions & 24 deletions README.md
Expand Up @@ -51,24 +51,28 @@ To run different web applications for diffent virtual hosts:


## Command-line options
Usage: java winstone.Launcher [--option=value] [--option=value] [etc]

Required options: either --webroot OR --warfile OR --webappsDir OR --hostsDir
--webroot = set document root folder.
--warfile = set location of warfile to extract from.
--webappsDir = set directory for multiple webapps to be deployed from
Other options:
Usage: java -jar jenkins.war [--option=value] [--option=value]

Options:
--webroot = folder where the WAR file is expanded into. Default is ${JENKINS_HOME}/war
--pluginroot = folder where the plugin archives are expanded into. Default is ${JENKINS_HOME}/plugins
(NOTE: this option does not change the directory where the plugin archives are stored)
--extractedFilesFolder = folder where extracted files are to be located. Default is the temp folder
--daemon = fork into background and run as daemon (Unix only)
--logfile = redirect log messages to this file
--enable-future-java = allows running with new Java versions which are not fully supported (class version 52 and above)
--javaHome = Override the JAVA_HOME variable
--toolsJar = The location of tools.jar. Default is JAVA_HOME/lib/tools.jar
--config = load configuration properties from here. Default is ./winstone.properties
--prefix = add this prefix to all URLs (eg http://localhost:8080/prefix/resource). Default is none
--commonLibFolder = folder for additional jar files. Default is ./lib

--extraLibFolder = folder for additional jar files to add to Jetty classloader

--logThrowingLineNo = show the line no that logged the message (slow). Default is false
--logThrowingThread = show the thread that logged the message. Default is false
--debug = set the level of debug msgs (1-9). Default is 5 (INFO level)

--httpPort = set the http listening port. -1 to disable, Default is 8080
--httpListenAddress = set the http listening address. Default is all interfaces
--httpKeepAliveTimeout = how long idle HTTP keep-alive connections are kept around (in ms; default 5000)?
Expand All @@ -81,35 +85,42 @@ To run different web applications for diffent virtual hosts:
--httpsPrivateKey = this switch with --httpsCertificate can be used to run HTTPS with OpenSSL secret key
/ --httpsCertificate file and the corresponding certificate file
--http2Port = set the http2 listening port. -1 to disable, Default is disabled
--http2ListenAddress = set the http2 listening address. Default is all interfaces
--http2ListenAddress = set the http2 listening address. Default is all interfaces
--excludeCipherSuites = set the ciphers to exclude (comma separated) (default is
// Exclude weak / insecure ciphers
"^.*_(MD5|SHA|SHA1)$",
// Exclude ciphers that don't support forward secrecy
"^TLS_RSA_.*$",
// The following exclusions are present to cleanup known bad cipher
// suites that may be accidentally included via include patterns.
// The default enabled cipher list in Java will not include these
// (but they are available in the supported list).
"^SSL_.*$",
"^.*_NULL_.*$",
"^.*_anon_.*$"
--controlPort = set the shutdown/control port. -1 to disable, Default disabled
--requestHeaderSize = sets the size of the buffer for request headers. Default is 8K.


--useJasper = enable jasper JSP handling (true/false). Default is false
--sessionTimeout = set the http session timeout value in minutes. Default to what webapp specifies, and then to 60 minutes
--sessionEviction = Set the session eviction timeout for idle sessions. Default value is 30min.
(-1 is never evict; 0 is evict-on-exit; and any other positive value is the time
in seconds that a session can be idle before it can be evicted)
--sessionEviction = set the session eviction timeout for idle sessions in seconds. Default value is 180. -1 never evict, 0 evict on exit
--mimeTypes=ARG = define additional MIME type mappings. ARG would be EXT=MIMETYPE:EXT=MIMETYPE:...
(e.g., xls=application/vnd.ms-excel:wmf=application/x-msmetafile)
--maxParamCount=N = set the max number of parameters allowed in a form submission to protect
against hash DoS attack (oCERT #2011-003). Default is 10000.
--useJmx = Enable Jetty JMX
--qtpMaxThreadsCount = max threads number when using Jetty Queued Thread Pool
--useJmx = Enable Jetty Jmx
--qtpMaxThreadsCount = max threads number when using Jetty Queued Thread Pool
--jettyAcceptorsCount = Jetty Acceptors number
--jettySelectorsCount = Jetty Selectors number
--usage / --help = show this message

Security options:
Security options:
--realmClassName = Set the realm class to use for user authentication. Defaults to ArgumentsRealm class

--argumentsRealm.passwd.<user> = Password for user <user>. Only valid for the ArgumentsRealm realm class
--argumentsRealm.roles.<user> = Roles for user <user> (comma separated). Only valid for the ArgumentsRealm realm class

--fileRealm.configFile = File containing users/passwds/roles. Only valid for the FileRealm realm class

Access logging:
Access logging:
--accessLoggerClassName = Set the access logger class to use for user authentication. Defaults to disabled
--simpleAccessLogger.format = The log format to use. Supports combined/common/resin/custom (SimpleAccessLogger only)
--simpleAccessLogger.file = The location pattern for the log file(SimpleAccessLogger only)
Expand Down
8 changes: 4 additions & 4 deletions src/main/resources/winstone/LocalStrings.properties
Expand Up @@ -121,14 +121,14 @@ Launcher.UsageInstructions.Options=\
\ --useJmx = Enable Jetty Jmx\n\
\ --qtpMaxThreadsCount = max threads number when using Jetty Queued Thread Pool\n\
\ --jettyAcceptorsCount = Jetty Acceptors number\n\
\ --jettySelectorsCount = Jetty Selectors number\n\
\ --usage / --help = show this message\n\n\
Security options:\n\
\ --jettySelectorsCount = Jetty Selectors number\n\
\ --usage / --help = show this message\n\
\ Security options:\n\
\ --realmClassName = Set the realm class to use for user authentication. Defaults to ArgumentsRealm class\n\n\
\ --argumentsRealm.passwd.<user> = Password for user <user>. Only valid for the ArgumentsRealm realm class\n\
\ --argumentsRealm.roles.<user> = Roles for user <user> (comma separated). Only valid for the ArgumentsRealm realm class\n\n\
\ --fileRealm.configFile = File containing users/passwds/roles. Only valid for the FileRealm realm class\n\n\
Access logging:\n\
\ Access logging:\n\
\ --accessLoggerClassName = Set the access logger class to use for user authentication. Defaults to disabled\n\
\ --simpleAccessLogger.format = The log format to use. Supports combined/common/resin/custom (SimpleAccessLogger only)\n\
\ --simpleAccessLogger.file = The location pattern for the log file(SimpleAccessLogger only)\n\n
Expand Down

0 comments on commit bcc6443

Please sign in to comment.