Skip to content

Commit

Permalink
Merge pull request #8 from CESNET/readme
Browse files Browse the repository at this point in the history
Updated README and introduce LICENSE
  • Loading branch information
xsedla1o authored Feb 4, 2025
2 parents dcae3da + 721b3a2 commit aad87a1
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 4 deletions.
29 changes: 29 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2025, CESNET
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# ADiCT-lite
CESNET's ADiCT (Asset Discovery, Classification and Tagging) project, in a lightweight version.
<div align="center">
<picture>
<source srcset="https://raw.githubusercontent.com/CESNET/Pandda-ADiCT/refs/heads/main/img/logo_horizontal_white.svg" media="(prefers-color-scheme: dark)">
<img src="https://raw.githubusercontent.com/CESNET/Pandda-ADiCT/refs/heads/main/img/logo_horizontal_black.svg">
</picture>
</div>

The configuration and additional modules for the ADiCT-lite project are located in the `dp3_server` directory.
The input data collector modules are located in the `nemea_modules` directory.
PANDDA-ADiCT is a streamlined version of CESNET's Asset Discovery, Classification, and Tagging (ADiCT) system. It provides a lightweight yet powerful approach to asset discovery and classification using modular components.

## Project Structure
```
dp3_server/ – Contains the configuration and additional modules for PANDDA-ADiCT.
nemea_modules/ – Hosts the input data collector modules based on the NEMEA framework.
fronted/ - webapp in vue.js presenting the asset discovery results
```

## Installation & Usage
This repository is intedet to be used with PANDDA infrastructure. Here are other PANDDA:
* https://github.com/CESNET/Pandda-Playbooks/

Clone the repository:
```
git clone https://github.com/CESNET/Pandda-ADiCT.git
cd Pandda-ADiCT
```

0 comments on commit aad87a1

Please sign in to comment.