Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
1modm committed Jan 15, 2022
1 parent 28b44ba commit 1d95bad
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 16 deletions.
1 change: 0 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,3 @@ Changelog
## Version 0.1

* [#64f78b2](https://github.com/1modm/petereport/commit/64f78b2edf504638ee619428dd4e2a54aeb9aaab) First commit

8 changes: 4 additions & 4 deletions docs/django/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ <h3 id="start-the-server">Start the server</h3>
<ol>
<li>Run the virtual environment: <code>pipenv shell</code></li>
<li>Go to Django PeTeReport App: <code>cd app/</code></li>
<li>Start the django server: <code>python manage.py runserver</code> or <code>python manage.py runserver 0.0.0.0:8000</code></li>
<li>Start the django server: <code>python manage.py runserver --insecure</code> or <code>python manage.py runserver 0.0.0.0:8000 --insecure</code></li>
<li>Go to <a href="http://127.0.0.1:8000/">http://127.0.0.1:8000/</a></li>
<li>Login with any of users created <strong>admin/P3t3r3p0rt</strong> (administrator) and <strong>viewer/v13w3r</strong> (viewer) or the user credentials configured in the configuration file</li>
<li>Try harder</li>
Expand All @@ -219,7 +219,7 @@ <h3 id="upgrade-petereport">Upgrade PeTeReport</h3>
<li>Run the virtual environment: <code>pipenv shell</code></li>
<li>Make the latest database changes: <code>python manage.py makemigrations</code></li>
<li>Make the latest database changes: <code>python manage.py migrate</code></li>
<li>Start the server: <code>python manage.py runserver</code></li>
<li>Start the server: <code>python manage.py runserver --insecure</code></li>
<li>Try harder again</li>
</ol>
<h3 id="clean-petereport">Clean PeTeReport</h3>
Expand All @@ -230,14 +230,14 @@ <h3 id="clean-petereport">Clean PeTeReport</h3>
<li>Run cleaner: <code>python clean.py</code></li>
<li>Make the latest database changes: <code>python manage.py makemigrations</code></li>
<li>Make the latest database changes: <code>python manage.py migrate</code></li>
<li>Start the server: <code>python manage.py runserver</code></li>
<li>Start the server: <code>python manage.py runserver --insecure</code></li>
<li>Try harder again</li>
</ol>
<h3 id="configuration">Configuration</h3>
<ol>
<li>Stop the server if it's running: <code>Ctrl + C</code></li>
<li>Customize reports and configuration in <code>app/config/petereport_config.py</code></li>
<li>Start the django server: <code>python manage.py runserver</code> or <code>python manage.py runserver 0.0.0.0:8000</code></li>
<li>Start the django server: <code>python manage.py runserver --insecure</code> or <code>python manage.py runserver 0.0.0.0:8000 --insecure</code></li>
</ol>

</div>
Expand Down
4 changes: 4 additions & 0 deletions docs/reports/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@
</li>
<li class="toctree-l2"><a class="reference internal" href="#report-details">Report Details</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#template-customization">Template Customization</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../findings/">Findings</a>
Expand Down Expand Up @@ -141,6 +143,8 @@ <h2 id="create-new-reports">Create new reports</h2>
<p><img alt="Create Report" src="https://github.com/1modm/petereport/raw/main/images/add_report.png" title="Create Report" /></p>
<h2 id="report-details">Report Details</h2>
<p><img alt="Report" src="https://github.com/1modm/petereport/raw/main/images/report_details.png" title="Report" /></p>
<h2 id="template-customization">Template Customization</h2>
<p>It can be edited the templates used for each export format, just go to the folder <code>/app/preport/templates/tpl</code> and modify the markdown, latex or html as needed.</p>

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

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,52 +2,52 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://1modm.github.io/petereport/</loc>
<lastmod>2021-09-16</lastmod>
<lastmod>2022-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://1modm.github.io/petereport/appendix/</loc>
<lastmod>2021-09-16</lastmod>
<lastmod>2022-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://1modm.github.io/petereport/attacktree/</loc>
<lastmod>2021-09-16</lastmod>
<lastmod>2022-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://1modm.github.io/petereport/default_creds/</loc>
<lastmod>2021-09-16</lastmod>
<lastmod>2022-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://1modm.github.io/petereport/django/</loc>
<lastmod>2021-09-16</lastmod>
<lastmod>2022-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://1modm.github.io/petereport/docker/</loc>
<lastmod>2021-09-16</lastmod>
<lastmod>2022-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://1modm.github.io/petereport/findings/</loc>
<lastmod>2021-09-16</lastmod>
<lastmod>2022-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://1modm.github.io/petereport/products/</loc>
<lastmod>2021-09-16</lastmod>
<lastmod>2022-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://1modm.github.io/petereport/reports/</loc>
<lastmod>2021-09-16</lastmod>
<lastmod>2022-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://1modm.github.io/petereport/users/</loc>
<lastmod>2021-09-16</lastmod>
<lastmod>2022-01-15</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified docs/sitemap.xml.gz
Binary file not shown.
4 changes: 4 additions & 0 deletions scripts/ubuntu_environment_install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ while read -r p ; do sudo apt-get install -y $p ; done < <(cat << "EOF"
texlive-full
pandoc
python3-pypandoc
cairosvg
python3-cairosvg
libcairo2
libcairo2-dev
EOF
)

Expand Down

0 comments on commit 1d95bad

Please sign in to comment.