Skip to content

Commit

Permalink
Update Documentation Page Tue Oct 17 20:21:59 +07 2023
Browse files Browse the repository at this point in the history
  • Loading branch information
j3ssie committed Oct 17, 2023
1 parent 6ad8cb9 commit 3fc3c71
Show file tree
Hide file tree
Showing 7 changed files with 64 additions and 40 deletions.
6 changes: 6 additions & 0 deletions docs/faq/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1371,6 +1371,12 @@ <h2 id="general-questions">General Questions<a class="headerlink" href="#general
<p>You can follow <strong><a href="/installation/running-your-first-scan/">this page</a></strong> to see what workflow is fit to your workflow.</p>
</details>
<details class="question" open="open">
<summary>Is there any new or exclusive workflow in premium package compare to the publiic version?</summary>
<p>Basically, the count of workflows is similar in both the premium and community versions. The main difference lies in the specific parts of each workflow.
For instance, there are many filters and additional techniques in the premium version to find more valuable assets and get rid of unnecessary ones.
Lastly, I personally perform manual verification on the premium version and it also receives more frequent updates.</p>
</details>
<details class="question" open="open">
<summary>How can I conduct a standard scan while excluding specific domains that are considered out of scope?</summary>
<p>Currently, I don't have any Out of scope handle but you can run the flow that discovery the subdomain first with these commands
<div class="highlight"><pre><span></span><code>osmedeus scan -f fast -t google.com
Expand Down
18 changes: 12 additions & 6 deletions docs/installation/using-docker/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1317,12 +1317,18 @@ <h2 id="running-the-scan">Running the scan<a class="headerlink" href="#running-t
docker<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>-it<span class="w"> </span>&lt;container-id&gt;<span class="w"> </span>/bin/bash
</code></pre></div>
<h2 id="run-the-web-ui">Run the Web UI<a class="headerlink" href="#run-the-web-ui" title="Permanent link">&para;</a></h2>
<p>Note that <code>osmedeus-scanner</code> is just the name, you can use anything you want</p>
<div class="highlight"><pre><span></span><code><span class="c1">## Start the web server</span>
docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span>--name<span class="w"> </span>osmedeus-scanner<span class="w"> </span>-v<span class="w"> </span>osmws:/root/.osmedeus/workspaces<span class="w"> </span>-p<span class="w"> </span><span class="m">8000</span>:8000<span class="w"> </span>j3ssie/osmedeus:latest<span class="w"> </span>server

<span class="c1">## grepping for password</span>
docker<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>-it<span class="w"> </span>osmedeus-scanner<span class="w"> </span>-v<span class="w"> </span>osmws:/root/.osmedeus/workspaces<span class="w"> </span>grep<span class="w"> </span>password<span class="w"> </span>/root/.osmedeus/config.yaml<span class="w"> </span><span class="p">|</span><span class="w"> </span>head<span class="w"> </span>-1
<p>Please be aware that the term `osmedeus-scanner`` is merely a placeholder, and you are free to choose any name you prefer. Additionally, if you wish to retain your data even after shutting down the Docker, simply attach a volume to it.</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Create a volumn with the command `docker volume create osmws`</span>
<span class="c1"># Add the this string to your command &#39;-v osmws:/root/workspaces-osmedeus&#39; </span>
<span class="c1"># if you want to retain your data</span>

<span class="c1">## Start the web server</span>
docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span>--name<span class="w"> </span>osmedeus-scanner<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-p<span class="w"> </span><span class="m">8000</span>:8000<span class="w"> </span>j3ssie/osmedeus:latest<span class="w"> </span>server

<span class="c1">## grepping for the password to logging in the webserver which is `https://localhost:8000/ui/`</span>
docker<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>-it<span class="w"> </span>osmedeus-scanner<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>grep<span class="w"> </span>password<span class="w"> </span>/root/.osmedeus/config.yaml<span class="w"> </span><span class="p">|</span><span class="w"> </span>head<span class="w"> </span>-1
</code></pre></div>


Expand Down
2 changes: 1 addition & 1 deletion docs/search/search_index.json

Large diffs are not rendered by default.

58 changes: 29 additions & 29 deletions docs/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,147 +2,147 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.osmedeus.org/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/architecture/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/donation/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/faq/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/installation/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/premium/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/reference/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/workflow/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/installation/install-note/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/installation/notification/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/installation/practical-usage/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/installation/running-your-first-scan/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/installation/token/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/installation/usage/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/installation/using-docker/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/installation/web-ui/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/premium/cloud-setup/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/premium/git-setup/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/premium/install-premium-package/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/workflow/customize-your-own-workflow/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/workflow/default-workflow/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/workflow/git-scripts/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/workflow/io-utils/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/workflow/markdown-report/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/workflow/noti-scripts/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/workflow/other-fields/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/workflow/parameters/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/workflow/scripts/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.osmedeus.org/workflow/use-your-own-wordlists/</loc>
<lastmod>2023-09-16</lastmod>
<lastmod>2023-10-17</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified docs/sitemap.xml.gz
Binary file not shown.
5 changes: 5 additions & 0 deletions src/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@
???+ info "How do I know which workflow to run?"
You can follow **[this page](/installation/running-your-first-scan/)** to see what workflow is fit to your workflow.

???+ question "Is there any new or exclusive workflow in premium package compare to the publiic version?"
Basically, the count of workflows is similar in both the premium and community versions. The main difference lies in the specific parts of each workflow.
For instance, there are many filters and additional techniques in the premium version to find more valuable assets and get rid of unnecessary ones.
Lastly, I personally perform manual verification on the premium version and it also receives more frequent updates.

???+ question "How can I conduct a standard scan while excluding specific domains that are considered out of scope?"
Currently, I don't have any Out of scope handle but you can run the flow that discovery the subdomain first with these commands
```
Expand Down
15 changes: 11 additions & 4 deletions src/installation/using-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,19 @@ docker exec -it <container-id> /bin/bash

## Run the Web UI

Note that `osmedeus-scanner` is just the name, you can use anything you want
Please be aware that the term `osmedeus-scanner`` is merely a placeholder, and you are free to choose any name you prefer. Additionally, if you wish to retain your data even after shutting down the Docker, simply attach a volume to it.


```shell
# Create a volumn with the command `docker volume create osmws`
# Add the this string to your command '-v osmws:/root/workspaces-osmedeus'
# if you want to retain your data

## Start the web server
docker run -d --name osmedeus-scanner -v osmws:/root/.osmedeus/workspaces -p 8000:8000 j3ssie/osmedeus:latest server
docker run -d --name osmedeus-scanner \
-p 8000:8000 j3ssie/osmedeus:latest server

## grepping for password
docker exec -it osmedeus-scanner -v osmws:/root/.osmedeus/workspaces grep password /root/.osmedeus/config.yaml | head -1
## grepping for the password to logging in the webserver which is `https://localhost:8000/ui/`
docker exec -it osmedeus-scanner \
grep password /root/.osmedeus/config.yaml | head -1
```

0 comments on commit 3fc3c71

Please sign in to comment.