From 1aa13bfa133d8ac8b5219d0e7050dee13b4bd5ba Mon Sep 17 00:00:00 2001
From: vandanrohatgi <vandanrohatgi@gmail.com>
Date: Wed, 31 Aug 2022 09:45:29 +0530
Subject: [PATCH] Move installation instructions to install.md

---
 install.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 install.md

diff --git a/install.md b/install.md
new file mode 100644
index 0000000..099562e
--- /dev/null
+++ b/install.md
@@ -0,0 +1,62 @@
+# Project Seaweed
+
+[![Tests](https://github.com/coreruleset/Project-Seaweed/workflows/Tests/badge.svg)](https://github.com/coreruleset/Project-Seaweed/actions?workflow=Tests)
+
+
+## Fetching CRS logs from the container
+
+This project does not provide the functionality to fetch the logs from CRS container. However, you can use the `--keep-setup` flag to prevent auto-removal of the docker setup (crs container, apache container and docker network). After that, you can fetch the audit logs using the following command.
+
+`docker cp crs-waf:/root/audit.log <path to save log file>`
+
+**Caveat**: If you specify `--keep-setup`, you are responsible for performing the cleanup activity. To do that, just enter the following commands.
+
+`docker stop crs-waf`
+
+`docker stop httpd-server`
+
+`docker network rm seaweed-network`
+
+## Installation
+
+1. **Clone the repository**
+
+`git clone https://github.com/coreruleset/Project-Seaweed.git`
+
+2. **Install poetry** 
+
+Poetry is a tool for dependency management and packaging in Python. 
+
+[https://python-poetry.org/docs/#installation](https://python-poetry.org/docs/#installation)
+
+3. **Install docker**
+
+This project needs docker to setup a local web server, web application firewall. If you're using a custom waf URL for testing, then docker is not needed. 
+
+[https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/)
+
+5. **Install Nuclei**
+
+The program uses Nuclei to launch attacks. Make sure nuclei is in the path and nuclei templates are installed in the home directory and not a custom directory. Install from here: [https://nuclei.projectdiscovery.io/nuclei/get-started/#nuclei-installation](https://nuclei.projectdiscovery.io/nuclei/get-started/#nuclei-installation)
+
+6. **Select Python version**
+
+The project is tested on Python `3.9.13`. If you have multiple python versions installed, use the following command:
+
+`poetry env use 3.9`
+
+7. **Install the project**
+
+`poetry install`
+
+8. **Finally run the project**
+
+`poetry run project-seaweed`
+
+9. **Get help**
+
+`poetry run project-seaweed --help`
+
+For command specific help
+
+`poetry run project-seaweed tester --help`