kamp/pingvin-share
1
0
Fork 0
mirror of https://github.com/stonith404/pingvin-share.git synced 2024-11-05 07:20:13 +01:00
Code
A self-hosted file sharing platform that combines lightness and beauty, perfect for seamless and efficient file sharing.
269 Commits 6 Branches 82 Tags 35 MiB
TypeScript 99.8%
Dockerfile 0.1%
76088cc76a
Go to file
Elias Schneider 76088cc76a feat: add ClamAV to scan for malicious files
2023-01-13 10:16:35 +01:00
.github ci/cd: don't stale feature issues 2023-01-12 13:47:09 +01:00
backend feat: add ClamAV to scan for malicious files 2023-01-13 10:16:35 +01:00
frontend feat: add ClamAV to scan for malicious files 2023-01-13 10:16:35 +01:00
.dockerignore fix: my shares doesn't make an api request 2022-10-14 11:29:54 +02:00
.gitignore chore: Fixed some missing dependencies in package.json 2022-10-12 16:03:50 -04:00
CHANGELOG.md release: 0.6.1 2023-01-11 13:08:09 +01:00
CONTRIBUTING.md docs: updated README for new version 2022-12-02 20:33:17 +01:00
docker-compose-dev.yml feat: add ClamAV to scan for malicious files 2023-01-13 10:16:35 +01:00
docker-compose.yml feat: add ClamAV to scan for malicious files 2023-01-13 10:16:35 +01:00
Dockerfile feat: add ClamAV to scan for malicious files 2023-01-13 10:16:35 +01:00
LICENSE Create LICENSE 2022-04-26 08:15:49 +02:00
package.json release: 0.6.1 2023-01-11 13:08:09 +01:00
README.md feat: add ClamAV to scan for malicious files 2023-01-13 10:16:35 +01:00
SECURITY.md Create SECURITY.md 2022-12-12 11:11:28 +01:00

README.md


Pingvin Share

Pingvin Share is self-hosted file sharing platform and an alternative for WeTransfer.

✨ Features

  • 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
  • ClamAV integration

🐧 Get to know Pingvin Share

⌨️ Setup

Pleas note that Pingvin Share is in early stage and could include some bugs

Recommended installation

  1. Download the docker-compose.yml file
  2. Run docker-compose up -d

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.

Additional resources

Upgrade to a new version

Run docker compose pull && docker compose up -d to update your docker container

🖤 Contribute

You're very welcome to contribute to Pingvin Share! Follow the contribution guide to get started.