From 07a2e63eb89422f21f25e3059366babfd4f64479 Mon Sep 17 00:00:00 2001 From: nielm Date: Mon, 8 Nov 2021 12:12:24 +0100 Subject: [PATCH] Update README.md v1.2 --- README.md | 32 ++++++++------------------- cloudrun-malware-scanner/package.json | 2 +- 2 files changed, 10 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 71e1181..2b540e3 100755 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/cloudrun-malware-scanner/package.json b/cloudrun-malware-scanner/package.json index 934891d..7f82606 100644 --- a/cloudrun-malware-scanner/package.json +++ b/cloudrun-malware-scanner/package.json @@ -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": {