truecharts/charts/stable/clamav/docs/how-to.md at b9d9e2a262aca3d29fdd2ff967362cebf1302de9

Files

T

gismo2004andGitHub 7ebeb9e32c docs(clamav) update docs (#32374 )

**Description**

update docs

⚒️ 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
- [x] 📜 Documentation Changes

**🧪 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
- [x] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made changes to the documentation
- [ ] 🧪 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
- [ ] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or
`fix(docs):`

**➕ App addition**

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

- [ ] 🖼️ 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._

2025-02-21 17:39:03 +01:00

1.3 KiB

Raw Blame History

title

title
How-To

This is a quick setup guide on how to use ClamAV with mounted directories via NFS shares and configure the integrated cron job to scan these mounted folders.

App Installation

Cron Job

Without a GUI, using a cron job is the easiest way to run ClamAV in the background at specific times.

To generate a cron schedule, you can use a website like CronHub or Crontab Guru.
date_format follows the Linux date command syntax. See the date(1) man page for reference.
extra_args is where you define the directories to be scanned.

clamav:
  cron_enabled: true
  cron_schedule: "* * * * *"
  date_format: "+%m-%d-%Y_%H.%M.%S"
  log_file_name: clamscan_report
  extra_args: "/Apps /PathA /PathB"

Scan directory

Add your scanned directories, ensuring that your mounted directories match the paths specified in the extra_args section above.

persistence:
  Apps:
    enabled: true
    type: nfs
    path: ${NFS_PATH}
    server: ${SERVER_IP}
    mountPath: /Apps

Support

If you need more details or have a more customized setup, refer to the documentation on the upstream repository

1.3 KiB Raw Blame History

App Installation

Cron Job

Scan directory

Support

1.3 KiB

Raw Blame History