From 51489501258ac750623f89f56860eedce67484d9 Mon Sep 17 00:00:00 2001 From: pushrbx Date: Mon, 4 Nov 2024 23:11:49 +0000 Subject: [PATCH] added docs for the new command --- container_usage.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/container_usage.md b/container_usage.md index bce6bd7..a9cbb5b 100644 --- a/container_usage.md +++ b/container_usage.md @@ -16,6 +16,9 @@ This will: > **Note**: The script supports both `docker` and `podman`. In case of `podman` please bare in mind that sometimes the container name resolution doesn't work on the container network. > In those cases you might have to install `aardvark-dns` package. On `Arch Linux` podman uses `netavark` network by default (in 2023) so you will need to install the before mentioned package. +> **Note 2**: The script will start the jikan API, but if you start it for the first time, it won't have any data in it! +> You will have to run the indexers through artisan to have data. See ["Running the indexer with the script"](#running-the-indexer-with-the-script) section. + The script has the following prerequisites and will notify you if these are not present: - git @@ -36,6 +39,7 @@ start Start Jikan API (mongodb, typesense, redis, jikan-api wor stop Stop Jikan API validate-prereqs Validate pre-reqs installed (docker, docker-compose) execute-indexers Execute the indexers, which will scrape and index data from MAL. (Notice: This can take days) +index-incrementally Executes the incremental indexers for each media type. (anime, manga, character, people) ``` ### Running the indexer with the script