Skip to content

Commit 2bf5c98

Browse files
committed
chore: introduce new README.md
Repository is now used to build Clear NDR ISO.
1 parent 996def4 commit 2bf5c98

File tree

2 files changed

+44
-182
lines changed

2 files changed

+44
-182
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Clear NDR Community
2+
3+
## Overview
4+
5+
This repository contains the ressources and tools needed to build ISO images for the Clear NDR Community, a Linux distribution focused on network detection and response (NDR).
6+
7+
The repository was previously known as SELKS but has been rebranded to Clear NDR Community to better reflect profound architectural changes. See the [Clear NDR Community](https://www.stamus-networks.com/clear-ndr-community/) page on Stamus Networks website for more details.
8+
9+
To get more information about Clear NDR and learn how to use it, please visit [Clear NDR documentation](https://docs.clearndr.io).
10+
11+
## Source Code
12+
13+
This repository is used to build the ISO images for Clear NDR Community. It contains a script and the associated configuration files to build the ISO images.
14+
15+
Clear NDR is using [stamusctl](https://github.com/StamusNetworks/stamusctl) to manage the installation and configuration of the system. The configuration files used by stamusctl are stored in a separate repository:
16+
[Stamusctl Templates](https://github.com/StamusNetworks/stamusctl-templates/tree/main/data/clearndr).
17+
18+
Please use the [stamusctl](https://github.com/StamusNetworks/stamusctl/issues) repository to open issues related to Clear NDR Community.
19+
20+
## Building the ISO
21+
22+
To build the ISO images, you need to have a working installation of [Debian](https://www.debian.org). The build process has been tested on Debian 11 (Bullseye). You will also need to install the dependencies via the install-deps.sh script:
23+
24+
```sh
25+
sudo ./install-deps.sh
26+
```
27+
28+
To build the ISO image, clone this repository and run the build script:
29+
30+
```sh
31+
sudo ./build-debian-live.sh
32+
```
33+
34+
To build the headless ISO image, run the build script with the `-g no-desktop` option:
35+
36+
```sh
37+
sudo ./build-debian-live.sh -g no-desktop
38+
```
39+
40+
For help and more options, run:
41+
42+
```sh
43+
./build-debian-live.sh -h
44+
```

README.rst

Lines changed: 0 additions & 182 deletions
This file was deleted.

0 commit comments

Comments
 (0)