Skip to main content
Version: Current

Installation

Nussknacker comes as a Docker Compose bundle that runs the Designer and everything it needs on a single host. Streaming scenarios run on a Flink MiniCluster inside the Designer and Request-Response scenarios on the embedded Lite engine, so no Flink cluster or Kubernetes is needed.

What you need​

  • Docker with the Compose plugin, and about 7 GB of memory available to it
  • Linux or macOS; on Windows, run the commands in a WSL terminal
  • the registry credentials and the license key you received from us; if you do not have them yet, contact us

Install​

Log in to our registry, unpack the bundle and start it:

docker login registry.nussknacker.io
docker run --rm --pull always -e NU_LICENSE_KEY='<license key>' registry.nussknacker.io/nussknacker/nussknacker-installation | tar -x
cd nussknacker && ./start.sh

Keep the license key in single quotes, so that the shell passes it unchanged. This installs the latest release; to install a specific version, add it to the image name, for example nussknacker-installation:<version>.

The Designer is then at http://localhost:8090, with the default admin / admin account.

License key​

The key is stored in the .env file in the nussknacker directory. Without it, the Designer runs with the basic components only and every other component is shown locked. To add or replace the key later, set NU_LICENSE_KEY in .env (copy .env.example if there is no .env yet) and run ./start.sh again.

Stop and upgrade​

./stop.sh stops the stack and keeps the data, ./stop-and-clean.sh removes the data as well.

To upgrade, run the same docker run command in the parent directory of nussknacker, without -e NU_LICENSE_KEY, and then ./start.sh. The data and .env are kept, but the other files are overwritten, so keep a copy of the ones you edited.

Configuration​

The bundle runs as it is. .env.example lists the settings worth changing, such as passwords, tokens and host ports, and README.md in the bundle describes the rest. Change the gateway token and the publisher password before you give anyone else access to the stack.