Update Documentation Page Thu Sep 7 21:39:58 +07 2023

osmedeus · Sep 7, 2023 · c8ca900 · c8ca900
1 parent e4a1655
commit c8ca900
Show file tree

Hide file tree

Showing 9 changed files with 181 additions and 224 deletions.
diff --git a/docs/installation/notification/index.html b/docs/installation/notification/index.html
diff --git a/docs/installation/token/index.html b/docs/installation/token/index.html
@@ -524,8 +524,8 @@
 </li>
 
  <li class="md-nav__item">
- <a href="#some-other-tokens" class="md-nav__link">
- Some other tokens
+ <a href="#any-other-tokens" class="md-nav__link">
+ Any other tokens
  </a>
 
 </li>
@@ -1290,17 +1290,22 @@ <h1>Setup Token & API Key</h1>
 <p><label class="task-list-control"><input type="checkbox" disabled checked/><span class="task-list-indicator"></span></label> Amass config files <code>~/osmedeus-base/data/amass-config/datasources.yaml</code> at <strong><code>~/osmedeus-base/data/configs/</code></strong> which is mainly responsible for the subdomain enumeration.</p>
 </li>
 <li class="task-list-item">
-<p><label class="task-list-control"><input type="checkbox" disabled checked/><span class="task-list-indicator"></span></label> Main config file <strong><code>~/osmedeus-base/token/osm-default.rc</code></strong> </p>
+<p><label class="task-list-control"><input type="checkbox" disabled checked/><span class="task-list-indicator"></span></label> Main tokens file <strong><code>~/osmedeus-base/token/osm-var.yaml</code></strong> </p>
 </li>
 </ul>
 <h2 id="amass-config">Amass config<a class="headerlink" href="#amass-config" title="Permanent link">&para;</a></h2>
 <p>All your tokens, such as Shodan, Censys, SecurityTrails, and others are store in <code>~/osmedeus-base/data/amass-config/datasources.yaml</code>. 
 You can begin making modifications to the configuration there to utilize third-party services while using Osmedeus.</p>
-<h2 id="some-other-tokens">Some other tokens<a class="headerlink" href="#some-other-tokens" title="Permanent link">&para;</a></h2>
-<p>Other API Keys that require to change to get more information is <code>GITHUB_TOKEN</code> at <code>~/osmedeus-base/token/osm-default.rc</code>. This token used by <code>github-subdomains</code> tools to get more subdomains.</p>
-<div class="highlight"><pre><span></span><code><span class="c1"># Set github token for run github scan</span>
-<span class="nb">export</span><span class="w"> </span><span class="nv">GITHUB_TOKEN</span><span class="o">=</span>xxx,xxxx
+<h2 id="any-other-tokens">Any other tokens<a class="headerlink" href="#any-other-tokens" title="Permanent link">&para;</a></h2>
+<p>Any other config that require to change to get more is store <code>~/osmedeus-base/token/osm-var.yaml</code>.</p>
+<p>The primary section for storing your API keys can be found in the <code>token:</code> section, as shown below. When you run the Osmedeus scan, it will automatically load these keys into your operating system environment</p>
+<div class="highlight"><pre><span></span><code><span class="nt">tokens</span><span class="p">:</span>
+<span class="w"> </span><span class="nt">GITHUB_TOKEN</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GITHUB_TOKEN</span>
+<span class="w"> </span><span class="nt">GITLAB_API_TOKEN</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GITLAB_API_TOKEN</span>
+<span class="w"> </span><span class="nt">SLACK_API_TOKEN</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SLACK_API_TOKEN</span>
+<span class="w"> </span><span class="nt">TELEGRAM_API_TOKEN</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TELEGRAM_API_TOKEN</span>
 </code></pre></div>
+<p>For example <code>GITHUB_TOKEN</code> used by github-subdomains tools to get more subdomains.</p>
 
 
 

diff --git a/docs/premium/git-setup/index.html b/docs/premium/git-setup/index.html
@@ -1174,22 +1174,15 @@
  <ul class="md-nav__list">
 
  <li class="md-nav__item">
- <a href="#1-modify-the-content-of-storages-config-file-at-osmedeus-basetokenstorages-aliasrc" class="md-nav__link">
- 1. Modify the content of Storages Config file at ~/osmedeus-base/token/storages-alias.rc
+ <a href="#1-modify-the-content-of-storages-config-file-at-osmedeus-basetokenosm-varyaml" class="md-nav__link">
+ 1. Modify the content of Storages Config file at ~/osmedeus-base/token/osm-var.yaml
  </a>
 
 </li>
 
  <li class="md-nav__item">
