Running the Server

The overview, module and package pages, navigation, search data, styles, and scripts are generated in the background by the selected JDK's standard HTML doclet. Requests for those resources wait for the shared generation task when necessary.

Type pages are generated when their standard links are followed or when a direct /type request is made. Concurrent requests for the same type share one generation task, and generated resources remain available for the lifetime of the server. Links between generated pages target the local server, including links to locally supplied JDK sources.

Generated files live in a temporary workspace that is removed when the server shuts down.

For the default JDK, the index is the standard Javadoc module overview.

Server options

The default binding is 127.0.0.1 on port 8000. Select the binding or port explicitly:

jdocserver --bind-address 0.0.0.0 --port 8080 @main.args

The default loopback binding keeps the server local. Binding to 0.0.0.0 or :: exposes it on all available interfaces.

The short option -p retains its standard Java meaning, --module-path; server ports therefore use --port.

Open the index or a type when the server starts:

jdocserver --browse @main.args
jdocserver --browse=com.example.application.Main @main.args