Skip to content

Commit

Permalink
added docs for the new command
Browse files Browse the repository at this point in the history
  • Loading branch information
pushrbx committed Nov 4, 2024
1 parent 6568ff2 commit 5148950
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions container_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 5148950

Please sign in to comment.