- <a href="#2-load-the-storages-variables-to-osmedeus-config" class="md-nav__link">
- 2. Load the storages variables to Osmedeus config
- </a>
-
-</li>
-
- <li class="md-nav__item">
- <a href="#3-reload-the-config-to-clone-repo" class="md-nav__link">
- 3. Reload the config to clone repo
+ <a href="#2-reload-the-config-to-clone-repo" class="md-nav__link">
+ 2. Reload the config to clone repo
  </a>
 
 </li>
@@ -1312,46 +1305,38 @@ <h1 id="git-setup-for-premium-package"><img alt="☁" class="twemoji" src="https
 </div>
 <h2 id="setup-storages">Setup Storages<a class="headerlink" href="#setup-storages" title="Permanent link">&para;</a></h2>
 <p>Check out <strong>the Private Playlist</strong> on the <strong>#backer</strong> channel in Discord to see a Video Instruction.</p>
-<h3 id="1-modify-the-content-of-storages-config-file-at-osmedeus-basetokenstorages-aliasrc">1. Modify the content of Storages Config file at <code>~/osmedeus-base/token/storages-alias.rc</code><a class="headerlink" href="#1-modify-the-content-of-storages-config-file-at-osmedeus-basetokenstorages-aliasrc" title="Permanent link">&para;</a></h3>
-<p>Please change your username and repository name from <code>your_gitlab_username</code> is your gitlab username and <code>dosm-*</code> are your Gitlab repo names.</p>
-<div class="highlight"><pre><span></span><code><span class="nb">export</span><span class="w"> </span><span class="nv">ENABLE_GIT_STORAGES</span><span class="o">=</span>TRUE
-<span class="nb">export</span><span class="w"> </span><span class="nv">GIT_SSH_COMMAND</span><span class="o">=</span><span class="s1">&#39;ssh -o StrictHostKeyChecking=no -i ~/.osmedeus/storages_key&#39;</span>
-
-<span class="c1"># for storages</span>
-<span class="nb">export</span><span class="w"> </span><span class="nv">SECRET_KEY</span><span class="o">=</span>~/.osmedeus/storages_key
-
-<span class="c1"># core one</span>
-<span class="nb">export</span><span class="w"> </span><span class="nv">SUMMARY_REPO</span><span class="o">=</span>[email protected]:your_gitlab_username/dosm-summary
-<span class="nb">export</span><span class="w"> </span><span class="nv">VULN_REPO</span><span class="o">=</span>[email protected]:your_gitlab_username/dosm-vuln
-<span class="nb">export</span><span class="w"> </span><span class="nv">PATHS_REPO</span><span class="o">=</span>[email protected]:your_gitlab_username/dosm-paths
-<span class="nb">export</span><span class="w"> </span><span class="nv">HTTP_REPO</span><span class="o">=</span>[email protected]:your_gitlab_username/dosm-http
-
-<span class="c1"># mics one</span>
-<span class="nb">export</span><span class="w"> </span><span class="nv">ASSETS_REPO</span><span class="o">=</span>[email protected]:your_gitlab_username/dosm-assets
-<span class="nb">export</span><span class="w"> </span><span class="nv">PORTS_REPO</span><span class="o">=</span>[email protected]:your_gitlab_username/dosm-ports
-<span class="nb">export</span><span class="w"> </span><span class="nv">MICS_REPO</span><span class="o">=</span>[email protected]:your_gitlab_username/dosm-cloud
-<span class="nb">export</span><span class="w"> </span><span class="nv">SUBDOMAIN_REPO</span><span class="o">=</span>[email protected]:your_gitlab_username/dosm-subdomain
-</code></pre></div>
-<h3 id="2-load-the-storages-variables-to-osmedeus-config">2. Load the storages variables to Osmedeus config<a class="headerlink" href="#2-load-the-storages-variables-to-osmedeus-config" title="Permanent link">&para;</a></h3>
+<h3 id="1-modify-the-content-of-storages-config-file-at-osmedeus-basetokenosm-varyaml">1. Modify the content of Storages Config file at <code>~/osmedeus-base/token/osm-var.yaml</code><a class="headerlink" href="#1-modify-the-content-of-storages-config-file-at-osmedeus-basetokenosm-varyaml" title="Permanent link">&para;</a></h3>
 <div class="admonition warning">
 <p class="admonition-title">Run these commands below if you not using git before</p>
 <div class="highlight"><pre><span></span><code>git<span class="w"> </span>config<span class="w"> </span>--global<span class="w"> </span>user.name<span class="w"> </span><span class="s2">&quot;your_gitlab_user&quot;</span>
 git<span class="w"> </span>config<span class="w"> </span>--global<span class="w"> </span>user.email<span class="w"> </span><span class="s2">&quot;[email protected]&quot;</span>
 </code></pre></div>
 </div>
