Skip to content

Commit adbde7d

Browse files
authored
Merge pull request #36 from angelej/docker-instructions
Add docker usage section
2 parents ac26cb8 + 958b25a commit adbde7d

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

Diff for: README.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ It's not designed to be a fully-automated tool for identifying vulnerabilities,
77
> **Warning!** This repository is currently under development and may contain breaking changes.
88
99
## Installation
10-
This tool requires `php ^8.1`, `ext-dom`, `ext-simplexml`, `ext-tokenizer`, `ext-xml`, `ext-xmlwriter`, and `composer`.
10+
If this tool is used without docker, you have to install `php ^8.1`, `ext-dom`, `ext-simplexml`, `ext-tokenizer`, `ext-xml`, `ext-xmlwriter`, and `composer`.
1111
1. Clone repository
1212
```shell
1313
git clone https://github.com/angelej/php-insider.git
@@ -19,8 +19,23 @@ This tool requires `php ^8.1`, `ext-dom`, `ext-simplexml`, `ext-tokenizer`, `ext
1919
```
2020

2121
## Basic Usage
22+
### Without using Docker
2223
```shell
23-
insider@linux:~$ ./bin/insider analyse src/
24+
insider@linux:~$ ./bin/insider analyse /path/to/app
25+
ExecSink found in file src/Command.php › Ⓒ Command › ⓜ execute
26+
5▕ public function execute(string $cmd){
27+
6▕
28+
➜ 7▕ return exec($cmd);
29+
8▕ }
30+
9▕ }
31+
32+
33+
Summary: 1 sink found
34+
```
35+
36+
### Using Docker
37+
```shell
38+
insider@linux:~$ docker run --rm -it -v /path/to/app:/app angelej/php-insider:latest analyse /app/src
2439
ExecSink found in file src/Command.php › Ⓒ Command › ⓜ execute
2540
5▕ public function execute(string $cmd){
2641
6▕

0 commit comments

Comments
 (0)