Skip to content

Commit

Permalink
deploy: d37e268
Browse files Browse the repository at this point in the history
  • Loading branch information
Prateek-Thakare committed Nov 30, 2023
1 parent 847d9c9 commit 51a594b
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 24 deletions.
8 changes: 4 additions & 4 deletions installation/installation-docker.html
Original file line number Diff line number Diff line change
Expand Up @@ -150,15 +150,15 @@ <h1 id="docker"><a class="header" href="#docker">Docker</a></h1>
<p>Considering that Mantis also includes mongoDB and AppSmith, we have provided a shell script that installs all the components.</p>
<h2 id="setup"><a class="header" href="#setup">Setup</a></h2>
<p>Clone the Mantis repository </p>
<pre><code class="language-shell">$ git clone https://github.com/PhonePe/mantis.git
<pre><code class="language-shell">git clone https://github.com/PhonePe/mantis.git
</code></pre>
<p>cd into the Mantis directory</p>
<pre><code class="language-shell">$ cd mantis/setup/docker
<pre><code class="language-shell">cd mantis/setup/docker
</code></pre>
<p>Run the respective docker setup file based on your OS</p>
<pre><code class="language-shell">$ ./docker-setup-macos.sh
<pre><code class="language-shell">./docker-setup-macos.sh

$ ./docker-setup-ubuntu.sh
./docker-setup-ubuntu.sh
</code></pre>

</main>
Expand Down
23 changes: 12 additions & 11 deletions print.html
Original file line number Diff line number Diff line change
Expand Up @@ -511,15 +511,15 @@ <h2 id="-feature-8"><a class="header" href="#-feature-8">😃 Feature</a></h2>
<p>Considering that Mantis also includes mongoDB and AppSmith, we have provided a shell script that installs all the components.</p>
<h2 id="setup"><a class="header" href="#setup">Setup</a></h2>
<p>Clone the Mantis repository </p>
<pre><code class="language-shell">$ git clone https://github.com/PhonePe/mantis.git
<pre><code class="language-shell">git clone https://github.com/PhonePe/mantis.git
</code></pre>
<p>cd into the Mantis directory</p>
<pre><code class="language-shell">$ cd mantis/setup/docker
<pre><code class="language-shell">cd mantis/setup/docker
</code></pre>
<p>Run the respective docker setup file based on your OS</p>
<pre><code class="language-shell">$ ./docker-setup-macos.sh
<pre><code class="language-shell">./docker-setup-macos.sh

