Update Documentation Page Sat Sep 9 16:17:29 +07 2023

docs/faq/index.html

@@ -1529,6 +1529,10 @@ <h2 id="general-questions">General Questions<a class="headerlink" href="#general
 <summary>I consistently encounter the error message <code>bash: /root/osmedeus-base/token/osm-default.rc: No such file or directory</code></summary>
 <p>please remove the line <code>$HOME/osmedeus-base/token/osm-default.rc</code> in your <code>~/.bashrc</code> or <code>~/.zshrc</code> file as the token config now has been move to <code>$HOME/osmedeus-base/token/osm-var.yaml</code> since <strong>v4.6.0</strong></p>
 </details>
+<details class="info" open="open">
+<summary>When I run with the <code>--debug</code> flag, I've noticed that certain commands are returning errors with exit statuses such as 128, 255, or -1. Is this to be expected?</summary>
+<p>Yes, it's normal for certain commands to exhibit expected exit statuses, as they may succeed under specific conditions. However, if you're confident that the raw bash command should succeed but is failing, please try copying the raw bash command and investigate why it's encountering issues.</p>
+</details>
 
 
 

docs/installation/running-your-first-scan/index.html

@@ -591,10 +591,76 @@
 
 
 
+        <label class="md-nav__link md-nav__link--active" for="__toc">
+          How do you determine which workflow to run?
+          <span class="md-nav__icon md-icon"></span>
+        </label>
+
       <a href="./" class="md-nav__link md-nav__link--active">
         How do you determine which workflow to run?
       </a>
 
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+        <li class="md-nav__item">
+  <a href="#please-review-the-input-example-and-select-the-workflow-that-best-suits-it-in-order-to-achieve-optimal-scanning-results" class="md-nav__link">
+     Please review the input example and select the workflow that best suits it in order to achieve optimal scanning results
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#a-domain-or-a-list-of-subdomains" class="md-nav__link">
+     a domain or a list of subdomains
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#if-you-workflow-is-a-url-or-a-list-of-urls" class="md-nav__link">
+      If you workflow is a URL or a list of URLs
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#cidr-or-a-list-of-cidrs" class="md-nav__link">
+     CIDR or a list of CIDRs
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#a-url-a-githubgitlab-repository-or-a-directory-containing-source-files" class="md-nav__link">
+     a URL, a GitHub/GitLab repository, or a directory containing source files
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#view-of-all-toggleable-and-skippable-parameters-in-the-workflow" class="md-nav__link">
+     View of all toggleable and skippable parameters in the workflow.
+  </a>
+
+</li>
+
+    </ul>
+
+</nav>
+
     </li>
 
 
@@ -1259,7 +1325,7 @@ <h1 id="running-your-first-scan"><img alt="🔍" class="twemoji" src="https://cd
 <p class="admonition-title">To avoid encountering errors, it is important to ensure that the scan is executed using the correct input format.</p>
 </div>
 <hr />
