Running CrateDB on Windows

How to use the release archives to run CrateDB on Microsoft Windows.

Caution

We do not officially support CrateDB on Windows for production use. If you would like to deploy CrateDB on Windows, please feel free to contact us so we can work with you on a solution.

1. Download the latest CrateDB release archive for Windows.

2. Once downloaded, extract the archive either using your favorite terminal or command-line shell or by using a GUI tool like 7-Zip. We recommend using PowerShell when using terminal:

   # Extract Zip archive
   unzip -o crate-*.zip
   

3. On the terminal, change into the extracted crate directory:

   cd crate-*
   

4. Run a CrateDB single-node instance on the local network interface:

   ./bin/crate
   

5. You will be notified by an INFO message similar to this, when your single-node cluster is started successfully:

   [2022-07-04T19:41:12,340][INFO ][o.e.n.Node] [Aiguille Verte] started
   

6. In order to stop CrateDB again, use ctrl-c. You will be asked to terminate the job. Input Y:

   Terminate batch job (Y/N)? Y
   

See also

Consult the CLI tools documentation for further information about the ./bin/crate command.

Note

If you are installing CrateDB on a recent Windows Server edition, setting up the latest Microsoft Visual C++ 2019 Redistributable package is required. You can download it at msvcrt x86-64, msvcrt x86-32 or msvcrt ARM64.

Within the terminal, as a Windows user, the prompt after starting PowerShell will look like this.

PS> ./bin/crate

Post-install notes

After successfully installing CrateDB, for example on your workstation, the web-based Admin UI can be visited at:

http://localhost:4200/

See also

If you are new to CrateDB, you may want to follow up by taking the guided tour.

Also, let us outline those information entrypoints as suggestions to explore next:

• Read more details about the Configuration.

• The background about Bootstrap checks.

• Multi-node configuration within the section about Clustering and Going into production.

• When operating a CrateDB cluster in production, please also take performance tuning into consideration.

Note

This kind of installation flavor will let you quickly set up and start a single-node cluster. When adding additional CrateDB nodes, in order to make it form a multi-node cluster, you will need to reset (remove) the cluster state after changing the configuration.

Caution

Please make sure to read the General Upgrade Guidelines, and the guidelines about rolling upgrades and full restart upgrades, before upgrading a running cluster.