From cf66349dcd568b1d85a3ba4b70f15cf28d576c40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Serta=C3=A7=20=C3=96zercan?= <852750+sozercan@users.noreply.github.com> Date: Fri, 26 Jul 2024 13:57:09 -0700 Subject: [PATCH] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Sertaç Özercan <852750+sozercan@users.noreply.github.com> --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1b686be..846bb78 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,16 @@ This extension allows the user to leverage the abilities of the CLI tool without having to install a scanner or the CLI tool itself. The only requirement to use this extension is [Docker Desktop](https://docs.docker.com/desktop/)! +## How do install it? + +The extension be installed using this [link](https://open.docker.com/extensions/marketplace?extensionId=projectcopacetic/copacetic-docker-desktop-extension&tag=0.1.0)! + +It can also be installed with the following command: + +``` +docker extension install projectcopacetic/copacetic-docker-desktop-extension:0.1.0 +``` + ## How does it work? This extension is a web application displayed in a tab of the dashboard in Docker Desktop. It is written in JavaScript using the React JavaScript library and Material UI React component library. It creates three containers to scan an image, send vulnerability information to the frontend, and patch an image. It uses the `copa-extension-volume` to share the scan result between the three containers. @@ -20,7 +30,6 @@ This extension is a web application displayed in a tab of the dashboard in Docke | `busybox`| `busybox-copa-extension-container` | Runs the `cat` command to dump the json output file `scan.json` to `stdout`| |`copa-extension` | `copa-extension-container` | Runs a copa patch on the selected image using the vulnerability results from `scan.json` | - ### Components | Component | Description | @@ -31,14 +40,6 @@ This extension is a web application displayed in a tab of the dashboard in Docke | `commandline.tsx` | Stylized display to look like the command line for the stdout and stderr from the container running Copacetic | | `vulnerabilitydisplay.tsx`| Displays the vulnerability results from a trivy scan, similar to the docker scout vulnerability display| -## How do install it? - -The extension be installed using this [link](https://open.docker.com/extensions/marketplace?extensionId=projectcopacetic/copacetic-docker-desktop-extension&tag=0.1.0)! It can also be installed with the following command: - -``` -docker extension install projectcopacetic/copacetic-docker-desktop-extension:0.1.0 -``` - ## Contributing -We welcome contributions from the community! Read more about contributing [here](contributing.md). \ No newline at end of file +We welcome contributions from the community! Read more about contributing [here](contributing.md).