diff --git a/README.md b/README.md index 1f254fd..9299281 100644 --- a/README.md +++ b/README.md @@ -12,18 +12,34 @@ The project is structured in two main components ### Step by step guide -1. Clone this project +1. Verify docker is installed + +For this guide the docker version used is the following + +```commandline +docker --version +Docker version 27.2.0, build 3ab4256 +``` + +Docker Desktop is a one-click-install application for your Mac, Linux, or Windows environment that lets you build, share, and run containerized applications and microservices. + +It provides a straightforward GUI (Graphical User Interface) that lets you manage your containers, applications, and images directly from your machine. + +Docker Desktop reduces the time spent on complex setups so you can focus on writing code. It takes care of port mappings, file system concerns, and other default settings, and is regularly updated with bug fixes and security updates. + +Get it at https://www.docker.com/products/docker-desktop + + +2. Clone this project ```commandline git clone https://code-repo.d4science.org/D-Net/openaire-solr-docker.git ``` -2. Compile the solr-importer Docker image + +3. Compile the solr-importer Docker image ```commandline -docker --version -Docker version 27.2.0, build 3ab4256 - cd openaire-solr-docker/solr-importer ❯ docker build . -t openaire/solr-importer --no-cache @@ -90,7 +106,7 @@ solr-importer/resources/prod_xml_json └── part-00004-016f0fea-e0d0-4210-a4d6-ece83b3e3e18-c000.json.gz ``` -3. Start the Solr cluster and the importer +4. Start the Solr cluster and the importer ```commandline ❯ docker compose up -d @@ -104,10 +120,6 @@ solr-importer/resources/prod_xml_json ✔ Container solr-importer Started ``` -Hint: get the docker desktop client for a simplified access to the running containers, manage the volumes, etc. - -https://www.docker.com/products/docker-desktop/ - ### Interacting with Solr The Solr and the zookeeper nodes run inside Docker images and interact sharing a network declared in the docker-compose