Skip to content

Commit

Permalink
feat: add ClamAV to scan for malicious files
Browse files Browse the repository at this point in the history
  • Loading branch information
stonith404 committed Jan 13, 2023
1 parent 16b6970 commit 76088cc
Show file tree
Hide file tree
Showing 18 changed files with 284 additions and 171 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ RUN npm run build && npm prune --production

# Stage 5: Final image
FROM node:18-slim AS runner
ENV NODE_ENV=production
ENV NODE_ENV=docker
RUN apt-get update && apt-get install -y openssl

WORKDIR /opt/app/frontend
Expand Down
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@ Pingvin Share is self-hosted file sharing platform and an alternative for WeTran

## ✨ Features

- Spin up your instance within 2 minutes
- Create a share with files that you can access with a link
- No file size limit, only your disk will be your limit
- Set a share expiration
- Optionally secure your share with a visitor limit and a password
- Email recepients
- Light & dark mode
- ClamAV integration

## 🐧 Get to know Pingvin Share

Expand All @@ -30,6 +29,18 @@ Pingvin Share is self-hosted file sharing platform and an alternative for WeTran

The website is now listening available on `http://localhost:3000`, have fun with Pingvin Share 🐧!

### Integrations

#### ClamAV

With ClamAV the shares get scanned for malicious files and get removed if any found.

1. Add the ClamAV container to the Docker Compose stack (see `docker-compose.yml`) and start the container.
2. As soon as the ClamAV container is ready (when ClamAV logs "socket found, clamd started"), restart the Pingvin Share container with `docker compose restart pingvin-share`
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).

### Additional resources

- [Synology NAS installation](https://mariushosting.com/how-to-install-pingvin-share-on-your-synology-nas/)
Expand Down
Loading

0 comments on commit 76088cc

Please sign in to comment.