docs(ClamAv): Add how-to guide (#5615)
* docs(ClamAv): Add how-to guide * Apply suggestions from code review Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
This commit is contained in:
parent
9dbbaf349c
commit
3bea823cf5
|
@ -22,7 +22,7 @@ sources:
|
||||||
- https://hub.docker.com/r/clamav/clamav
|
- https://hub.docker.com/r/clamav/clamav
|
||||||
- https://docs.clamav.net/
|
- https://docs.clamav.net/
|
||||||
type: application
|
type: application
|
||||||
version: 5.0.8
|
version: 5.0.1
|
||||||
annotations:
|
annotations:
|
||||||
truecharts.org/catagories: |
|
truecharts.org/catagories: |
|
||||||
- utilities
|
- utilities
|
||||||
|
|
|
@ -0,0 +1,40 @@
|
||||||
|
# How-To
|
||||||
|
|
||||||
|
This is a quick setup-guide on how-to to use ClamAV with mounting directories using NFS shares and using the integrated cron job to scan these mounted folders.
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
|
- ClamAV TrueCharts App
|
||||||
|
- NFS Shares of the folders you want to scan
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Guide
|
||||||
|
|
||||||
|
### Step 1
|
||||||
|
|
||||||
|
Setup App Name and Configuration as necessary, but where you deviate from defaults is by `Enable cronjob` at the <u>ClamAV Cron Configuration</u> section.
|
||||||
|
|
||||||
|
- To generate a cron schedule one can use a website like [cronhub](https://crontab.cronhub.io) or [crontab.guru](https://crontab.guru)
|
||||||
|
|
||||||
|
![Cron Config](img/Cron-Config.png)
|
||||||
|
|
||||||
|
**Note the added directory to `Extra Args`, this is where your scanned directories will go**
|
||||||
|
|
||||||
|
### Step 2
|
||||||
|
|
||||||
|
Add your scanned directories using `Configure Additional Storage` and make sure your mounted directories match the directory in the `Extra Args` section above
|
||||||
|
|
||||||
|
![NFS Share](img/NFS-Share.png)
|
||||||
|
|
||||||
|
That's it, without a GUI having the cron job is the easiest way to have your ClamAV running in the background at specific times.
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
- If you need more details or have a more custom setup the documentation on the [upstream](https://github.com/Cisco-Talos/clamav) is very complete so check the descriptions of the options there.
|
||||||
|
- You can also reach us using [Discord](https://discord.gg/tVsPTHWTtr) for real-time feedback and support
|
||||||
|
- If you found a bug in our chart, open a Github [issue](https://github.com/truecharts/apps/issues/new/choose)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
All Rights Reserved - The TrueCharts Project
|
Binary file not shown.
After Width: | Height: | Size: 40 KiB |
Binary file not shown.
After Width: | Height: | Size: 36 KiB |
Loading…
Reference in New Issue