-<h1 id="please-review-the-input-example-and-select-the-workflow-that-best-suits-it-in-order-to-achieve-optimal-scanning-results"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M234.7 42.7 197 56.8c-3 1.1-5 4-5 7.2s2 6.1 5 7.2l37.7 14.1 14.1 37.7c1.1 3 4 5 7.2 5s6.1-2 7.2-5l14.1-37.7L315 71.2c3-1.1 5-4 5-7.2s-2-6.1-5-7.2l-37.7-14.1L263.2 5c-1.1-3-4-5-7.2-5s-6.1 2-7.2 5l-14.1 37.7zM46.1 395.4c-18.7 18.7-18.7 49.1 0 67.9l34.6 34.6c18.7 18.7 49.1 18.7 67.9 0l381.3-381.4c18.7-18.7 18.7-49.1 0-67.9l-34.6-34.5c-18.7-18.7-49.1-18.7-67.9 0L46.1 395.4zM484.6 82.6l-105 105-23.3-23.3 105-105 23.3 23.3zM7.5 117.2C3 118.9 0 123.2 0 128s3 9.1 7.5 10.8L64 160l21.2 56.5c1.7 4.5 6 7.5 10.8 7.5s9.1-3 10.8-7.5L128 160l56.5-21.2c4.5-1.7 7.5-6 7.5-10.8s-3-9.1-7.5-10.8L128 96l-21.2-56.5c-1.7-4.5-6-7.5-10.8-7.5s-9.1 3-10.8 7.5L64 96 7.5 117.2zm352 256c-4.5 1.7-7.5 6-7.5 10.8s3 9.1 7.5 10.8L416 416l21.2 56.5c1.7 4.5 6 7.5 10.8 7.5s9.1-3 10.8-7.5L480 416l56.5-21.2c4.5-1.7 7.5-6 7.5-10.8s-3-9.1-7.5-10.8L480 352l-21.2-56.5c-1.7-4.5-6-7.5-10.8-7.5s-9.1 3-10.8 7.5L416 352l-56.5 21.2z"/></svg></span> Please review the input example and select the workflow that best suits it in order to achieve optimal scanning results<a class="headerlink" href="#please-review-the-input-example-and-select-the-workflow-that-best-suits-it-in-order-to-achieve-optimal-scanning-results" title="Permanent link">&para;</a></h1>
+<h2 id="please-review-the-input-example-and-select-the-workflow-that-best-suits-it-in-order-to-achieve-optimal-scanning-results"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M234.7 42.7 197 56.8c-3 1.1-5 4-5 7.2s2 6.1 5 7.2l37.7 14.1 14.1 37.7c1.1 3 4 5 7.2 5s6.1-2 7.2-5l14.1-37.7L315 71.2c3-1.1 5-4 5-7.2s-2-6.1-5-7.2l-37.7-14.1L263.2 5c-1.1-3-4-5-7.2-5s-6.1 2-7.2 5l-14.1 37.7zM46.1 395.4c-18.7 18.7-18.7 49.1 0 67.9l34.6 34.6c18.7 18.7 49.1 18.7 67.9 0l381.3-381.4c18.7-18.7 18.7-49.1 0-67.9l-34.6-34.5c-18.7-18.7-49.1-18.7-67.9 0L46.1 395.4zM484.6 82.6l-105 105-23.3-23.3 105-105 23.3 23.3zM7.5 117.2C3 118.9 0 123.2 0 128s3 9.1 7.5 10.8L64 160l21.2 56.5c1.7 4.5 6 7.5 10.8 7.5s9.1-3 10.8-7.5L128 160l56.5-21.2c4.5-1.7 7.5-6 7.5-10.8s-3-9.1-7.5-10.8L128 96l-21.2-56.5c-1.7-4.5-6-7.5-10.8-7.5s-9.1 3-10.8 7.5L64 96 7.5 117.2zm352 256c-4.5 1.7-7.5 6-7.5 10.8s3 9.1 7.5 10.8L416 416l21.2 56.5c1.7 4.5 6 7.5 10.8 7.5s9.1-3 10.8-7.5L480 416l56.5-21.2c4.5-1.7 7.5-6 7.5-10.8s-3-9.1-7.5-10.8L480 352l-21.2-56.5c-1.7-4.5-6-7.5-10.8-7.5s-9.1 3-10.8 7.5L416 352l-56.5 21.2z"/></svg></span> Please review the input example and select the workflow that best suits it in order to achieve optimal scanning results<a class="headerlink" href="#please-review-the-input-example-and-select-the-workflow-that-best-suits-it-in-order-to-achieve-optimal-scanning-results" title="Permanent link">&para;</a></h2>
 <h2 id="a-domain-or-a-list-of-subdomains"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 1c6.075 0 11 4.925 11 11s-4.925 11-11 11S1 18.075 1 12 5.925 1 12 1Zm3.241 10.5v-.001c-.1-2.708-.992-4.904-1.89-6.452a13.919 13.919 0 0 0-1.304-1.88L12 3.11l-.047.059c-.354.425-.828 1.06-1.304 1.88-.898 1.547-1.79 3.743-1.89 6.451Zm-12.728 0h4.745c.1-3.037 1.1-5.49 2.093-7.204.39-.672.78-1.233 1.119-1.673C6.11 3.329 2.746 7 2.513 11.5Zm18.974 0C21.254 7 17.89 3.329 13.53 2.623c.339.44.729 1.001 1.119 1.673.993 1.714 1.993 4.167 2.093 7.204ZM8.787 13c.182 2.478 1.02 4.5 1.862 5.953.382.661.818 1.29 1.304 1.88l.047.057.047-.059c.354-.425.828-1.06 1.304-1.88.842-1.451 1.679-3.471 1.862-5.951Zm-1.504 0H2.552a9.505 9.505 0 0 0 7.918 8.377 15.773 15.773 0 0 1-1.119-1.673C8.413 18.085 7.47 15.807 7.283 13Zm9.434 0c-.186 2.807-1.13 5.085-2.068 6.704-.39.672-.78 1.233-1.118 1.673A9.506 9.506 0 0 0 21.447 13Z"/></svg></span> a domain or a list of subdomains<a class="headerlink" href="#a-domain-or-a-list-of-subdomains" title="Permanent link">&para;</a></h2>
 <p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M0 80v48c0 17.7 14.3 32 32 32h64V80c0-26.5-21.5-48-48-48S0 53.5 0 80zm112-48c10 13.4 16 30 16 48v304c0 35.3 28.7 64 64 64s64-28.7 64-64v-5.3c0-32.4 26.3-58.7 58.7-58.7H480V128c0-53-43-96-96-96H112zm352 448c61.9 0 112-50.1 112-112 0-8.8-7.2-16-16-16H314.7c-14.7 0-26.7 11.9-26.7 26.7v5.3c0 53-43 96-96 96h272z"/></svg></span> <strong>Example inputs</strong>: <code>example.com</code> , <code>target.co.uk</code></p>
 <div class="admonition example">