-<div class="highlight"><pre><span></span><code><span class="nb">echo</span><span class="w"> </span><span class="s1">&#39;source $HOME/osmedeus-base/token/storages-alias.rc&#39;</span><span class="w"> </span>&gt;&gt;<span class="w"> </span>~/.bashrc<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="nb">source</span><span class="w"> </span>~/.bashrc
-
-<span class="c1"># reload config to osmedeus</span>
-osmedeus<span class="w"> </span>config<span class="w"> </span>reload
-</code></pre></div>
-<p>This will generate the public key at <code>/root/.osmedeus/storages_key.pub</code>. Please add this public key at to your gitlab profile.</p>
-<p>You can also check if the config was loaded or not </p>
-<div class="highlight"><pre><span></span><code>cat<span class="w"> </span>~/.osmedeus/config.yaml<span class="w"> </span><span class="p">|</span><span class="w"> </span>grep<span class="w"> </span><span class="s1">&#39;secret_key&#39;</span>
+<p>Please change your username and repository name from <code>your_gitlab_username</code> is your gitlab username and <code>dosm-*</code> are your Gitlab repo names.</p>
+<div class="highlight"><pre><span></span><code><span class="nt">storages</span><span class="p">:</span>
+<span class="w"> </span><span class="nt">secret_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SECRET_KEY</span>
+<span class="w"> </span><span class="nt">assets_repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ASSETS_REPO</span>
+<span class="w"> </span><span class="nt">assets_storage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.osmedeus/storages/assets</span>
+<span class="w"> </span><span class="nt">http_repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">HTTP_REPO</span>
+<span class="w"> </span><span class="nt">http_storage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.osmedeus/storages/http</span>
+<span class="w"> </span><span class="nt">mics_repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MICS_REPO</span>
+<span class="w"> </span><span class="nt">mics_storage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.osmedeus/storages/mics</span>
+<span class="w"> </span><span class="nt">paths_repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PATHS_REPO</span>
+<span class="w"> </span><span class="nt">paths_storage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.osmedeus/storages/paths</span>
+<span class="w"> </span><span class="nt">ports_repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PORTS_REPO</span>
+<span class="w"> </span><span class="nt">ports_storage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.osmedeus/storages/ports</span>
+<span class="w"> </span><span class="nt">subdomain_repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SUBDOMAIN_REPO</span>
+<span class="w"> </span><span class="nt">subdomain_storage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.osmedeus/storages/subdomain</span>
+<span class="w"> </span><span class="nt">summary_repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SUMMARY_REPO</span>
+<span class="w"> </span><span class="nt">summary_storage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.osmedeus/storages/summary</span>
+<span class="w"> </span><span class="nt">vuln_repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">VULN_REPO</span>
+<span class="w"> </span><span class="nt">vuln_storage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.osmedeus/storages/vuln</span>
 </code></pre></div>
-<h3 id="3-reload-the-config-to-clone-repo">3. Reload the config to clone repo<a class="headerlink" href="#3-reload-the-config-to-clone-repo" title="Permanent link">&para;</a></h3>
+<p>Change the <code>SECRET_KEY</code> to the path of your secret key that can do the push/pull to your git repo.</p>
+<h3 id="2-reload-the-config-to-clone-repo">2. Reload the config to clone repo<a class="headerlink" href="#2-reload-the-config-to-clone-repo" title="Permanent link">&para;</a></h3>
 <div class="highlight"><pre><span></span><code><span class="c1">#reload config to cloning the repo</span>
 
-osmedeus<span class="w"> </span>config<span class="w"> </span>reload<span class="w"> </span>--debug
+osmedeus<span class="w"> </span>config<span class="w"> </span><span class="nb">set</span><span class="w"> </span>--threads-hold<span class="o">=</span><span class="m">10</span>
 
 <span class="c1"># then check out your storages folder at `~/.osmedeus/storages/summary`</span>
 ls<span class="w"> </span>~/.osmedeus/storages/summary/<span class="w"> </span>

diff --git a/docs/search/search_index.json b/docs/search/search_index.json
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
@@ -2,147 +2,147 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
  <loc>https://docs.osmedeus.org/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/architecture/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/donation/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/faq/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/installation/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/premium/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/reference/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/workflow/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/installation/install-note/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/installation/notification/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/installation/practical-usage/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/installation/running-your-first-scan/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/installation/token/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/installation/usage/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/installation/using-docker/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/installation/web-ui/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/premium/cloud-setup/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/premium/git-setup/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/premium/install-premium-package/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/workflow/customize-your-own-workflow/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/workflow/default-workflow/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/workflow/git-scripts/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/workflow/io-utils/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/workflow/markdown-report/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/workflow/noti-scripts/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/workflow/other-fields/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/workflow/parameters/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/workflow/scripts/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
  <url>
  <loc>https://docs.osmedeus.org/workflow/use-your-own-wordlists/</loc>
- <lastmod>2023-08-27</lastmod>
+ <lastmod>2023-09-07</lastmod>
  <changefreq>daily</changefreq>
  </url>
 </urlset>
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz