Files
truecharts/charts/stable/clamav/docs/how-to.md
T
Stavros KoisandGitHub 698622495c chore(docs): standardize ./img references (#16704)
**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._
2023-12-31 22:39:31 +02:00

1.5 KiB

title
title
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 ClamAV Cron Configuration section.

Cron Config

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

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 is very complete so check the descriptions of the options there.
  • You can also reach us using Discord for real-time feedback and support
  • If you found a bug in our chart, open a Github issue

All Rights Reserved - The TrueCharts Project