Read this in another language: Spanish, English, Simplified Chinese, 日本語
Pingvin Share is self-hosted file sharing platform and an alternative for WeTransfer.
- Share files using a link
- Unlimited file size (restricted only by disk space)
- Set an expiration date for shares
- Secure shares with visitor limits and passwords
- Email recipients
- Integration with ClamAV for security scans
Note: Pingvin Share is in its early stages and may contain bugs.
- Download the
docker-compose.ymlfile - Run
docker-compose up -d
The website is now listening on http://localhost:3000, have fun with Pingvin Share 🐧!
Required tools:
git clone https://github.com/stonith404/pingvin-share
cd pingvin-share
# Checkout the latest version
git fetch --tags && git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
# Start the backend
cd backend
npm install
npm run build
pm2 start --name="pingvin-share-backend" npm -- run prod
# Start the frontend
cd ../frontend
npm install
npm run build
API_URL=http://localhost:8080 # Set the URL of the backend, default: http://localhost:8080
pm2 start --name="pingvin-share-frontend" npm -- run startUploading Large Files: By default, Pingvin Share uses a built-in reverse proxy to reduce the installation steps. However, this reverse proxy is not optimized for uploading large files. If you wish to upload larger files, you can either use the Docker installation or set up your own reverse proxy. An example configuration for Nginx can be found in /nginx/nginx.conf.
The website is now listening on http://localhost:3000, have fun with Pingvin Share 🐧!
ClamAV is used to scan shares for malicious files and remove them if found.
- Add the ClamAV container to the Docker Compose stack (see
docker-compose.yml) and start the container. - Docker will wait for ClamAV to start before starting Pingvin Share. This may take a minute or two.
- The Pingvin Share logs should now log "ClamAV is active"
Please note that ClamAV needs a lot of ressources.
View the OAuth 2 guide for more information.
As Pingvin Share is in early stage, see the release notes for breaking changes before upgrading.
docker compose pull
docker compose up -d-
Stop the running app
pm2 stop pingvin-share-backend pingvin-share-frontend
-
Repeat the steps from the installation guide except the
git clonestep.cd pingvin-share # Checkout the latest version git fetch --tags && git checkout $(git describe --tags `git rev-list --tags --max-count=1`) # Start the backend cd backend npm run build pm2 restart pingvin-share-backend # Start the frontend cd ../frontend npm run build API_URL=http://localhost:8080 # Set the URL of the backend, default: http://localhost:8080 pm2 restart pingvin-share-frontend
You can customize Pingvin Share by going to the configuration page in your admin dashboard.
For installation specific configuration, you can use environment variables. The following variables are available:
| 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 |
3000 |
The port on which the frontend listens. |
API_URL |
http://localhost:8080 |
The URL of the backend for the frontend. |
You can help to translate Pingvin Share into your language. On Crowdin you can easily translate Pingvin Share online.
Is your language not on Crowdin? Feel free to Request it.
Any issues while translating? Feel free to participate in the Localization discussion.
You're very welcome to contribute to Pingvin Share! Please follow the contribution guide to get started.