@@ -1323,8 +1389,7 @@ <h2 id="cidr-or-a-list-of-cidrs"><span class="twemoji"><svg xmlns="http://www.w3
 <h2 id="a-url-a-githubgitlab-repository-or-a-directory-containing-source-files"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M23.546 10.93 13.067.452a1.55 1.55 0 0 0-2.188 0L8.708 2.627l2.76 2.76a1.838 1.838 0 0 1 2.327 2.341l2.658 2.66a1.838 1.838 0 0 1 1.9 3.039 1.837 1.837 0 0 1-2.6 0 1.846 1.846 0 0 1-.404-1.996L12.86 8.955v6.525c.176.086.342.203.488.348a1.848 1.848 0 0 1 0 2.6 1.844 1.844 0 0 1-2.609 0 1.834 1.834 0 0 1 0-2.598c.182-.18.387-.316.605-.406V8.835a1.834 1.834 0 0 1-.996-2.41L7.636 3.7.45 10.881c-.6.605-.6 1.584 0 2.189l10.48 10.477a1.545 1.545 0 0 0 2.186 0l10.43-10.43a1.544 1.544 0 0 0 0-2.187"/></svg></span> a URL, a GitHub/GitLab repository, or a directory containing source files<a class="headerlink" href="#a-url-a-githubgitlab-repository-or-a-directory-containing-source-files" title="Permanent link">&para;</a></h2>
 <p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M0 80v48c0 17.7 14.3 32 32 32h64V80c0-26.5-21.5-48-48-48S0 53.5 0 80zm112-48c10 13.4 16 30 16 48v304c0 35.3 28.7 64 64 64s64-28.7 64-64v-5.3c0-32.4 26.3-58.7 58.7-58.7H480V128c0-53-43-96-96-96H112zm352 448c61.9 0 112-50.1 112-112 0-8.8-7.2-16-16-16H314.7c-14.7 0-26.7 11.9-26.7 26.7v5.3c0 53-43 96-96 96h272z"/></svg></span> <strong>Example inputs</strong>: <code>https://github.com/juice-shop/juice-shop</code> (only apply for GitHub or GitLab link), <code>/tmp/source-code-folder</code></p>
 <p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M41.4 86.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l192 192c12.5 12.5 12.5 32.8 0 45.3l-192 192c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 41.4 86.6zM288 416h288c17.7 0 32 14.3 32 32s-14.3 32-32 32H288c-17.7 0-32-14.3-32-32s14.3-32 32-32z"/></svg></span> <strong>Example commands</strong></p>
-<div class="highlight"><pre><span></span><code><span class="c1"># Please be aware that this functionality only operates with repository URLs such as those from GitHub or GitLab.</span>
-osmedeus<span class="w"> </span>scan<span class="w"> </span>-m<span class="w"> </span>repo-scan<span class="w"> </span>-t<span class="w"> </span>https://github.com/juice-shop/juice-shop
+<div class="highlight"><pre><span></span><code>osmedeus<span class="w"> </span>scan<span class="w"> </span>-m<span class="w"> </span>repo-scan<span class="w"> </span>-t<span class="w"> </span>https://github.com/juice-shop/juice-shop
 
 osmedeus<span class="w"> </span>scan<span class="w"> </span>-m<span class="w"> </span>repo-scan<span class="w"> </span>-t<span class="w"> </span>/tmp/source-code-folder
 

src/faq.md

@@ -189,3 +189,6 @@
 
 ???+ question "I consistently encounter the error message `bash: /root/osmedeus-base/token/osm-default.rc: No such file or directory`"
     please remove the line `$HOME/osmedeus-base/token/osm-default.rc` in your `~/.bashrc` or `~/.zshrc` file as the token config now has been move to `$HOME/osmedeus-base/token/osm-var.yaml` since **v4.6.0**
+
+???+ info "When I run with the `--debug` flag, I've noticed that certain commands are returning errors with exit statuses such as 128, 255, or -1. Is this to be expected?"
+    Yes, it's normal for certain commands to exhibit expected exit statuses, as they may succeed under specific conditions. However, if you're confident that the raw bash command should succeed but is failing, please try copying the raw bash command and investigate why it's encountering issues.

src/installation/running-your-first-scan.md

@@ -12,7 +12,7 @@
 
 ***
 
-# :fontawesome-solid-wand-magic-sparkles: Please review the input example and select the workflow that best suits it in order to achieve optimal scanning results
+## :fontawesome-solid-wand-magic-sparkles: Please review the input example and select the workflow that best suits it in order to achieve optimal scanning results
 
 ## :octicons-globe-24: a domain or a list of subdomains
 
@@ -104,7 +104,6 @@ osmedeus scan -f cidr-probing -t 3.4.5.6/24
 :fontawesome-solid-terminal: __Example commands__
 
 ```bash
-# Please be aware that this functionality only operates with repository URLs such as those from GitHub or GitLab.
 osmedeus scan -m repo-scan -t https://github.com/juice-shop/juice-shop
 
 osmedeus scan -m repo-scan -t /tmp/source-code-folder