forked from crate/crate
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathinstallation.txt
More file actions
107 lines (70 loc) · 3.44 KB
/
Copy pathinstallation.txt
File metadata and controls
107 lines (70 loc) · 3.44 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
============
Installation
============
This section describes how to install Crate on a single node. In order to
get a Crate 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
==================
Crate needs a working Java 7 virtual machine. We recommend
using `Oracle's Java`_ on OSX and OpenJDK_ on Linux Systems.
Crate requires at least `Java 7`_ in order to run.
The same JVM version must be used on all Crate nodes and clients.
We recommend installing Java 7 update 55 or later or Java 8 update 20 or later.
.. warning::
Previous versions of Java 7 can cause data corruption and data loss.
.. _install_targz:
Install via tar.gz
==================
.. highlight:: sh
After downloading the latest stable version of Crate 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 Crate 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 Crate Shell (Crash) is shipped with the tarball distribution.
You can start the shell using the ``crash`` command::
sh$ ./bin/crash
The Crate 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/admin/
**The admin interface runs on each node where Crate is installed.**
Install using Docker
====================
`Docker`_ is a lightweigt runtime to run distributed applications in a sandboxed container.
We provide a Docker image for Crate for easy installation::
sh$ docker pull crate
sh$ docker run -d -p 4200:4200 -p 4300:4300 crate crate -Des.cluster.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 Crate for Production
============================
We provide distributions for **RHEL/YUM** based systems, **Ubuntu**, **Debian** and **Arch Linux**.
You can find instruction how to install Crate 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 Crate <configuration>`
:doc:`Hello Crate <hello>` - To learn how to interact with Crate.
`Multi Node Setup`_ - To see how to install and run Crate in a Multi Node
setup.
.. _`Oracle's Java`: http://www.java.com/en/download/help/mac_install.xml
.. _OpenJDK: http://openjdk.java.net/projects/jdk7/
.. _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 7`: http://www.oracle.com/technetwork/java/javase/downloads/index.html