curl -sSL https://install.python-poetry.org | python3 -
-diff --git a/docs/docs/main/_images/polish_site_screenshot_phishing.png b/docs/docs/main/_images/polish_site_screenshot_phishing.png index bdcab64..1bb0e88 100644 Binary files a/docs/docs/main/_images/polish_site_screenshot_phishing.png and b/docs/docs/main/_images/polish_site_screenshot_phishing.png differ diff --git a/docs/docs/main/_images/polish_site_screenshot_phishing_select.png b/docs/docs/main/_images/polish_site_screenshot_phishing_select.png index 85a6e4f..11459d1 100644 Binary files a/docs/docs/main/_images/polish_site_screenshot_phishing_select.png and b/docs/docs/main/_images/polish_site_screenshot_phishing_select.png differ diff --git a/docs/docs/main/_images/polish_site_virus_total.png b/docs/docs/main/_images/polish_site_virus_total.png index 1a126cf..c9dc80b 100644 Binary files a/docs/docs/main/_images/polish_site_virus_total.png and b/docs/docs/main/_images/polish_site_virus_total.png differ diff --git a/docs/docs/main/_images/sample_github.png b/docs/docs/main/_images/sample_github.png index 418f1f9..a50e0b7 100644 Binary files a/docs/docs/main/_images/sample_github.png and b/docs/docs/main/_images/sample_github.png differ diff --git a/docs/docs/main/_images/sample_github_legend.png b/docs/docs/main/_images/sample_github_legend.png index 106c142..80cc582 100644 Binary files a/docs/docs/main/_images/sample_github_legend.png and b/docs/docs/main/_images/sample_github_legend.png differ diff --git a/docs/docs/main/dev-docs.html b/docs/docs/main/dev-docs.html index 4c81b32..96ecdd7 100644 --- a/docs/docs/main/dev-docs.html +++ b/docs/docs/main/dev-docs.html @@ -216,7 +216,7 @@
After editing a file, you can run the stop
and start
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’re
+It will restart everything, including the valkey databases, and can take a bot of time. See below if you’re
working on a specific part of the tool and want to stop/start a specific module.
start
: Starts all the services
stop
: Triggers shutdown
, stop redis databases.
stop
: Triggers shutdown
, stop valkey databases.
shutdown
: Requests the services to stop by putting a shutdown
key in redis, wait for all of them to stop.
shutdown
: Requests the services to stop by putting a shutdown
key in valkey, wait for all of them to stop.
run_backend
: Starts/stops redis databases
run_backend
: Starts/stops valkey databases
async_capture
: Triggers a capture from the queue. Multiple instances of this process can be run in parallel
background_indexer
: Caches the captures in redis, creates the tree pickles, adds the urls, cookies,
+
background_indexer
: Caches the captures in valkey, creates the tree pickles, adds the urls, cookies,
and body hashes in indexes for fast lookup
Requires Python 3.8 or higher (3.10 prefered), expects Ubuntu 22.04 or more recent.
+Requires Python 3.8 or higher (3.12 prefered), expects Ubuntu 22.04 or more recent (24.04 prefered).
Poetry is tool to handle dependency installation +
Poetry handles dependency installation as well as building and packaging of Python packages.
curl -sSL https://install.python-poetry.org | python3 -
-More details in the the installation guide.
+See the installation guide for more details.
+ + | ++Lacus supports valkey or redis, but valkey is prefered now due to the change of license. + | +
Redis: An open source (BSD licensed), in-memory data structure +
Valkey: An open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker.
In order to compile and test redis, you will need a few packages:
+In order to compile and test valkey, you will need a few packages:
git clone https://github.com/redis/redis.git
-cd redis
+git clone https://github.com/valkey-io/valkey
+cd valkey
git checkout 7.2
make
# Optionally, you can run the tests:
@@ -298,7 +305,7 @@ Prerequisit
Poetry is installed.
-
-
Redis is installed from the source. The repository must be in the same directory
+
Valkey is installed from the source. The repository must be in the same directory
as the one you will be cloning Lookyloo in to.
-
@@ -324,6 +331,20 @@
Procedure
The directory tree must look like that:
+.
+├── valkey => cloned valkey
+└── lookyloo => cloned lookyloo
+Change directory
/hidden
: show the tree hidden on the index
/rebuild_cache
: rebuild only the redis cache. Can take a while, but not as much as /rebuild_all
/rebuild_cache
: rebuild only the valkey cache. Can take a while, but not as much as /rebuild_all
/rebuild_all
: rebuild all the tree (drop all the pickles of all the trees). warning: it can take a very, very long time.
The documentation of the REST API is automatically generated and avaliable over +
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 this documentation.
From the directory you cloned redis into:
+From the directory you cloned valkey into: