Skip to content

Commit 6be73f9

Browse files
AnneLaure1307AnneLaure1307
authored
DOC-410 & DOC-405 (#109)
* First draft * Added link in installation procedures * Created equivalent for Cortex * Added links * Functional check * Changed package pages names * Changed admonition type * Reduced explanation in security * Modified ways to find latest packages * Updated package page * Changed a text * Changed TOC * Small adjustments * Removed manifest for Cortex
1 parent cf49c86 commit 6be73f9

16 files changed

Lines changed: 218 additions & 37 deletions

‎docs/cortex/installation-and-configuration/cortex-packages.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Cortex Package Repository
2+
3+
Cortex packages are distributed as RPM and DEB files, as well as ZIP binary packages, all available for direct download via tools like `wget` or `curl`, with installation performed manually.
4+
5+
All packages are hosted on an [HTTPS-secured website](https://cortex.download.strangebee.com/){target=_blank} and come with a [SHA256 checksum](https://linux.die.net/man/1/sha256sum){target=_blank} and a [GPG](https://www.gnupg.org/){target=_blank} signature for verification.
6+
7+
For detailed installation instructions, see [Step-by-Step Installation Guide](step-by-step-guide.md).
8+
9+
## Repository structure
10+
11+
```bash
12+
/
13+
├─ <major.minor>/
14+
│ ├─ asc/
15+
│ ├─ deb/
16+
│ ├─ rpm/
17+
│ ├─ sha256/
18+
│ └─ zip/
19+
```
20+
21+
At the top level, each directory corresponds to a Cortex release branch.
22+
23+
Within each version directory, packages are grouped by distribution format:
24+
25+
* `deb/`: Debian and Ubuntu packages
26+
* `rpm/`: Packages for RHEL-compatible and Fedora distributions
27+
* `zip/`: Standalone binary distributions
28+
* `asc/`: GPG signature files used to verify the authenticity of packages
29+
* `sha256/`: SHA256 checksum files used to verify package integrity
30+
31+
## Package naming convention
32+
33+
All Cortex packages follow standard Linux packaging conventions.
34+
35+
* For DEB packages: `<product>_<major.minor.patch>-<packaging_revision>_<architecture>.<package_format>`
36+
* For RPM packages: `<product>-<major.minor.patch>-<packaging_revision>.<architecture>.<package_format>`
37+
* For ZIP packages: `<product>-<major.minor.patch>-<packaging_revision>.<package_format>`
38+
39+
### Understanding packaging revisions
40+
41+
The packaging revision number identifies successive builds of the same Cortex application version. This number increases monotonically and indicates the build sequence. The same version with different packaging revisions contain identical Cortex application code.
42+
43+
Always use the highest packaging revision available for a given version to benefit from packaging improvements.
44+
45+
<h2>Next steps</h2>
46+
47+
* [Step-by-Step Installation Guide](step-by-step-guide.md)

‎docs/cortex/installation-and-configuration/step-by-step-guide.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ This section provides step-by-step instructions to install Cortex and configure
200200

201201
### Installation
202202

203-
Cortex packages are distributed as RPM and DEB files available for direct download via tools like Wget or cURL, with installation performed manually.
203+
Cortex packages are distributed as RPM and DEB files available for direct download via tools like `wget` or `curl`, with installation performed manually.
204204

205205
All packages are hosted on an HTTPS-secured website and come with a [SHA256 checksum](https://linux.die.net/man/1/sha256sum){target=_blank} and a [GPG](https://www.gnupg.org/){target=_blank} signature for verification.
206206

@@ -215,7 +215,7 @@ All packages are hosted on an HTTPS-secured website and come with a [SHA256 chec
215215

216216
1. Download the binary package along with its SHA256 checksum and signature files. You can install Cortex anywhere on your filesystem.
217217

218-
* Using Wget
218+
* Using `wget`
219219

220220
```bash
221221
wget -O /opt/cortex/cortex-{% include-markdown "includes/cortex-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1.zip https://cortex.download.strangebee.com/{% include-markdown "includes/cortex-latest-version.md" start="<!--start-shortversion-->" end="<!--end-shortversion-->" %}/zip/cortex-{% include-markdown "includes/cortex-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1.zip
@@ -234,7 +234,10 @@ All packages are hosted on an HTTPS-secured website and come with a [SHA256 chec
234234
* Replace `<file_name>` with the full name of the versioned file you want to install. For example, use `cortex-3.2.1-2`.
235235
* Replace `<major.minor_version>` with the corresponding version directory. For example, use `3.2`.
236236

237-
* Using cURL
237+
!!! tip "Package repository"
238+
For details on package organization and naming conventions, see [Cortex Package Repository](cortex-packages.md).
239+
240+
* Using `curl`
238241

239242
```bash
240243
curl -o /opt/cortex/cortex-{% include-markdown "includes/cortex-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1.zip https://cortex.download.strangebee.com/{% include-markdown "includes/cortex-latest-version.md" start="<!--start-shortversion-->" end="<!--end-shortversion-->" %}/zip/cortex-{% include-markdown "includes/cortex-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1.zip
@@ -253,6 +256,9 @@ All packages are hosted on an HTTPS-secured website and come with a [SHA256 chec
253256
* Replace `<file_name>` with the full name of the versioned file you want to install. For example, use `cortex-3.2.1-2`.
254257
* Replace `<major.minor_version>` with the corresponding version directory. For example, use `3.2`.
255258

259+
!!! tip "Package repository"
260+
For details on package organization and naming conventions, see [Cortex Package Repository](cortex-packages.md).
261+
256262
2. Verify the integrity of the downloaded package.
257263

258264
* Check the SHA256 checksum by comparing it with the provided value.
@@ -273,7 +279,7 @@ All packages are hosted on an HTTPS-secured website and come with a [SHA256 chec
273279

274280
* Verify the GPG signature using the public key.
275281
276-
a. Download the public key at [keys.download.strangebee.com](https://keys.download.strangebee.com){target=_blank} using Wget or cURL.
282+
a. Download the public key at [keys.download.strangebee.com](https://keys.download.strangebee.com){target=_blank} using `wget` or `curl`.
277283

278284
```bash
279285
wget -O /opt/strangebee.gpg https://keys.download.strangebee.com/latest/gpg/strangebee.gpg

‎docs/includes/manual-download-installation-cortex.md‎

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
1. Download the installation package along with its SHA256 checksum and signature files.
77

8-
* Using Wget:
8+
* Using `wget`:
99

1010
```bash
1111
wget -O /tmp/cortex_{% include-markdown "includes/cortex-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1_all.deb https://cortex.download.strangebee.com/{% include-markdown "includes/cortex-latest-version.md" start="<!--start-shortversion-->" end="<!--end-shortversion-->" %}/deb/cortex_{% include-markdown "includes/cortex-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1_all.deb
@@ -24,7 +24,10 @@
2424
* Replace `<file_name>` with the full name of the versioned file you want to install. For example, use `cortex_3.2.1-2_all`.
2525
* Replace `<major.minor_version>` with the corresponding version directory. For example, use `3.2`.
2626

27-
* Using cURL:
27+
!!! tip "Package repository"
28+
For details on package organization and naming conventions, see [Cortex Package Repository](/cortex/installation-and-configuration/cortex-packages/).
29+
30+
* Using `curl`:
2831

2932
```bash
3033
curl -o /tmp/cortex_{% include-markdown "includes/cortex-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1_all.deb https://cortex.download.strangebee.com/{% include-markdown "includes/cortex-latest-version.md" start="<!--start-shortversion-->" end="<!--end-shortversion-->" %}/deb/cortex_{% include-markdown "includes/cortex-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1_all.deb
@@ -42,9 +45,12 @@
4245

4346
* Replace `<file_name>` with the full name of the versioned file you want to install. For example, use `cortex_3.2.1-2_all`.
4447
* Replace `<major.minor_version>` with the corresponding version directory. For example, use `3.2`.
48+
49+
!!! tip "Package repository"
50+
For details on package organization and naming conventions, see [Cortex Package Repository](/cortex/installation-and-configuration/cortex-packages/).
4551
4652

47-
2. Verify the integrity of the downloaded package.
53+
1. Verify the integrity of the downloaded package.
4854

4955
* Check the SHA256 checksum by comparing it with the provided value.
5056

@@ -64,7 +70,7 @@
6470

6571
* Verify the GPG signature using the public key.
6672
67-
a. Download the public key at [keys.download.strangebee.com](https://keys.download.strangebee.com){target=_blank} using Wget or cURL.
73+
a. Download the public key at [keys.download.strangebee.com](https://keys.download.strangebee.com){target=_blank} using `wget` or `curl`.
6874

6975
```bash
7076
wget -O /tmp/strangebee.gpg https://keys.download.strangebee.com/latest/gpg/strangebee.gpg
@@ -105,7 +111,7 @@
105111

106112
If you don't see `Good signature`, if the fingerprint differs, or if the signature is reported as `BAD`, don't install the package. This indicates the integrity or authenticity of the file can't be confirmed. Report the issue to the [StrangeBee Security Team](mailto:security@strangebee.com).
107113

108-
3. Install the package.
114+
2. Install the package.
109115

110116
* Using `apt-get` to manage dependencies automatically:
111117

@@ -126,7 +132,7 @@
126132

127133
1. Download the installation package along with its SHA256 checksum and signature files.
128134

129-
* Using Wget:
135+
* Using `wget`:
130136

131137
```bash
132138
wget -O /tmp/cortex-{% include-markdown "includes/cortex-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1.noarch.rpm https://cortex.download.strangebee.com/{% include-markdown "includes/cortex-latest-version.md" start="<!--start-shortversion-->" end="<!--end-shortversion-->" %}/rpm/cortex-{% include-markdown "includes/cortex-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1.noarch.rpm
@@ -145,7 +151,10 @@
145151
* Replace `<file_name>` with the full name of the versioned file you want to install. For example, use `cortex-3.2.1-1`.
146152
* Replace `<major.minor_version>` with the corresponding version directory. For example, use `3.2`.
147153

148-
* Using cURL:
154+
!!! tip "Package repository"
155+
For details on package organization and naming conventions, see [Cortex Package Repository](/cortex/installation-and-configuration/cortex-packages/).
156+
157+
* Using `curl`:
149158

150159
```bash
151160
curl -o /tmp/cortex-{% include-markdown "includes/cortex-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1.noarch.rpm https://cortex.download.strangebee.com/{% include-markdown "includes/cortex-latest-version.md" start="<!--start-shortversion-->" end="<!--end-shortversion-->" %}/rpm/cortex-{% include-markdown "includes/cortex-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1.noarch.rpm
@@ -164,7 +173,10 @@
164173
* Replace `<file_name>` with the full name of the versioned file you want to install. For example, use `cortex-3.2.1-1`.
165174
* Replace `<major.minor_version>` with the corresponding version directory. For example, use `3.2`.
166175

167-
2. Verify the integrity of the downloaded package.
176+
!!! tip "Package repository"
177+
For details on package organization and naming conventions, see [Cortex Package Repository](/cortex/installation-and-configuration/cortex-packages/).
178+
179+
1. Verify the integrity of the downloaded package.
168180

169181
* Check the SHA256 checksum by comparing it with the provided value.
170182

@@ -184,7 +196,7 @@
184196

185197
* Verify the GPG signature using the public key.
186198
187-
a. Download the public key at [keys.download.strangebee.com](https://keys.download.strangebee.com){target=_blank} using Wget or cURL.
199+
a. Download the public key at [keys.download.strangebee.com](https://keys.download.strangebee.com){target=_blank} using `wget` or `curl`.
188200

189201
```bash
190202
wget -O /tmp/strangebee.gpg https://keys.download.strangebee.com/latest/gpg/strangebee.gpg
@@ -225,7 +237,7 @@
225237

226238
If you don't see `Good signature`, if the fingerprint differs, or if the signature is reported as `BAD`, don't install the package. This indicates the integrity or authenticity of the file can't be confirmed. Report the issue to the [StrangeBee Security Team](mailto:security@strangebee.com).
227239

228-
3. Install the package.
240+
2. Install the package.
229241

230242
* Using `yum` to manage dependencies automatically:
231243

‎docs/includes/manual-download-installation-thehive.md‎

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
1. Download the installation package along with its SHA256 checksum and signature files.
77

8-
* Using Wget:
8+
* Using `wget`:
99

1010
```bash
1111
wget -O /tmp/thehive_{% include-markdown "includes/thehive-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1_all.deb https://thehive.download.strangebee.com/{% include-markdown "includes/thehive-latest-version.md" start="<!--start-shortversion-->" end="<!--end-shortversion-->" %}/deb/thehive_{% include-markdown "includes/thehive-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1_all.deb
@@ -24,7 +24,10 @@
2424
* Replace `<file_name>` with the full name of the versioned file you want to install. For example, use `thehive_5.5.14-2_all`.
2525
* Replace `<major.minor_version>` with the corresponding version directory. For example, use `5.5`.
2626

27-
* Using cURL:
27+
!!! tip "Package repository"
28+
For details on package organization and naming conventions, see [TheHive Package Repository](/thehive/installation/thehive-packages/).
29+
30+
* Using `curl`:
2831

2932
```bash
3033
curl -o /tmp/thehive_{% include-markdown "includes/thehive-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1_all.deb https://thehive.download.strangebee.com/{% include-markdown "includes/thehive-latest-version.md" start="<!--start-shortversion-->" end="<!--end-shortversion-->" %}/deb/thehive_{% include-markdown "includes/thehive-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1_all.deb
@@ -43,6 +46,9 @@
4346
* Replace `<file_name>` with the full name of the versioned file you want to install. For example, use `thehive_5.5.14-2_all`.
4447
* Replace `<major.minor_version>` with the corresponding version directory. For example, use `5.5`.
4548

49+
!!! tip "Package repository"
50+
For details on package organization and naming conventions, see [TheHive Package Repository](/thehive/installation/thehive-packages/).
51+
4652
4753
2. Verify the integrity of the downloaded package.
4854

@@ -64,7 +70,7 @@
6470

6571
* Verify the GPG signature using the public key.
6672
67-
a. Download the public key at [keys.download.strangebee.com](https://keys.download.strangebee.com){target=_blank} using Wget or cURL.
73+
a. Download the public key at [keys.download.strangebee.com](https://keys.download.strangebee.com){target=_blank} using `wget` or `curl`.
6874

6975
```bash
7076
wget -O /tmp/strangebee.gpg https://keys.download.strangebee.com/latest/gpg/strangebee.gpg
@@ -126,7 +132,7 @@
126132

127133
1. Download the installation package along with its SHA256 checksum and signature files.
128134

129-
* Using Wget:
135+
* Using `wget`:
130136

131137
```bash
132138
wget -O /tmp/thehive-{% include-markdown "includes/thehive-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1.noarch.rpm https://thehive.download.strangebee.com/{% include-markdown "includes/thehive-latest-version.md" start="<!--start-shortversion-->" end="<!--end-shortversion-->" %}/rpm/thehive-{% include-markdown "includes/thehive-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1.noarch.rpm
@@ -145,7 +151,10 @@
145151
* Replace `<file_name>` with the full name of the versioned file you want to install. For example, use `thehive-5.5.14-2`.
146152
* Replace `<major.minor_version>` with the corresponding version directory. For example, use `5.5`.
147153

148-
* Using cURL:
154+
!!! tip "Package repository"
155+
For details on package organization and naming conventions, see [TheHive Package Repository](/thehive/installation/thehive-packages/).
156+
157+
* Using `curl`:
149158

150159
```bash
151160
curl -o /tmp/thehive-{% include-markdown "includes/thehive-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1.noarch.rpm https://thehive.download.strangebee.com/{% include-markdown "includes/thehive-latest-version.md" start="<!--start-shortversion-->" end="<!--end-shortversion-->" %}/rpm/thehive-{% include-markdown "includes/thehive-latest-version.md" start="<!--start-fullversion-->" end="<!--end-fullversion-->" %}-1.noarch.rpm
@@ -163,9 +172,11 @@
163172

164173
* Replace `<file_name>` with the full name of the versioned file you want to install. For example, use `thehive-5.5.14-2`.
165174
* Replace `<major.minor_version>` with the corresponding version directory. For example, use `5.5`.
166-
167175

168-
2. Verify the integrity of the downloaded package.
176+
!!! tip "Package repository"
177+
For details on package organization and naming conventions, see [TheHive Package Repository](/thehive/installation/thehive-packages/).
178+
179+
1. Verify the integrity of the downloaded package.
169180
170181
* Check the SHA256 checksum by comparing it with the provided value.
171182

@@ -185,7 +196,7 @@
185196

186197
* Verify the GPG signature using the public key.
187198
188-
a. Download the public key at [keys.download.strangebee.com](https://keys.download.strangebee.com){target=_blank} using Wget or cURL.
199+
a. Download the public key at [keys.download.strangebee.com](https://keys.download.strangebee.com){target=_blank} using `wget` or `curl`.
189200

190201
```bash
191202
wget -O /tmp/strangebee.gpg https://keys.download.strangebee.com/latest/gpg/strangebee.gpg
@@ -226,7 +237,7 @@
226237

227238
If you don't see `Good signature`, if the fingerprint differs, or if the signature is reported as `BAD`, don't install the package. This indicates the integrity or authenticity of the file can't be confirmed. Report the issue to the [StrangeBee Security Team](mailto:security@strangebee.com).
228239

229-
3. Install the package.
240+
2. Install the package.
230241

231242
* Using `yum` to manage dependencies automatically:
232243

‎docs/resources/security.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,18 @@ Local account passwords are stored using strong cryptographic hashing. TheHive i
2222

2323
This approach ensures that passwords remain protected against brute-force attacks even if the database is compromised.
2424

25+
## Software supply chain transparency
26+
27+
TheHive provides [SBOM](https://github.com/resources/articles/what-is-an-sbom-software-bill-of-materials){target=_blank} files for its published packages. These files describe the third-party components and dependencies included in the backend and frontend of each TheHive build and are provided for transparency and audit purposes. They don't affect the runtime behavior of TheHive.
28+
29+
SBOM files are intended to support:
30+
31+
* Security audits
32+
* Vulnerability management processes
33+
* Compliance and regulatory requirements
34+
35+
For details on retrieving SBOM files, see [TheHive Package Repository](../thehive/installation/thehive-packages.md).
36+
2537
<h2>Next steps</h2>
2638

2739
* [Install TheHive on Linux Systems](../thehive/installation/installation-guide-linux-standalone-server.md)

0 commit comments

Comments
 (0)