Skip to content

Commit

Permalink
Update README.md v1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
nielm committed Nov 15, 2021
1 parent 2c5c584 commit 07a2e63
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 24 deletions.
32 changes: 9 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Malware Scanner Service

This repository contains the code to build a pipeline that scans documents
uploaded to GCS for malware. It illustrates how to use Cloud Run and Eventarc to
build such a pipeline.
This repository contains the code to build a pipeline that scans objects
uploaded to GCS for malware, moving the documents to a clean or quarantined
bucket depending on the malware scan status.

It illustrates how to use Cloud Run and Eventarc to build such a pipeline.

## How to use this example

Expand All @@ -11,31 +13,15 @@ Use the
to understand how to configure your Google Cloud Platform project to use Cloud
Run and Eventarc.

1. Check it out from GitHub.
2. Create a new local repository and copy the files from this repo into it.
3. Develop and enhance it for your use case

## Quickstart

Clone this repository

```sh
git clone https://github.com/GoogleCloudPlatform/docker-clamav-malware-scanner.git
```

Change directory to one of the example directories

Follow the walkthrough in the tutorial associated with the Nodejs example for
configuration details of Cloud platform products (Cloud Storage, Cloud Run and
Eventarc) and adapt accordingly using the accompanying README for each example.

## Changes

* 2019-09-01 Initial version
* 2020-10-05 Fixes for ClamAV OOM
* 2021-10-14 Use Cloud Run and EventArc instead of Cloud Functions/App Engine
* 2021-10-22 Improve resiliency, Use streaming reads (no tempfile), improve
logging, and handles files in subdirectories
* 2021-10-22 Improve resiliency, Use streaming reads (no temp disk required),
improve logging, and handles files in subdirectories
* 2021-11-08 Add support for scanning multiple buckets, improve error
handling to prevent infinite retries,

## License

Expand Down
2 changes: 1 addition & 1 deletion cloudrun-malware-scanner/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "gcs-malware-scanner",
"version": "1.1.0",
"version": "1.2.0",
"description": "Service to scan GCS documents for the malware and move the analyzed documents to appropriate buckets",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 07a2e63

Please sign in to comment.