Added some docs

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.

README.md

@@ -0,0 +1,60 @@
+# Snort-docker
+
+![GitHub](https://img.shields.io/github/license/lanakod/snort-docker)
+
+## How to deploy
+
+```shell
+git clone https://github.com/Lanakod/snort-docker.git
+cd snort-docker
+cp .env.example .env
+# Edit ".env" file via "nano .env" or "vi .env"
+docker compose up -d
+# Grafana will be hosted on port 3000 and ELK on 5601
+```
+
+## Configuration
+
+```
+configs
+ ┣ snort-conf
+ ┃ ┣ balanced.lua
+ ┃ ┣ connectivity.lua
+ ┃ ┣ file_magic.rules
+ ┃ ┣ inline.lua
+ ┃ ┣ max_detect.lua
+ ┃ ┣ security.lua
+ ┃ ┣ sensitive_data.rules
+ ┃ ┣ snort.lua
+ ┃ ┣ snort_defaults.lua
+ ┃ ┗ talos.lua
+ ┣ filebeat.yml
+ ┣ logstash.conf
+ ┣ promtail.yml
+ ┣ snort.rules
+ ┗ supervisord.conf
+```
+
+- `snort.rules` - your custom written rules for snort
+- `filebeat.yml` - config file for filebeat | needed for ELK
+- `logstash.yml` - config file for logstash | needed for ELK
+- `promtail.yml` - config file for promtail | needed for Grafana
+- `supervisord.conf` - config file that runs snort in supervisor
+- `snorf-conf` - folder with all snort config files written in lua
+
+```
+grafana
+ ┗ provisioning
+ ┃ ┗ datasources
+ ┃ ┃ ┗ loki.yml
+```
+
+- In grafana folder can be found `loki.yml` file
+
+## Contact
+
+- For any security issues, please do not create a public issue on GitHub, instead please write to security@lanakod.ru
+
+## License
+
+snort-docker is [MIT licensed](https://github.com/lanakod/snort-docker/blob/master/LICENSE).

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!