https://github.com/toblux/start-clamd-github-action

GitHub Action to start a ClamAV server
https://github.com/toblux/start-clamd-github-action

clamav clamd github-action

Last synced: 6 months ago
JSON representation

GitHub Action to start a ClamAV server

• Host: GitHub
• URL: https://github.com/toblux/start-clamd-github-action
• Owner: toblux
• License: mit
• Created: 2023-12-15T22:11:49.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-11T20:16:23.000Z (over 1 year ago)
• Last Synced: 2025-02-11T21:24:39.515Z (over 1 year ago)
• Topics: clamav, clamd, github-action
• Homepage:
• Size: 305 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Start ClamAV Daemon GitHub Action

This GitHub action starts a lightweight ClamAV daemon. By default, `clamd` loads only the `bytecode` database, but the `main` and `daily` databases can be enabled if needed.

The action works on Linux, macOS, and Windows runners. On Linux and macOS, `clamd` listens on TCP port 3310 and the Unix socket at `/tmp/clamd.socket`. On Windows, `clamd` listens on TCP port 3310.

## Inputs

No inputs are required for this action to run. Please refer to [action.yml](action.yml) to see which inputs can be customized and their default values.

## Usage

```yaml

name: Example workflow

on: [push, pull_request]

jobs:

  clamd_ubuntu:

    runs-on: ubuntu-latest

    steps:

      - name: Start ClamAV daemon clamd

        uses: toblux/start-clamd-github-action@v0.2.1

        with: # Custom inputs are optional (these are the default values)

          unix_socket: /tmp/clamd.socket

          tcp_port: 3310

          stream_max_length: 1M

      - name: Ping clamd on TCP port 3310

        run: echo PING | nc localhost 3310

      - name: Ping clamd using the Unix socket

        run: echo PING | nc -U /tmp/clamd.socket

  clamd_windows:

    runs-on: windows-latest

    steps:

      - name: Start ClamAV daemon clamd

        uses: toblux/start-clamd-github-action@v0.2.1

      - name: Test the connection to clamd on TCP port 3310

        run: Test-NetConnection -ComputerName localhost -Port 3310

```