Guides v1.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

Running Kuzzle #

This section learns you how to quickly get Kuzzle up and running using our installation script.

Open a terminal and run the following command:

Copied to clipboard!
bash -c "$(curl"

This command downloads and executes the installation script. The script checks the system for a set of prerequisites and installs missing ones, such as Docker. When the installation is complete, it will automatically run Kuzzle.

There are also more alternative ways to install Kuzzle.

This command downloads, installs and runs Kuzzle.

Use the --no-run option to prevent the script from running Kuzzle.

Once the installation process is complete, you will see the following message:

Copied to clipboard!
# Kuzzle is now running

Your Kuzzle is now running! To test it, you can explore the main HTTP API by clicking this link or by using cURL on the command line:

Copied to clipboard!
curl "http://localhost:7512/?pretty"

If everything is working you should see a JSON document that contains a list of API endpoints.

Congratulations! You have completed the Kuzzle installation, it will now accept requests on localhost:7512:

  • via HTTP
  • via Websocket

Having trouble?

  • Get in touch with us on Discord
  • Try one of these alternative installation methods

Helper scripts for systemd #

If you want to run Kuzzle automatically at startup there are a few scripts that help you do this with systemd.

If you want to run Kuzzle automatically at startup there are a few scripts in $PWD/kuzzle/script/ that help you do this with systemd:

  • Run the as root to add a service inside /etc/systemd/system that will start Kuzzle on boot.
  • Run the as root to remove the service so that Kuzzle won't start on boot.

What now? #

Now that Kuzzle is up and running, you can start playing around with it: