============

Installation

============

This section describes how to install CrateDB on a single node. In order to

get a CrateDB cluster up and running it is enough to repeat the process on

another machine if the network supports multicast. The Nodes will discover and

form a cluster automatically. Just like magic.

In case the network doesn't support multicast, a unicast configuration is

required. Please refer to our article on `Multi Node Setup`_ in order to learn

how to setup the unicast configuration.

Java (JVM) version

==================

CrateDB requires a working `Java 8`_ virtual machine. We recommend

using `Oracle's Java`_ on OSX and OpenJDK_ on Linux Systems.

The same JVM version must be used on all CrateDB nodes and clients.

We recommend installing `Java 8`_ update 20 or later.

.. _install_targz:

Install via tar.gz

==================

.. highlight:: sh

After downloading the latest stable version of CrateDB from

`https://crate.io/download/ <https://crate.io/download/>`_

the package needs to be unpacked::

sh$ tar zxf crate-*.tar.gz

sh$ cd crate-*

Once unpacked CrateDB can be started in the foreground like this::

sh$ ./bin/crate

In order to start in the background add the ``-d`` option. If started in the

foreground you can use ``Control-C`` to stop the process again.

The CrateDB Shell (Crash) is shipped with the tarball distribution.

You can start the shell using the ``crash`` command::

sh$ ./bin/crash

The CrateDB distribution also comes with a web based administration

interface. It is served on port ``4200`` and you can access it with

your browser once Crate is started::

http://host1.example.com:4200/

**The admin interface runs on each node where CrateDB is installed.**

**If the previous URL is accessed via libraries (eg. cURL),

or via offline browsers (eg. wget) the request will be handled

by the CrateDB Rest API, and the response will be JSON.**

Install using Docker

====================

`Docker`_ is a lightweigt runtime to run distributed applications in a sandboxed container.

We provide a Docker image for CrateDB for easy installation::

sh$ docker pull crate

sh$ docker run -d -p 4200:4200 -p 4300:4300 crate crate -Ccluster.name=my_cluster

The images are hosted on the `Docker Hub Registry`_. There is additional information

on how to run Crate in a Docker container on the `docker-crate`_ Github repository.

.. _install_production:

Install CrateDB for Production

==============================

We provide distributions for **RHEL/YUM** based systems, **Ubuntu**, **Debian** and **Arch Linux**.

You can find instruction how to install CrateDB for production on

the Download_ page.

In case your distribution is missing feel free to `contact us

<https://crate.io/about/contact/>`_. We're happy to create and maintain

additional packages if we see enough interest.

.. seealso::

:doc:`Configuring CrateDB <configuration>`

:doc:`Hello CrateDB <hello>` - To learn how to interact with CrateDB.

`Multi Node Setup`_ - To see how to install and run CrateDB in a Multi Node

setup.

.. _`Oracle's Java`: http://www.java.com/en/download/help/mac_install.xml

.. _OpenJDK: http://openjdk.java.net/projects/jdk8/

.. _Download: https://crate.io/download/

.. _Docker: https://www.docker.com/

.. _`Docker Hub Registry`: https://registry.hub.docker.com/u/crate/crate/

.. _`docker-crate`: https://github.com/crate/docker-crate/

.. _`Multi Node Setup`: https://crate.io/blog/using-crate-in-multinode-setup/

.. _`Java 8`: http://www.oracle.com/technetwork/java/javase/downloads/index.html