kamp/pingvin-share
1
0
Fork 0
mirror of https://github.com/stonith404/pingvin-share.git synced 2024-11-15 11:50:34 +01:00
Code

docs: update clamav docs

Browse Source
This commit is contained in:
Elias Schneider 2024-09-19 08:35:28 +02:00
parent 6b39adfd03
commit 64acae11a2
No known key found for this signature in database
GPG Key ID: 07E623B294202B6C
2 changed files with 20 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/setup/configuration.md
View File

@ -34,13 +34,13 @@ For installation specific configuration, you can use environment variables. The
#### Backend #### Backend
| Variable | Default Value | Description | | Variable | Default Value | Description |
| ---------------- | -------------------------------------------------- | -------------------------------------- | | ---------------- | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `PORT` | `8080` | The port on which the backend listens. | | `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. | | `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. | | `DATA_DIRECTORY` | `./data` | The directory where data is stored. |
| `CLAMAV_HOST` | `127.0.0.1` | The IP address of the ClamAV server. | | `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. | | `CLAMAV_PORT` | `3310` | The port number of the ClamAV server. |
#### Frontend #### Frontend

17
docs/docs/setup/integrations.md
View File

@ -4,12 +4,18 @@ id: integrations
# Integrations # Integrations
#### ClamAV ## ClamAV
> **_NOTE:_** Currently ClamAV is only available in the Docker installation.
ClamAV is used to scan shares for malicious files and remove them if found. 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. 1. Add the ClamAV container to the Docker Compose stack and start the container.
```diff ```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. 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" 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.