Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Sertaç Özercan <852750+sozercan@users.noreply.github.com>
  • Loading branch information
sozercan authored and ashnamehrotra committed Aug 1, 2024
1 parent 5842fad commit cf66349
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 |
Expand All @@ -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).
We welcome contributions from the community! Read more about contributing [here](contributing.md).

0 comments on commit cf66349

Please sign in to comment.