Skip to content

Commit 0139520

Browse files
magl0copybara-github
authored andcommitted
Add document for the quick_start.sh command.
PiperOrigin-RevId: 316707845 Change-Id: Ifacf3c04aa1f8d1f90a290f294c633e0e9474375
1 parent 94b3680 commit 0139520

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,30 @@ repository.
1717
* Tsunami project is currently under active development. Do expect major API
1818
changes in the future.
1919

20+
## Quick Start
21+
22+
To quickly get started with Tsunami scans, execute the following command.
23+
24+
```shell
25+
sh -c "$(curl -sfL https://raw.githubusercontent.com/google/tsunami-security-scanner/master/quick_start.sh)"
26+
```
27+
28+
The `quick_start.sh` script performs the following tasks:
29+
30+
1. Clone the
31+
[google/tsunami-security-scanner](https://github.com/google/tsunami-security-scanner)
32+
and
33+
[google/tsunami-security-scanner-plugins](https://github.com/google/tsunami-security-scanner-plugins)
34+
repos into `$HOME/tsunami/repos` directory.
35+
1. Compile all
36+
[Google Tsunami plugins](https://github.com/google/tsunami-security-scanner-plugins/tree/master/google)
37+
and move all plugin `jar` files into `$HOME/tsunami/plugins` directory.
38+
1. Compile the Tsunami scanner Fat Jar file and move it into `$HOME/tsunami`
39+
directory.
40+
1. Move the `tsunami.yaml` example config into `$HOME/tsunami` directory.
41+
1. Print example Tsunami command for scanning `127.0.0.1` using the previously
42+
generated artifacts.
43+
2044
## Contributing
2145

2246
Read how to [contribute to Tsunami](docs/contributing.md).

0 commit comments

Comments
 (0)