Install and run the Deephaven production application
This guide will show you how to install and launch the Deephaven Community Core production application. The production application runs Deephaven from artifacts produced during each release cycle. It runs Deephaven without installing Docker or building from source code. It is the recommended way to run production applications that use Deephaven, hence its name. This guide only covers getting started with the production application. For more advanced configuration options, see Configure the production application.
Prerequisites
| Package | Recommended version | Required version |
|---|---|---|
| java | latest LTS | >= 11 |
The production application is supported on Linux and Mac OS. Windows users must use Windows Subsystem for Linux (WSL) to run the production application.
Get the artifact
The Deephaven artifacts are attached to each Deephaven release. The latest release is available at https://github.com/deephaven/deephaven-core/releases/latest. Only one of the artifacts is required to run the production application:
- The server artifact in tar format.
It's recommended to set your preferred version with an environment variable. The shell commands in this guide set and use the DH_VERSION environment variable:
export DH_VERSION=0.36.1
You can download release artifacts from your browser of choice or via the command line:
wget https://github.com/deephaven/deephaven-core/releases/download/v${DH_VERSION}/server-jetty-${DH_VERSION}.tar
Unpack the server
Once downloaded, the server artifact needs to be unpacked. You can do this from your file explorer or from the command line.
tar xvf server-jetty-${DH_VERSION}.tar
Run the server
The server contains a bin/ directory with a start script. To start the server, invoke the start script:
START_OPTS="-Ddeephaven.console.type=groovy" ./server-jetty-${DH_VERSION}/bin/start
The server should now be up and running with stdout printed to the console and the web UI available at http://localhost:10000.
You can stop the server with ctrl+C or cmd+C.
Authentication
Deephaven, by default, uses pre-shared key authentication. If no key is set, a randomly generated key will be used to log into the server each time it starts. The randomly generated key is printed to the Docker logs like this:
To set your own pre-shared key, add -Dauthentication.psk=<YourPasswordHere> to the START_OPTS. The following command uses YOUR_PASSWORD_HERE as the pre-shared key.
START_OPTS="-Dauthentication.psk=YOUR_PASSWORD_HERE -Ddeephaven.console.type=groovy" server-jetty-${DH_VERSION}/bin/start
The following command uses anonymous authentication:
# Careful, anonymous authentication is not secure.
START_OPTS="-DAuthHandlers=io.deephaven.auth.AnonymousAuthenticationHandler -Ddeephaven.console.type=groovy" server-jetty-${DH_VERSION}/bin/start