Skip to content

Commit

Permalink
Add common issues section to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
ahukkanen committed Oct 18, 2023
1 parent 35c635b commit dead3ab
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,26 @@ For installing ClamAV, refer to
For further information about the configurations and how to create custom
scanners, please refer to the [documentation](docs/index.md).

## Common issues

### NoMethodError (undefined method `attached?' ...)

Multiple issues have been opened because of users getting the following error
when trying to run a scan against a file path:

```
NoMethodError (undefined method `attached?' for "/path/to/file.pdf":String)
```

Most of the times this issue is because you have not configured the storage
correctly. If you want to run direct scans against files, please use the
`:filepath` storage option as described at
[Manually checking for viruses](#manually-checking-for-viruses).

If you need both: scans against file paths and scans against Active Storage
attached files, please use the `:multi` storage option as described in the same
section of the documentation.

## License

MIT, see [LICENSE](LICENSE).

0 comments on commit dead3ab

Please sign in to comment.