pingvin-share/README.md

Pingvin Share

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

🎪 Showcase

Demo: https://pingvin-share.dev.eliasschneider.com

✨ 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
• Light & dark mode

⌨️ Setup

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

1. Download the docker-compose.yml and .env.example file.
2. Rename the .env.example file to .env and change the environment variables so that they fit to your environment. If you need help with the environment variables take a look here
3. Run docker-compose up -d

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

Environment variables

Variable	Description	Possible values
APP_URL	On which URL Pingvin Share is available. E.g http://localhost or https://pingvin-share.com.	URL
SHOW_HOME_PAGE	Whether the Pingvin Share home page should be shown.	true/false
ALLOW_REGISTRATION	Whether a new user can create a new account.	true/false
ALLOW_UNAUTHENTICATED_SHARES	Whether a user can create a share without being signed in.	true/false
MAX_FILE_SIZE	Maximum allowed size per file in bytes.	Number
JWT_SECRET	Long random string to sign the JWT's.	Random string

Upgrade to a new version

Just update the docker container by running docker compose pull && docker compose up -d

Note: If you installed Pingvin Share before it used Sqlite, you unfortunately have to set up the project from scratch again, sorry for that.

🖤 Contribute

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