$ ./docker-setup-ubuntu.sh
./docker-setup-ubuntu.sh
</code></pre>
<div style="break-before: page; page-break-before: always;"></div><h1 id="-configuration"><a class="header" href="#-configuration">🛠️ Configuration</a></h1>
<p>Once you have setup Mantis, you can now look at customising your scan requirements. Scan customisations are available via:</p>
Expand Down Expand Up @@ -852,29 +852,30 @@ <h2 id="scan-help"><a class="header" href="#scan-help">Scan Help</a></h2>
<h3 id="onboard-and-scan"><a class="header" href="#onboard-and-scan">Onboard and Scan</a></h3>
<hr />
<p>You want to onboard an org with its TLDs/IPs/IP-CIDRs/IP Range for the first time, use the onboard mode. This runs the scan on the default workflow.</p>
<p>You can use mantis command or directly run the framework using python3 launch.py. </p>
<h4 id="tld"><a class="header" href="#tld">TLD</a></h4>
<pre><code class="language-shell">$ python3 launch.py onboard -o org_name -t example.in
<pre><code class="language-shell">python3 launch.py onboard -o org_name -t example.in
</code></pre>
<h4 id="ip"><a class="header" href="#ip">IP</a></h4>
<pre><code class="language-shell">$ python3 launch.py onboard -o org_name -t 10.123.123.12
<pre><code class="language-shell">python3 launch.py onboard -o org_name -t 10.123.123.12
</code></pre>
<h4 id="ip-range"><a class="header" href="#ip-range">IP-Range</a></h4>
<pre><code class="language-shell">$ python3 launch.py onboard -o org_name -t 203.0.113.0-10
<pre><code class="language-shell">python3 launch.py onboard -o org_name -t 10.0.0.10-10
</code></pre>
<h4 id="ip-cidr"><a class="header" href="#ip-cidr">IP-CIDR</a></h4>
<pre><code class="language-shell">$ python3 launch.py onboard -o org_name -t 203.0.113.0/24
<pre><code class="language-shell">python3 launch.py onboard -o org_name -t 10.0.0.10/24
</code></pre>
<h3 id="onboard-known-assets-and-scan"><a class="header" href="#onboard-known-assets-and-scan">Onboard Known Assets and Scan</a></h3>
<pre><code class="language-shell">$ python3 launch.py onboard -o org_name -f input.txt
<pre><code class="language-shell">python3 launch.py onboard -o org_name -f input.txt
</code></pre>
<h3 id="scan-on-all-assets-belonging-to-an-organisation"><a class="header" href="#scan-on-all-assets-belonging-to-an-organisation">Scan on all assets belonging to an organisation</a></h3>
<hr />
<p>Now that you have onboarded, you just need to run scheduled scans for an org, you can just use the scan mode</p>
<pre><code class="language-shell">$ python3 launch.py scan -o org_name
<pre><code class="language-shell">python3 launch.py scan -o org_name
</code></pre>
<h3 id="scan-on-all-assets-belonging-to-an-organisation-and-app"><a class="header" href="#scan-on-all-assets-belonging-to-an-organisation-and-app">Scan on all assets belonging to an organisation and app</a></h3>
<hr />
<pre><code class="language-shell">$ python3 launch.py scan -o org_name -a app_name
<pre><code class="language-shell">python3 launch.py scan -o org_name -a app_name
</code></pre>
<div style="break-before: page; page-break-before: always;"></div><h1 id="-notifications"><a class="header" href="#-notifications">📨 Notifications</a></h1>
<p>Mantis currently supports the following clients for Notifications:</p>
Expand Down
15 changes: 8 additions & 7 deletions scan/scan.html
Original file line number Diff line number Diff line change
Expand Up @@ -154,29 +154,30 @@ <h1 id="-run-a-scan"><a class="header" href="#-run-a-scan">📨 Run a Scan</a></
<h3 id="onboard-and-scan"><a class="header" href="#onboard-and-scan">Onboard and Scan</a></h3>
<hr />
<p>You want to onboard an org with its TLDs/IPs/IP-CIDRs/IP Range for the first time, use the onboard mode. This runs the scan on the default workflow.</p>
<p>You can use mantis command or directly run the framework using python3 launch.py. </p>
<h4 id="tld"><a class="header" href="#tld">TLD</a></h4>
<pre><code class="language-shell">$ python3 launch.py onboard -o org_name -t example.in
<pre><code class="language-shell">python3 launch.py onboard -o org_name -t example.in
</code></pre>
<h4 id="ip"><a class="header" href="#ip">IP</a></h4>
<pre><code class="language-shell">$ python3 launch.py onboard -o org_name -t 10.123.123.12
<pre><code class="language-shell">python3 launch.py onboard -o org_name -t 10.123.123.12
</code></pre>
<h4 id="ip-range"><a class="header" href="#ip-range">IP-Range</a></h4>
<pre><code class="language-shell">$ python3 launch.py onboard -o org_name -t 203.0.113.0-10
<pre><code class="language-shell">python3 launch.py onboard -o org_name -t 10.0.0.10-10
</code></pre>
<h4 id="ip-cidr"><a class="header" href="#ip-cidr">IP-CIDR</a></h4>
<pre><code class="language-shell">$ python3 launch.py onboard -o org_name -t 203.0.113.0/24
<pre><code class="language-shell">python3 launch.py onboard -o org_name -t 10.0.0.10/24
</code></pre>
<h3 id="onboard-known-assets-and-scan"><a class="header" href="#onboard-known-assets-and-scan">Onboard Known Assets and Scan</a></h3>
<pre><code class="language-shell">$ python3 launch.py onboard -o org_name -f input.txt
<pre><code class="language-shell">python3 launch.py onboard -o org_name -f input.txt
</code></pre>
<h3 id="scan-on-all-assets-belonging-to-an-organisation"><a class="header" href="#scan-on-all-assets-belonging-to-an-organisation">Scan on all assets belonging to an organisation</a></h3>
<hr />
<p>Now that you have onboarded, you just need to run scheduled scans for an org, you can just use the scan mode</p>
<pre><code class="language-shell">$ python3 launch.py scan -o org_name
<pre><code class="language-shell">python3 launch.py scan -o org_name
</code></pre>
<h3 id="scan-on-all-assets-belonging-to-an-organisation-and-app"><a class="header" href="#scan-on-all-assets-belonging-to-an-organisation-and-app">Scan on all assets belonging to an organisation and app</a></h3>
<hr />
<pre><code class="language-shell">$ python3 launch.py scan -o org_name -a app_name
<pre><code class="language-shell">python3 launch.py scan -o org_name -a app_name
</code></pre>

</main>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion searchindex.json

Large diffs are not rendered by default.

0 comments on commit 51a594b

Please sign in to comment.