diff --git a/.github/workflows/pypi.yaml b/.github/workflows/pypi.yaml index ad09fd9..720a135 100644 --- a/.github/workflows/pypi.yaml +++ b/.github/workflows/pypi.yaml @@ -5,15 +5,15 @@ on: release jobs: build-n-publish: name: Build and publish Python 🐍 distributions 📦 to PyPI - runs-on: ubuntu-18.04 + runs-on: ubuntu-latest steps: - uses: actions/checkout@master - - name: Set up Python 3.7 - uses: actions/setup-python@v4 + - name: Set up Python 3.12 + uses: actions/setup-python@v5 with: - python-version: 3.7 + python-version: 3.12 - name: Install pypa/build run: >- diff --git a/CHANGES.md b/CHANGES.md index 6a9c5e0..e9adbd6 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -8,20 +8,43 @@ > - Fixed: 🐛 > - Security: 🛡 +## Version 1.1.2 + +➕ Added a Docker Compose file to make it easier to host a private mirror. + The Docker Compose environment runs two containers: + 1. CVD-Update. + 2. An Apache webserver to host the private mirror. + + Improvement courtesy of Mark Petersen. + - GitHub Pull-Request: https://github.com/Cisco-Talos/cvdupdate/pull/61 + +🐛 Fixed the CVD-Update Python package so it installs the `setuptools` + dependency. This fixes a runtime error on some systems. + Fix courtesy of Craig Andrews. + - GitHub Pull-Request: https://github.com/Cisco-Talos/cvdupdate/pull/59 + +🐛 Added missing documentation for `cvd add` command to the Readme. + Fix courtesy of Kim Oliver Drechsel. + - GitHub Pull-Request: https://github.com/Cisco-Talos/cvdupdate/pull/58 + +➕ Added retries in case the DNS TXT query fails. + Fix courtesy of backbord. + - GitHub Pull-Request: https://github.com/Cisco-Talos/cvdupdate/pull/50 + ## Version 1.1.1 🐛 Fixed an issue where the `.cdiff` files were only downloaded when updating a -`.cvd` and not when downloading the `.cvd` for the first time. + `.cvd` and not when downloading the `.cvd` for the first time. 🐛 Fixed an issue where `cvd update` crashes if the DNS query fails, rather -than printing a helpful error message and exiting. + than printing a helpful error message and exiting. 🐛 Fixed support for CVD Update on Windows 🪟. In prior versions, the DNS query -was failing if a DNS server was not specified manually. Now it will try to use -OpenDNS servers if no DNS server is specified. + was failing if a DNS server was not specified manually. Now it will try to use + OpenDNS servers if no DNS server is specified. ➕ Added Python dependencies to the Readme to help users that are unable to -install using `pip`. + install using `pip`. ## Version 1.1.0 diff --git a/README.md b/README.md index bd7997b..d5418a7 100644 --- a/README.md +++ b/README.md @@ -222,6 +222,7 @@ Familiarize yourself with the various commands using the `--help` option. cvd --help cvd config --help cvd update --help +cvd add --help cvd clean --help ``` @@ -271,6 +272,20 @@ ls ~/.cvdupdate/logs cat ~/.cvdupdate/logs/* ``` +### Add an additional database + +Maybe add an additional database that is not part of the default set of databases. + +```bash +cvd add linux.cvd https://database.clamav.net/linux.cvd +``` + +List out the databases again: + +```bash +cvd list -V +``` + ### Serve it up, Test out FreshClam Test out your mirror with FreshClam on the same computer. @@ -283,7 +298,7 @@ You can test it by running `freshclam` or `freshclam.exe` locally, where you've DatabaseMirror http://localhost:8000 ``` -### Use docker +## Use docker Build docker image diff --git a/compose.yaml b/compose.yaml new file mode 100644 index 0000000..07c4c43 --- /dev/null +++ b/compose.yaml @@ -0,0 +1,23 @@ +services: + cvdupdate: + build: ./ + hostname: cvdupdate + container_name: cvdupdate + image: cvdupdate:latest + environment: + - CRON=30 */4 * * * + - USER_ID=0 + volumes: + - database:/cvdupdate/database + - log:/cvdupdate/logs + ## Apache instance to serve the mirror + apache: + image: httpd:2.4 + volumes: + - database:/usr/local/apache2/htdocs + ports: + - 8000:80 + +volumes: + database: + log: diff --git a/setup.py b/setup.py index c4a867d..f2d9f20 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ setuptools.setup( name="cvdupdate", - version="1.1.1", + version="1.1.2", author="The ClamAV Team", author_email="clamav-bugs@external.cisco.com", copyright="Copyright (C) 2022 Cisco Systems, Inc. and/or its affiliates. All rights reserved.", @@ -27,6 +27,7 @@ "requests", "dnspython>=2.1.0", "rangehttpserver", + "setuptools", ], classifiers=[ "Programming Language :: Python :: 3",