Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.
/ clamav-api-cg-app Public archive
generated from 18F/open-source-policy

Cloud.gov and ClamAV-enabled file scanning API - DEPRECATED

License

Notifications You must be signed in to change notification settings

18F/clamav-api-cg-app

Repository files navigation

ClamAV API CG App

Update:

This repository is no longer actively maintained. A recommended way to deploy the ClamAV app and setup network policies for it is to use terraform with https://github.com/18f/terraform-cloudgov#clamav

Why this project

This project aims to create a deployable cloud.gov app that will expose a REST api for scanning files for malware with ClamAV.

It is inspired by, and borrowed heavily from, https://blog.theodo.com/2017/11/implement-antivirus-api-10-min/

This manifest now runs a docker image from https://github.com/ajilaag/clamav-rest

Setup

This project depends on one deployment variable, which is documented in vars.yml-template

cp vars.yml-template vars.yml

Create app

To push the app to cloud.gov:

cf push --vars-file vars.yml

or to specify the project yourself:

cf push --var project="PROJECT_NAME"

Configure networking

A network policy is required to route the TCP traffic from your app to the API endpoint on the apps.internal domain

cf add-network-policy SOURCE_APP --destination-app DESTINATION_APP --protocol tcp --port 9443

Contributing

See CONTRIBUTING for additional information.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

About

Cloud.gov and ClamAV-enabled file scanning API - DEPRECATED

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published