From 79578c34a6299d8a7ed79441744b6cc69bc1cc7b Mon Sep 17 00:00:00 2001 From: Maxim Malakhov Date: Fri, 22 Nov 2024 22:28:34 +0300 Subject: [PATCH] Docs update --- LICENSE | 24 +++++++ README.md | 179 +++++++++++++++++++++++++++++++++++++++++++++++++++- SECURITY.md | 9 +++ 3 files changed, 210 insertions(+), 2 deletions(-) create mode 100644 LICENSE create mode 100644 SECURITY.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..066739c --- /dev/null +++ b/LICENSE @@ -0,0 +1,24 @@ +MIT License +----------- + +Copyright (c) 2024 Maxim Malakhov +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index d9a01a1..856ef75 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,178 @@ -suricata-update -f +

+ +

+

❯ Suricata Grafana Docker

+

+ ❯ lanakod-networking +

+

+

+

Built with the tools and technologies:

+

+ Grafana + Docker +

+
-Dashboard Id: 22247 \ No newline at end of file +## Table of Contents + +- [ Overview](#-overview) +- [ Features](#-features) +- [ Project Structure](#-project-structure) + - [ Project Index](#-project-index) +- [ Getting Started](#-getting-started) + - [ Prerequisites](#-prerequisites) + - [ Installation](#-installation) + - [ Usage](#-usage) + - [ Testing](#-testing) +- [ Project Roadmap](#-project-roadmap) +- [ Contributing](#-contributing) +- [ License](#-license) +- [ Acknowledgments](#-acknowledgments) + +--- + +## Overview + +❯ TODO + +--- + +## Features + +❯ TODO + +--- + +## Project Structure + +```sh +└── / + ├── docker-compose.yml + ├── eve.json + ├── loki-local-config.yaml + ├── promtail-config.yml + ├── readme-ai.md + ├── README.md + ├── suricata + │ ├── classification.config + │ ├── reference.config + │ ├── suricata.yaml + │ ├── threshold.config + │ └── update.yaml + └── suricata-rules + └── .gitkeep +``` + + +### Project Index +
+ / +
+ __root__ +
+ + + + + + + + + + + + + + + + + +
docker-compose.yml❯ Docker compose config file
eve.json❯ Suricata logs
loki-local-config.yaml❯ Loki configuration file
promtail-config.yml❯ Promtail configuration file
+
+
+
+ suricata +
+ + + + + + + + + + + + + + + + + + + + + +
classification.config❯ Suricata config
reference.config❯ Suricata config
suricata.yaml❯ Suricata config
threshold.config❯ Suricata config
update.yaml❯ Suricata config
+
+
+
+ +--- +## Getting Started + +### Prerequisites + +Before getting started with , ensure your runtime environment meets the following requirements: + +- **Programming Language:** Error detecting primary_language: {'yml': 2, 'json': 1, 'yaml': 3, 'config': 3} +- **Container Runtime:** Docker + + +### Installation + +Install using one of the following methods: + +**Build from source:** + +1. Clone the repository: +```sh +❯ git clone https://github.com/Lanakod-Networks/suricata-grafana-docker.git +``` + +2. Navigate to the project directory: +```sh +❯ cd suricata-grafana-docker +``` + +3. Run docker compose: + + +**Using `docker`**   [](https://www.docker.com/) + +```sh +❯ docker compose up -d +``` + +4. Inside suricata docker container exec command: +```sh +suricata-update -f +``` + +5. After signing in into Grafana don't forget to add dashboard with id `22247` +--- +## Project Roadmap + +- [X] **`Task 1`**: Implement feature one. +- [ ] **`Task 2`**: Implement feature two. +- [ ] **`Task 3`**: Implement feature three. + +--- + +## License + +This project is protected under the [MIT LICENSE](./LICENSE) License. For more details, refer to the [LICENSE](./LICENSE) file. + +--- \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..19676bc --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,9 @@ +# Security Policy + +## Reporting a Vulnerability + +Please report any security issues you discovered to security@lanakod.ru. If the issue is confirmed, we will release a patch as soon as possible depending on complexity. + +**Do NOT create public issues on GitHub for security vulnerabilities.** + +Thank you for your contribution!