@@ -73,19 +73,14 @@ SimpleSecCheck is a powerful, single-shot Docker-based security scanner that per
7373- Docker and Docker Compose
7474- Target codebase or web application to scan
7575
76- ### Quick Start (Pre-built Image - Recommended)
77-
78- ** Option 1: Using Pre-built Image from Docker Hub** ⭐ Recommended
76+ ### Easy Usage
7977
8078``` bash
8179# Clone the repository
8280git clone https://github.com/fr4iser90/SimpleSecCheck.git
8381cd SimpleSecCheck
8482
85- # Pull the pre-built image
86- docker pull fr4iser/simpleseccheck:latest
87-
88- # Make the script executable
83+ # Make the script executable (one-time setup)
8984chmod +x run-docker.sh
9085
9186# Scan a local code project
@@ -95,22 +90,34 @@ chmod +x run-docker.sh
9590./run-docker.sh https://example.com
9691```
9792
98- ** Option 2: Build from Source**
93+ That's it! Results will be available in the ` results/ ` directory.
94+
95+ ### Using Pre-built Docker Image Directly (Without Wrapper Script)
96+
97+ ** Pull and run the pre-built image from Docker Hub:**
9998
10099``` bash
101- # Clone the repository
102- git clone https://github.com/fr4iser90/SimpleSecCheck.git
103- cd SimpleSecCheck
100+ # Pull the latest image
101+ docker pull fr4iser/simpleseccheck:latest
104102
105- # Make the script executable
106- chmod +x run-docker.sh
103+ # Scan a local code project
104+ docker run --rm \
105+ -v /path/to/your/project:/target:ro \
106+ -v $( pwd) /results:/SimpleSecCheck/results \
107+ -v $( pwd) /logs:/SimpleSecCheck/logs \
108+ -e SCAN_TYPE=code \
109+ fr4iser/simpleseccheck:latest \
110+ /SimpleSecCheck/scripts/security-check.sh
107111
108- # The script will automatically build the Docker image on first run
109- ./run-docker.sh /path/to/your/project
112+ # Scan a website
113+ docker run --rm \
114+ -e SCAN_TYPE=website \
115+ -e ZAP_TARGET=https://example.com \
116+ -v $( pwd) /results:/SimpleSecCheck/results \
117+ fr4iser/simpleseccheck:latest \
118+ /SimpleSecCheck/scripts/security-check.sh
110119```
111120
112- That's it! Results will be available in the ` results/ ` directory.
113-
114121### Scan Examples
115122
116123#### 🌐 Website/Domain Scanning
@@ -270,32 +277,6 @@ echo " patterns:" >> rules/custom.yml
270277echo " - pattern: dangerous_function(...)" >> rules/custom.yml
271278```
272279
273- ### Using Docker Directly (Advanced)
274-
275- For advanced users who want to use Docker directly without the wrapper script:
276-
277- ``` bash
278- # Pull the latest image
279- docker pull fr4iser/simpleseccheck:latest
280-
281- # Scan a local code project
282- docker run --rm \
283- -v /path/to/your/project:/target:ro \
284- -v $( pwd) /results:/SimpleSecCheck/results \
285- -v $( pwd) /logs:/SimpleSecCheck/logs \
286- -e SCAN_TYPE=code \
287- fr4iser/simpleseccheck:latest \
288- /SimpleSecCheck/scripts/security-check.sh
289-
290- # Scan a website
291- docker run --rm \
292- -e SCAN_TYPE=website \
293- -e ZAP_TARGET=https://example.com \
294- -v $( pwd) /results:/SimpleSecCheck/results \
295- fr4iser/simpleseccheck:latest \
296- /SimpleSecCheck/scripts/security-check.sh
297- ```
298-
299280### Direct Docker Compose Usage
300281
301282For advanced users who want more control:
0 commit comments