Quickstart guide#

This is the quick start guide for setting up and running the ingestion server locally.


Refer to the general setup guide for setting up the prerequisites. Refer to the ‘Ingestion server’ column in the requirement matrix to know what you need to run this.

Starting up#

  1. Ensure you download, install and set up all prerequisites. Ensure that the Docker daemon is running.

  2. Clone the repository to your computer. Then switch to the cloned directory. If you’re planning to contribute, fork the repo and clone your fork instead.

    git clone https://github.com/WordPress/openverse.git # or your fork
    cd openverse/

    If you followed the general setup guide and installed GitHub CLI, you can clone more simply using the gh command.

    gh repo clone WordPress/openverse # or your fork
    cd openverse/
  3. Bring the ingestion server up, along with all their dependent services.

    just ingestion_server/up

    The ingestion_server/up recipe orchestrates the following services: db, upstream_db, es, indexer_worker and ingestion_server.

    Now you should be able to access the following endpoints:

    You can view logs for the service using just logs ingestion_server.

Shutting down#

Refer to the common instructions.