From 64acae11a26c700a61be369599975c28508679cc Mon Sep 17 00:00:00 2001 From: Elias Schneider Date: Thu, 19 Sep 2024 08:35:28 +0200 Subject: [PATCH] docs: update clamav docs --- docs/docs/setup/configuration.md | 14 +++++++------- docs/docs/setup/integrations.md | 17 +++++++++++++---- 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/docs/docs/setup/configuration.md b/docs/docs/setup/configuration.md index f8bc89c3..847cbb59 100644 --- a/docs/docs/setup/configuration.md +++ b/docs/docs/setup/configuration.md @@ -34,13 +34,13 @@ For installation specific configuration, you can use environment variables. The #### Backend -| Variable | Default Value | Description | -| ---------------- | -------------------------------------------------- | -------------------------------------- | -| `PORT` | `8080` | The port on which the backend listens. | -| `DATABASE_URL` | `file:../data/pingvin-share.db?connection_limit=1` | The URL of the SQLite database. | -| `DATA_DIRECTORY` | `./data` | The directory where data is stored. | -| `CLAMAV_HOST` | `127.0.0.1` | The IP address of the ClamAV server. | -| `CLAMAV_PORT` | `3310` | The port number of the ClamAV server. | +| Variable | Default Value | Description | +| ---------------- | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `PORT` | `8080` | The port on which the backend listens. | +| `DATABASE_URL` | `file:../data/pingvin-share.db?connection_limit=1` | The URL of the SQLite database. | +| `DATA_DIRECTORY` | `./data` | The directory where data is stored. | +| `CLAMAV_HOST` | `127.0.0.1` or `clamav` when running with Docker | The IP address of the ClamAV server. See the [ClamAV docs](integrations.md#clamav) for more information. | +| `CLAMAV_PORT` | `3310` | The port number of the ClamAV server. | #### Frontend diff --git a/docs/docs/setup/integrations.md b/docs/docs/setup/integrations.md index fd82056d..c71f1dc0 100644 --- a/docs/docs/setup/integrations.md +++ b/docs/docs/setup/integrations.md @@ -4,12 +4,18 @@ id: integrations # Integrations -#### ClamAV - -> **_NOTE:_** Currently ClamAV is only available in the Docker installation. +## ClamAV ClamAV is used to scan shares for malicious files and remove them if found. +Please note that ClamAV needs a lot of [ressources](https://docs.clamav.net/manual/Installing/Docker.html#memory-ram-requirements). + +### Docker + +If you are already running ClamAV elsewhere, you can specify the `CLAMAV_HOST` environment variable to point to that instance. + +Else you have to add the ClamAV container to the Pingvin Share Docker Compose stack: + 1. Add the ClamAV container to the Docker Compose stack and start the container. ```diff @@ -30,4 +36,7 @@ services: 2. Docker will wait for ClamAV to start before starting Pingvin Share. This may take a minute or two. 3. The Pingvin Share logs should now log "ClamAV is active" -Please note that ClamAV needs a lot of [ressources](https://docs.clamav.net/manual/Installing/Docker.html#memory-ram-requirements). +### Stand-Alone + +1. Install ClamAV +2. Specify the `CLAMAV_HOST` environment variable for the backend and restart the Pingvin Share backend.