Skip to content

Commit

Permalink
chg: Bump website
Browse files Browse the repository at this point in the history
  • Loading branch information
@Rafiot
Rafiot committed Aug 8, 2024
1 parent 4805bf5 commit d57a21d
Show file tree
Hide file tree
Showing 12 changed files with 85 additions and 64 deletions.
Binary file modified docs/docs/main/_images/polish_site_screenshot_phishing.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/main/_images/polish_site_screenshot_phishing_select.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/main/_images/polish_site_virus_total.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/main/_images/sample_github.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/main/_images/sample_github_legend.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions docs/docs/main/dev-docs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ <h2 id="_general_guidelines"><a class="anchor" href="#_general_guidelines"></a>G
<ul>
<li>
<p>After editing a file, you can run the <code>stop</code> and <code>start</code> scripts to restart the platform and see the changes.
It will restart everything, including the redis databases, and can take a bot of time. See below if you&#8217;re
It will restart everything, including the valkey databases, and can take a bot of time. See below if you&#8217;re
working on a specific part of the tool and want to stop/start a specific module.</p>
</li>
<li>
Expand All @@ -238,19 +238,19 @@ <h2 id="_scripts"><a class="anchor" href="#_scripts"></a>Scripts</h2>
<p><code>start</code>: Starts all the services</p>
</li>
<li>
<p><code>stop</code>: Triggers <code>shutdown</code>, stop redis databases.</p>
<p><code>stop</code>: Triggers <code>shutdown</code>, stop valkey databases.</p>
</li>
<li>
<p><code>shutdown</code>: Requests the services to stop by putting a <code>shutdown</code> key in redis, wait for all of them to stop.</p>
<p><code>shutdown</code>: Requests the services to stop by putting a <code>shutdown</code> key in valkey, wait for all of them to stop.</p>
</li>
<li>
<p><code>run_backend</code>: Starts/stops redis databases</p>
<p><code>run_backend</code>: Starts/stops valkey databases</p>
</li>
<li>
<p><code>async_capture</code>: Triggers a capture from the queue. Multiple instances of this process can be run in parallel</p>
</li>
<li>
<p><code>background_indexer</code>: Caches the captures in redis, creates the tree pickles, adds the urls, cookies,
<p><code>background_indexer</code>: Caches the captures in valkey, creates the tree pickles, adds the urls, cookies,
and body hashes in indexes for fast lookup</p>
</li>
<li>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/main/implementation-details.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -210,9 +210,9 @@ <h1 class="page">Implementation Details</h1>
<h2 id="_backend"><a class="anchor" href="#_backend"></a>Backend</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_redis"><a class="anchor" href="#_redis"></a>Redis</h3>
<h3 id="_valkey"><a class="anchor" href="#_valkey"></a>Valkey</h3>
<div class="paragraph">
<p><a href="https://redis.io/">Redis</a> is the database used to store the cached information visualized on the web interface.</p>
<p><a href="https://valkey.io/">Valkey</a> is the database used to store the cached information visualized on the web interface.</p>
</div>
</div>
<div class="sect2">
Expand Down
53 changes: 37 additions & 16 deletions docs/docs/main/install-lookyloo.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ <h1 class="page">Install Lookyloo</h1>
</td>
<td class="content">
<div class="paragraph">
<p>Requires Python 3.8 or higher (3.10 prefered), expects Ubuntu 22.04 or more recent.</p>
<p>Requires Python 3.8 or higher (3.12 prefered), expects Ubuntu 22.04 or more recent (24.04 prefered).</p>
</div>
</td>
</tr>
Expand All @@ -221,22 +221,29 @@ <h2 id="_install_lookyloo_dependencies"><a class="anchor" href="#_install_lookyl
<div class="sect2">
<h3 id="_install_poetry"><a class="anchor" href="#_install_poetry"></a>Install Poetry</h3>
<div class="paragraph">
<p><a href="https://python-poetry.org/">Poetry</a> is tool to handle dependency installation
<p><a href="https://python-poetry.org/">Poetry</a> handles dependency installation
as well as building and packaging of Python packages.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -sSL https://install.python-poetry.org | python3 -</code></pre>
</div>
</div>
<div class="paragraph">
<p>More details in the the <a href="https://github.com/python-poetry/poetry/#installation">installation guide</a>.</p>
<p>See the <a href="https://python-poetry.org/docs/#installation">installation guide</a> for more details.</p>
</div>
</div>
<div class="sect2">
<h3 id="_install_redis"><a class="anchor" href="#_install_redis"></a>Install Redis</h3>
<h3 id="_install_valkey"><a class="anchor" href="#_install_valkey"></a>Install Valkey</h3>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Lacus supports valkey or redis, but valkey is prefered now due to the change of license.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p><a href="https://redis.io/">Redis</a>: An open source (BSD licensed), in-memory data structure
<p><a href="https://valkey.io/">Valkey</a>: An open source (BSD licensed), in-memory data structure
store, used as a database, cache and message broker.</p>
</div>
<div class="admonitionblock note">
Expand All @@ -246,7 +253,7 @@ <h3 id="_install_redis"><a class="anchor" href="#_install_redis"></a>Install Red
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Redis should be installed from the source, and the repository must be in
Valkey should be installed from the source, and the repository must be in
the same directory as the one you will be cloning Lookyloo in to.
</td>
</tr>
Expand All @@ -259,13 +266,13 @@ <h3 id="_install_redis"><a class="anchor" href="#_install_redis"></a>Install Red
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Since Lookyloo 1.15, redis 7.0 is required.
Since Lookyloo 1.25, valkey 7.2 is required.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>In order to compile and test redis, you will need a few packages:</p>
<p>In order to compile and test valkey, you will need a few packages:</p>
</div>
<div class="listingblock">
<div class="content">
Expand All @@ -275,8 +282,8 @@ <h3 id="_install_redis"><a class="anchor" href="#_install_redis"></a>Install Red
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">git clone https://github.com/redis/redis.git
cd redis
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">git clone https://github.com/valkey-io/valkey
cd valkey
git checkout 7.2
make
# Optionally, you can run the tests:
Expand All @@ -298,7 +305,7 @@ <h3 id="_prerequisites"><a class="anchor" href="#_prerequisites"></a>Prerequisit
<p>Poetry is installed.</p>
</li>
<li>
<p>Redis is installed from the source. The repository must be in the same directory
<p>Valkey is installed from the source. The repository must be in the same directory
as the one you will be cloning Lookyloo in to.</p>
</li>
<li>
Expand All @@ -324,6 +331,20 @@ <h3 id="_procedure"><a class="anchor" href="#_procedure"></a>Procedure</h3>
</div>
</div>
</li>
</ol>
</div>
<div class="paragraph">
<p>The directory tree must look like that:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-none hljs">.
├── valkey =&gt; cloned valkey
└── lookyloo =&gt; cloned lookyloo</code></pre>
</div>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Change directory</p>
<div class="listingblock">
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/main/lookyloo-auth.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ <h2 id="_usage"><a class="anchor" href="#_usage"></a>Usage</h2>
<p><code>/hidden</code>: show the tree hidden on the index</p>
</li>
<li>
<p><code>/rebuild_cache</code>: rebuild only the redis cache. Can take a while, but not as much as <code>/rebuild_all</code></p>
<p><code>/rebuild_cache</code>: rebuild only the valkey cache. Can take a while, but not as much as <code>/rebuild_all</code></p>
</li>
<li>
<p><code>/rebuild_all</code>: rebuild all the tree (drop all the pickles of all the trees). <strong>warning</strong>: it can take a very, very long time.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/main/lookyloo-rest.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ <h1 class="page">What is a REST API?</h1>
<h2 id="_usage"><a class="anchor" href="#_usage"></a>Usage</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The documentation of the REST API is automatically generated and avaliable over
<p>The documentation of the REST API is automatically generated and available over
the lookyloo web interface. If you want to run queries against the public instance,
you can use <a href="https://lookyloo.circl.lu/doc/">this documentation</a>.</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/main/update-lookyloo.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ <h2 id="_update_poetry"><a class="anchor" href="#_update_poetry"></a>Update poet
</div>
</div>
<div class="sect2">
<h3 id="_update_redis"><a class="anchor" href="#_update_redis"></a>Update Redis</h3>
<h3 id="_update_valkey"><a class="anchor" href="#_update_valkey"></a>Update Valkey</h3>
<div class="paragraph">
<p>It requires to shutdown lookyloo completely.</p>
</div>
Expand All @@ -298,7 +298,7 @@ <h3 id="_update_redis"><a class="anchor" href="#_update_redis"></a>Update Redis<
</div>
</div>
<div class="paragraph">
<p>From the directory you cloned redis into:</p>
<p>From the directory you cloned valkey into:</p>
</div>
<div class="listingblock">
<div class="content">
Expand Down
74 changes: 37 additions & 37 deletions docs/sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,150 +2,150 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://www.lookyloo.eu/docs/main/additions.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/capture-cookies.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/code-conduct.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/concepts.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/contributing.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/contributor-git.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/contributor-guide-docs.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/contributor-guide.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/contributor-style-guide.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/dev-corner.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/dev-docs.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/dev-release.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/glossary.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/implementation-details.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/index.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/install-lookyloo-docker.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/install-lookyloo-production.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/install-lookyloo.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/installation.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/lookyloo-api.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/lookyloo-auth.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/lookyloo-configuration.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/lookyloo-explained.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/lookyloo-integration.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/lookyloo-interface.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/lookyloo-pylookyloo.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/lookyloo-rest.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/lookyloo-tutorial.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/lookyloo-web-ext.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/other-tools.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/phishing-use-case.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/prerequisites-for-windows.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/pylookyloo-commands.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/pylookyloo-overview.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/update-lookyloo.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/usage.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
<url>
<loc>https://www.lookyloo.eu/docs/main/use-cases.html</loc>
<lastmod>2024-05-21T11:42:44.063Z</lastmod>
<lastmod>2024-08-08T10:14:37.583Z</lastmod>
</url>
</urlset>

0 comments on commit d57a21d

Please sign in to comment.