diff --git a/docker/README.md b/docker/README.md index 8752493..add4a65 100644 --- a/docker/README.md +++ b/docker/README.md @@ -8,6 +8,7 @@ This document offers instructions on how to set up and utilize the Dockerized ve Table of Contents
  1. Getting Started
  2. +
  3. Using the Pre-built Image
  4. Dockerfile Details
@@ -25,7 +26,7 @@ This document offers instructions on how to set up and utilize the Dockerized ve To build and run the Docker image: ```bash -sudo ./start.sh +# ./start.sh ``` When executed, this script performs the following actions: @@ -38,7 +39,7 @@ When executed, this script performs the following actions: In case you want to stop the running container and/or remove the Docker image: ```bash -sudo ./remove.sh +# ./remove.sh ``` Executing this script will: @@ -47,6 +48,63 @@ Executing this script will:

(🔼 Back to top)

+## Using the Pre-built Image + +If you'd rather use the pre-built Docker image from Docker Hub, follow these steps: + +### Pulling the Image + +Retrieve the Docker image using: +```bash +# docker pull franckferman/metadetective:1.0.8-df.2 +``` + +### Running the Container + +Start a container based on the image: + +```bash +# docker run -it --name metadetective franckferman/metadetective:1.0.8-df.2 /bin/bash +``` + +### Stopping the Container + +```bash +# docker stop metadetective +``` + +This command will stop the container named "metadetective". + +### Removing the Container + +Once the container is stopped, you can remove it using: +```bash +# docker rm metadetective +``` + +This command will remove the container named "metadetective". + +### Troubleshooting container deletion problems + +1. List All Containers (including stopped ones): +```bash +# docker ps -a +``` + +Check if the container "metadetective" is listed. If it's listed, note the container ID. + +2. Force Remove the Container: +```bash +# docker rm -f metadetective +``` + +Alternatively, if using the container ID: +```bash +# docker rm -f [CONTAINER_ID] +``` + +

(🔼 Back to top)

+ ## Dockerfile Details Our Docker image is built upon the lightweight foundation of `debian:bullseye-slim`. @@ -62,4 +120,3 @@ The following essential packages are installed: Due to the ENV PATH="/root/.local/bin:${PATH}" setting in the Dockerfile, you can directly launch MetaDetective within the container without needing to navigate to any specific directory. Simply invoke MetaDetective followed by the desired command-line arguments.

(🔼 Back to top)

-