mirror of
https://github.com/stonith404/pingvin-share.git
synced 2024-11-15 03:50:11 +01:00
docs: improve ClamAV docs
This commit is contained in:
parent
b13a81a88c
commit
67a0fc6ea5
@ -9,12 +9,6 @@ services:
|
|||||||
volumes:
|
volumes:
|
||||||
- "./data:/opt/app/backend/data"
|
- "./data:/opt/app/backend/data"
|
||||||
- "./data/images:/opt/app/frontend/public/img"
|
- "./data/images:/opt/app/frontend/public/img"
|
||||||
# Optional: If you add ClamAV, uncomment the following to have ClamAV start first.
|
|
||||||
# depends_on:
|
# To add ClamAV, to scan your shares for malicious files,
|
||||||
# clamav:
|
# see https://stonith404.github.io/pingvin-share/setup/integrations/#clamav-docker-only
|
||||||
# condition: service_healthy
|
|
||||||
# Optional: Add ClamAV (see README.md)
|
|
||||||
# ClamAV is currently only available for AMD64 see https://github.com/Cisco-Talos/clamav/issues/482
|
|
||||||
# clamav:
|
|
||||||
# restart: unless-stopped
|
|
||||||
# image: clamav/clamav
|
|
||||||
|
@ -4,11 +4,29 @@ id: integrations
|
|||||||
|
|
||||||
# Integrations
|
# Integrations
|
||||||
|
|
||||||
#### ClamAV (Docker only)
|
#### 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.
|
||||||
|
|
||||||
1. Add the ClamAV container to the Docker Compose stack (see `docker-compose.yml`) and start the container.
|
1. Add the ClamAV container to the Docker Compose stack and start the container.
|
||||||
|
|
||||||
|
```diff
|
||||||
|
services:
|
||||||
|
pingvin-share:
|
||||||
|
image: stonith404/pingvin-share
|
||||||
|
...
|
||||||
|
+ depends_on:
|
||||||
|
+ clamav:
|
||||||
|
+ condition: service_healthy
|
||||||
|
|
||||||
|
+ clamav:
|
||||||
|
+ restart: unless-stopped
|
||||||
|
+ image: clamav/clamav
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
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"
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user