https://github.com/spacebabies/ok_computer-clamav

Monitor ClamAV using OK Computer
https://github.com/spacebabies/ok_computer-clamav

monitor-clamav okcomputer ruby ruby-gem ruby-on-rails

Last synced: 5 days ago
JSON representation

Monitor ClamAV using OK Computer

• Host: GitHub
• URL: https://github.com/spacebabies/ok_computer-clamav
• Owner: spacebabies
• License: mit
• Created: 2018-10-10T13:48:26.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-09-07T09:29:03.000Z (over 4 years ago)
• Last Synced: 2024-03-23T23:20:48.425Z (9 months ago)
• Topics: monitor-clamav, okcomputer, ruby, ruby-gem, ruby-on-rails
• Language: Ruby
• Homepage: https://www.spacebabies.nl/portfolio/clamav-monitoring-using-ok-computer/
• Size: 16.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# OkComputer::Clamav

Monitor `clamd` from the luxury of your existing [OkComputer](https://github.com/sportngin/okcomputer/) setup!

This check will make noise when the daemon does not respond to messages. It

makes a socket connection, sends a PING and waits for a PONG. If any of that

does not occur, you'll know it.

[![Gem Version](https://badge.fury.io/rb/ok_computer-clamav.svg)](https://badge.fury.io/rb/ok_computer-clamav)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'ok_computer-clamav'

```

And then execute:

    $ bundle

## Usage

In `config/initializers/ok_computer.rb`:

``` ruby

OkComputer::Registry.register "clamd",

  OkComputer::Clamav::ClamdCheck.new

```

By default it uses the standard Debian/Ubuntu socket path. You can change that:

``` ruby

OkComputer::Registry.register "clamd", 

  OkComputer::Clamav::ClamdCheck.new(socket: '/tmp/clamd.sock') # e.g. Homebrew

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/spacebabies/ok_computer-clamav.