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:
+
+
+
+
❯ 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
+/
+++
++ +docker-compose.yml ++ ❯ Docker compose config file
+ +eve.json ++ ❯ Suricata logs
+ +loki-local-config.yaml ++ ❯ Loki configuration file
+ +promtail-config.yml ++ ❯ Promtail configuration file
+++
++ +classification.config ++ ❯ Suricata config
+ +reference.config ++ ❯ Suricata config
+ +suricata.yaml ++ ❯ Suricata config
+ +threshold.config ++ ❯ Suricata config
+ +update.yaml ++ ❯ Suricata config