Skip to content
This repository was archived by the owner on Sep 20, 2023. It is now read-only.

Commit

Permalink
#70 update installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jeromeleonard committed Oct 26, 2020
1 parent 2162b9d commit 8ae373a
Showing 1 changed file with 82 additions and 10 deletions.
92 changes: 82 additions & 10 deletions installation/install-guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Installation Guide
This guide applies to Cortex 2 and newer only.

---
⚠️ _**Please read carrefully this documentation. Depending on you make a fresh installation or update an existing version, repository or packages names may vary.**_

Current supported versions of Cortex are:
- Version 3.1.0 and later that supports **only** Elasticsearch 7.x.

Instruction to install Cortex supporting Elasticsearch 6.x (EoL in Nov. 2020) are still detailled in this documentation.

---

Before installing Cortex, you need to choose the installation option which suits your environment as described below, install the analyzers then proceed to the configuration using the [Quick Start Guide](../admin/quick-start.md). For more advanced configuration options, please refer to the [Administration Guide](../admin/admin-guide.md).

Expand Down Expand Up @@ -45,26 +54,58 @@ Run the following command to import the GPG key :
sudo rpm --import https://raw.githubusercontent.com/TheHive-Project/TheHive/master/PGP-PUBLIC-KEY
```

---

#### Stable versions
#### Release versions

The release repository contains packages for **Cortex 3.1.0+**.

And setup your system to connect the RPM repository. Create and edit the file `/etc/yum.repos.d/thehive-project.repo`:


Setup your system to connect the RPM repository. Create and edit the file `/etc/yum.repos.d/thehive-project.repo`:

```bash
[thehive-project]
enabled=1
priority=1
name=TheHive-Project RPM repository
baseurl=http://rpm.thehive-project.org/stable/es7
baseurl=https://rpm.thehive-project.org/release/noarch
gpgcheck=1
```

Then you will able to install the package using `yum`:
Then you will able to install **Cortex 3.1.0+** the package using `yum`:

```bash
yum install cortex
```

---


#### Stable versions (or legacy versions)


The main repository is a legacy repository and contains packages for **Cortex 3.0.1** that **does not support Elasticsearch version 7.x**, but version 6.x.

Setup your system to connect the RPM repository. Create and edit the file `/etc/yum.repos.d/thehive-project.repo`:

```bash
[thehive-project]
enabled=1
priority=1
name=TheHive-Project RPM repository
baseurl=https://rpm.thehive-project.org/stable/noarch
gpgcheck=1
```

Then you will able to install **Cortex 3.0.1** package using `yum`:

```bash
yum install cortex
```

---

#### Following beta versions

To follow beta versions of Cortex, use the following setup:
Expand All @@ -86,7 +127,7 @@ Then you will able to install the package using `yum`:
yum install cortex
```

⚠️ **We do not recommend that configuration for production servers**
⚠️ **We do not recommend that configuration for production servers**

Once the package is installed, [install the analyzers](#analyzers-and-responders) as outlined in the next section and proceed to the configuration using the [Quick Start Guide](../admin/quick-start.md). For more advanced configuration options, please refer to the [Administration Guide](../admin/admin-guide.md).

Expand All @@ -96,15 +137,46 @@ Debian packages are published on a our DEB packages repository. All packages are

`0CD5 AC59 DE5C 5A8E 0EE1 3849 3D99 BB18 562C BC1C`

#### Release versions

---
The release repository contains packages for **Cortex 3.1.0+**.

---

Setup apt configuration with the `release` repository:

```bash
curl https://raw.githubusercontent.com/TheHive-Project/TheHive/master/PGP-PUBLIC-KEY | sudo apt-key add -
echo 'deb https://deb.thehive-project.org release main' | sudo tee -a /etc/apt/sources.list.d/thehive-project.list
sudo apt-get update
```

Then you will able to install **Cortex 3.1.0+** the package using `apt` command:

```bash
apt install cortex
```

#### Stable versions

To install the Debian package, use the following commands:
---
The main repository is a legacy repository and contains packages for **Cortex 3.1.0** that **does not support Elasticsearch version 7.x**, but version 6.x.

---

Setup apt configuration with the `main` repository:

```bash
curl https://raw.githubusercontent.com/TheHive-Project/TheHive/master/PGP-PUBLIC-KEY | sudo apt-key add -
echo 'deb https://deb.thehive-project.org stable main es7' | sudo tee -a /etc/apt/sources.list.d/thehive-project.list
echo 'deb https://deb.thehive-project.org main main' | sudo tee -a /etc/apt/sources.list.d/thehive-project.list
sudo apt-get update
sudo apt-get install cortex
```

Then you will able to install **Cortex 3.1.0+** package using `apt` command:

```bash
apt install cortex
```

#### Following beta versions
Expand All @@ -118,7 +190,7 @@ sudo apt-get update
sudo apt-get install cortex
```

⚠️ **We do not recommend that configuration for production servers**
⚠️ **We do not recommend that configuration for production servers**

### Docker
To use the Docker image, you must use [Docker](https://www.docker.com/) (courtesy of Captain Obvious).
Expand Down

0 comments on commit 8ae373a

Please sign in to comment.