documentation update

1modm · Dec 19, 2023 · 7bf9f20 · 7bf9f20
1 parent 516aab1
commit 7bf9f20
Show file tree

Hide file tree

Showing 18 changed files with 20 additions and 225 deletions.
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ PeTeReport (**Pe**n**Te**st **Report**) is written in Django and Python 3 with t
 - [x] PDF Output format
 - [x] Jupyter Notebook Output format
 - [x] Markdown Output format
-- [x] CVSS 3.1 Score
+- [x] CVSS 4 Score
 - [x] Docker installation
 - [x] DefectDojo integration
 - [x] User management
@@ -52,10 +52,7 @@ PeTeReport (**Pe**n**Te**st **Report**) is written in Django and Python 3 with t
 
 ## Demo
 
-[Demo](http://1modm.pythonanywhere.com/) **admin/P3t3r3p0rt**
-
-<video src="https://raw.githubusercontent.com/1modm/petereport/main/images/demo.webm" controls></video>
-
+[Demo](https://petereport.mpsec.eu/) **admin/P3t3r3p0rt**
 
 
 ## Sample Reports

diff --git a/app/preport/templates/appendix/appendix_view.html b/app/preport/templates/appendix/appendix_view.html
@@ -26,7 +26,6 @@ <h4>{% translate "Appendix Details" %}</h4>
               <li class="breadcrumb-item"><a href="{% url 'product_view' DB_finding_query.report.product.pk %}">{{ DB_finding_query.report.product.name | bleach}}</a></li>
               <li class="breadcrumb-item"><a href="{% url 'report_view' DB_finding_query.report.pk %}">{{ DB_finding_query.report.title}}</a></li>
               <li class="breadcrumb-item"><a href="{% url 'finding_view' DB_finding_query.pk %}">{{ DB_finding_query.title | bleach}}</a></li>
-              <li class="breadcrumb-item"><a href="{% url 'report_view' DB_report_query.pk %}">{{ DB_report_query.title}}</a></li>
             </ol>
           </div>
         </div>

diff --git a/docs/404.html b/docs/404.html
@@ -284,20 +284,6 @@
 
 
 
-
-
-
-
-
-    <li class="md-nav__item">
-      <a href="/petereport/django/" class="md-nav__link">
-        Django
-      </a>
-    </li>
-
-
-
-
         </ul>
       </nav>
     </li>

diff --git a/docs/appendix/index.html b/docs/appendix/index.html
@@ -291,20 +291,6 @@
 
 
 
-
-
-
-
-
-    <li class="md-nav__item">
-      <a href="../django/" class="md-nav__link">
-        Django
-      </a>
-    </li>
-
-
-
-
         </ul>
       </nav>
     </li>

diff --git a/docs/attackflow/index.html b/docs/attackflow/index.html
@@ -291,20 +291,6 @@
 
 
 
-
-
-
-
-
-    <li class="md-nav__item">
-      <a href="../django/" class="md-nav__link">
-        Django
-      </a>
-    </li>
-
-
-
-
         </ul>
       </nav>
     </li>

diff --git a/docs/configuration/index.html b/docs/configuration/index.html
@@ -291,20 +291,6 @@
 
 
 
-
-
-
-
-
-    <li class="md-nav__item">
-      <a href="../django/" class="md-nav__link">
-        Django
-      </a>
-    </li>
-
-
-
-
         </ul>
       </nav>
     </li>
@@ -697,7 +683,7 @@ <h2 id="markdown-configuration">Markdown configuration</h2>
 <p>Report information and media host configuration:</p>
 <ul>
 <li><strong>BASE64</strong>: Stores images in Database</li>
-<li><strong>MEDIA</strong>: Stores the images in the server (it is recommended to restrict the access to the server and encrypt the data to mitigate the leak or disclosure of the evidences). The path is not protected, must be set 'debug': True. This is highly insecure and not encouraged for production use. Should be configured the web server (apache, nginx, etc) to serve the media content using a protected link.</li>
+<li><strong>MEDIA</strong>: Stores the images in the server (it is recommended to restrict the access to the server and encrypt the data to mitigate the leak or disclosure of the evidences). The path is not protected. This is highly insecure and not encouraged for production use. Should be configured the web server (apache, nginx, etc) to serve the media content using a protected link.</li>
 </ul>
 <pre><code>PETEREPORT_MARKDOWN = {
     'author': 'Pentest company',

diff --git a/docs/default_creds/index.html b/docs/default_creds/index.html
@@ -286,20 +286,6 @@
 
 
 
-
-
-
-
-
-    <li class="md-nav__item">
-      <a href="../django/" class="md-nav__link">
-        Django
-      </a>
-    </li>
-
-
-
-
         </ul>
       </nav>
     </li>
@@ -558,7 +544,7 @@ <h1>Default Credentials</h1>
     <nav class="md-footer__inner md-grid" aria-label="Footer" >
 
 
-        <a href="../django/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Django" rel="prev">
+        <a href="../docker/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Docker" rel="prev">
           <div class="md-footer__button md-icon">
             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
           </div>
@@ -567,7 +553,7 @@ <h1>Default Credentials</h1>
               <span class="md-footer__direction">
                 Previous
               </span>
-              Django
+              Docker
             </div>
           </div>
         </a>

diff --git a/docs/docker/index.html b/docs/docker/index.html
@@ -341,20 +341,6 @@
 
 
 
-
-
-
-
-
-    <li class="md-nav__item">
-      <a href="../django/" class="md-nav__link">
-        Django
-      </a>
-    </li>
-
-
-
-
         </ul>
       </nav>
     </li>
@@ -603,6 +589,7 @@
 
 <h1 id="docker">Docker</h1>
 <h2 id="environment">Environment</h2>
+<p>Follow oficial installation guidelines: <a href="https://docs.docker.com/engine/">Docker Engine overview</a>. Example in Ubuntu:</p>
 <pre><code class="language-bash">sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
 </code></pre>
 <h2 id="deployment">Deployment</h2>
@@ -666,13 +653,13 @@ <h2 id="deployment">Deployment</h2>
 
 
 
-        <a href="../django/" class="md-footer__link md-footer__link--next" aria-label="Next: Django" rel="next">
+        <a href="../default_creds/" class="md-footer__link md-footer__link--next" aria-label="Next: Default Credentials" rel="next">
           <div class="md-footer__title">
             <div class="md-ellipsis">
               <span class="md-footer__direction">
                 Next
               </span>
-              Django
+              Default Credentials
             </div>
           </div>
           <div class="md-footer__button md-icon">

diff --git a/docs/findings/index.html b/docs/findings/index.html
@@ -291,20 +291,6 @@
 
 
 
-
-
-
-
-
-    <li class="md-nav__item">
-      <a href="../django/" class="md-nav__link">
-        Django
-      </a>
-    </li>
-
-
-
-
         </ul>
       </nav>
     </li>

diff --git a/docs/index.html b/docs/index.html
@@ -348,20 +348,6 @@
 
 
 
-
-
-
-
-
-    <li class="md-nav__item">
-      <a href="django/" class="md-nav__link">
-        Django
-      </a>
-    </li>
-
-
-
-
         </ul>
       </nav>
     </li>
@@ -629,7 +615,6 @@ <h1 align="center">
 
 <h2 id="architecture">Architecture</h2>
 <p><img alt="Architecture" src="https://github.com/1modm/petereport/raw/main/images/architecture.png" title="Architecture" /></p>
-<p><img alt="Demo" src="https://github.com/1modm/petereport/raw/main/images/demo.webm" title="Demo" /></p>
 <h2 id="features">Features</h2>
 <ul>
 <li>Customizable reports output</li>
@@ -642,7 +627,7 @@ <h2 id="features">Features</h2>
 <li>PDF Output format</li>
 <li>Jupyter Notebook Output format</li>
 <li>Markdown Output format</li>
-<li>CVSS 3.1 Score</li>
+<li>CVSS 4 Score</li>
 <li>Docker installation</li>
 <li>DefectDojo integration</li>
 <li>User management</li>

diff --git a/docs/products/index.html b/docs/products/index.html
@@ -291,20 +291,6 @@
 
 
 
-
-
-
-
-
-    <li class="md-nav__item">
-      <a href="../django/" class="md-nav__link">
-        Django
-      </a>
-    </li>
-
-
-
-
         </ul>
       </nav>
     </li>

diff --git a/docs/reports/index.html b/docs/reports/index.html
@@ -291,20 +291,6 @@
 
 
 
-
-
-
-
-
-    <li class="md-nav__item">
-      <a href="../django/" class="md-nav__link">
-        Django
-      </a>
-    </li>
-
-
-
-
         </ul>
       </nav>
     </li>

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,57 +2,52 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://1modm.github.io/petereport/</loc>
-         <lastmod>2023-08-22</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://1modm.github.io/petereport/appendix/</loc>
-         <lastmod>2023-08-22</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://1modm.github.io/petereport/attackflow/</loc>
-         <lastmod>2023-08-22</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://1modm.github.io/petereport/configuration/</loc>
-         <lastmod>2023-08-22</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://1modm.github.io/petereport/default_creds/</loc>
-         <lastmod>2023-08-22</lastmod>
-         <changefreq>daily</changefreq>
-    </url>
-    <url>
-         <loc>https://1modm.github.io/petereport/django/</loc>
-         <lastmod>2023-08-22</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://1modm.github.io/petereport/docker/</loc>
-         <lastmod>2023-08-22</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://1modm.github.io/petereport/findings/</loc>
-         <lastmod>2023-08-22</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://1modm.github.io/petereport/products/</loc>
-         <lastmod>2023-08-22</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://1modm.github.io/petereport/reports/</loc>
-         <lastmod>2023-08-22</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://1modm.github.io/petereport/users/</loc>
-         <lastmod>2023-08-22</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/docs/users/index.html b/docs/users/index.html
@@ -291,20 +291,6 @@
 
 
 
-
-
-
-
-
-    <li class="md-nav__item">
-      <a href="../django/" class="md-nav__link">
-        Django
-      </a>
-    </li>
-
-
-
-
         </ul>
       </nav>
     </li>

diff --git a/images/dashboard.png b/images/dashboard.png
-Original file line number
+Diff line change
@@ Expand Up / @@ -284,20 +284,6 @@ @@
-        <li class="md-nav__item">
-          <a href="/petereport/django/" class="md-nav__link">
-            Django
-          </a>
-        </li>
             </ul>
           </nav>
         </li>
@@ Expand Down @@