@@ -251,6 +251,48 @@ echo " patterns:" >> rules/custom.yml
251251echo " - pattern: dangerous_function(...)" >> rules/custom.yml
252252```
253253
254+ ### Using Pre-built Docker Image
255+
256+ You can pull the pre-built image from Docker Hub and use it directly without cloning the repository:
257+
258+ ** Option 1: Using the wrapper script (Recommended)**
259+ ``` bash
260+ # Clone the repository for the wrapper script
261+ git clone https://github.com/fr4iser90/SimpleSecCheck.git
262+ cd SimpleSecCheck
263+
264+ # Pull the pre-built image instead of building
265+ docker pull fr4iser/simpleseccheck:latest
266+
267+ # Use the wrapper script with the pre-built image
268+ ./run-docker.sh /path/to/your/project
269+ ```
270+
271+ ** Option 2: Using Docker directly (Advanced)**
272+ ``` bash
273+ # Pull the latest image
274+ docker pull fr4iser/simpleseccheck:latest
275+
276+ # Scan a local code project
277+ docker run --rm \
278+ -v /path/to/your/project:/target:ro \
279+ -v $( pwd) /results:/SimpleSecCheck/results \
280+ -v $( pwd) /logs:/SimpleSecCheck/logs \
281+ -e SCAN_TYPE=code \
282+ fr4iser/simpleseccheck:latest \
283+ /SimpleSecCheck/scripts/security-check.sh
284+
285+ # Scan a website
286+ docker run --rm \
287+ -e SCAN_TYPE=website \
288+ -e ZAP_TARGET=https://example.com \
289+ -v $( pwd) /results:/SimpleSecCheck/results \
290+ fr4iser/simpleseccheck:latest \
291+ /SimpleSecCheck/scripts/security-check.sh
292+ ```
293+
294+ ** Note:** The pre-built image contains all necessary configurations. Option 1 is recommended as it handles all volume mounts and environment variables automatically.
295+
254296### Direct Docker Compose Usage
255297
256298For advanced users who want more control:
0 commit comments