pingvin-share/README.md

# <div align="center"><img  src="https://user-images.githubusercontent.com/58886915/166198400-c2134044-1198-4647-a8b6-da9c4a204c68.svg" width="40"/> </br>Pingvin Share</div>

[![](https://dcbadge.limes.pink/api/server/wHRQ9nFRcK)](https://discord.gg/wHRQ9nFRcK) [![](https://img.shields.io/badge/Crowdin-2E3340.svg?style=for-the-badge&logo=Crowdin&logoColor=white)](https://crowdin.com/project/pingvin-share) [![](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#white)](https://github.com/sponsors/stonith404)

---

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

## ✨ Features

- 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
- Reverse shares
- OIDC and LDAP authentication
- Integration with ClamAV for security scans

## 🐧 Get to know Pingvin Share

- [Demo](https://pingvin-share.dev.eliasschneider.com)
- [Review by DB Tech](https://www.youtube.com/watch?v=rWwNeZCOPJA)

<img src="https://user-images.githubusercontent.com/58886915/225038319-b2ef742c-3a74-4eb6-9689-4207a36842a4.png" width="700"/>

## ⌨️ Setup

### Installation with Docker (recommended)

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

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

> [!TIP]
> Checkout [Pocket ID](https://github.com/stonith404/pocket-id), a user-friendly OIDC provider that lets you easily log in to services like Pingvin Share using Passkeys.

## 📚 Documentation

For more installation options and advanced configurations, please refer to the [documentation](https://stonith404.github.io/pingvin-share).

## 🖤 Contribute

We would love it if you want to help make Pingvin Share better! You can either [help to translate](https://stonith404.github.io/pingvin-share/help-out/translate) Pingvin Share or [contribute to the codebase](https://stonith404.github.io/pingvin-share/help-out/contribute).

## ❤️ Sponsors

Thank you for supporting Pingvin Share 🙏

- [@COMPLEXWASTAKEN](https://github.com/COMPLEXWASTAKEN)
Update image paths 2022-05-02 09:19:33 +02:00			`# <div align="center"><img src="https://user-images.githubusercontent.com/58886915/166198400-c2134044-1198-4647-a8b6-da9c4a204c68.svg" width="40"/> </br>Pingvin Share</div>`
initial commit 2022-04-25 15:15:17 +02:00
docs: update Discord link 2024-05-24 08:09:16 +02:00			`[![](https://dcbadge.limes.pink/api/server/wHRQ9nFRcK)](https://discord.gg/wHRQ9nFRcK) [![](https://img.shields.io/badge/Crowdin-2E3340.svg?style=for-the-badge&logo=Crowdin&logoColor=white)](https://crowdin.com/project/pingvin-share) [![](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#white)](https://github.com/sponsors/stonith404)`
docs: add Spanish version of README and CONTRIBUTING (#138) * doc: add Spanish version of README and CONTRIBUTING * docs: change h3 tag from language switch to normal size 2023-04-01 20:15:47 +02:00
			`---`

docs: fix mistake in README.md (#566) 2024-08-25 22:57:06 +02:00			`Pingvin Share is a self-hosted file sharing platform and an alternative for WeTransfer.`
initial commit 2022-04-25 15:15:17 +02:00
Update README 2022-05-06 11:22:38 +02:00			`## ✨ Features`

docs: add stand-alone installation guide 2023-02-10 14:59:19 +01:00			`- 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`
docs: add Pocket ID as a tip to the README 2024-09-06 16:35:56 +02:00			`- Reverse shares`
			`- OIDC and LDAP authentication`
docs: add stand-alone installation guide 2023-02-10 14:59:19 +01:00			`- Integration with ClamAV for security scans`
Update README 2022-05-06 11:22:38 +02:00
docs: add review to README 2022-12-08 17:30:12 +01:00			`## 🐧 Get to know Pingvin Share`

			`- [Demo](https://pingvin-share.dev.eliasschneider.com)`
			`- [Review by DB Tech](https://www.youtube.com/watch?v=rWwNeZCOPJA)`

docs: update main screenshot 2023-03-14 15:47:42 +01:00			`<img src="https://user-images.githubusercontent.com/58886915/225038319-b2ef742c-3a74-4eb6-9689-4207a36842a4.png" width="700"/>`
docs: add review to README 2022-12-08 17:30:12 +01:00
Update README 2022-05-06 11:22:38 +02:00			`## ⌨️ Setup`
initial commit 2022-04-25 15:15:17 +02:00
docs: add stand-alone installation guide 2023-02-10 14:59:19 +01:00			`### Installation with Docker (recommended)`
docs: add synology nas installation by Marius 2022-12-11 12:38:58 +01:00
docs: updated README for new version 2022-12-02 20:33:17 +01:00			1. Download the `docker-compose.yml` file
change docker command (#470) 2024-05-14 09:49:40 +02:00			2. Run `docker compose up -d`
initial commit 2022-04-25 15:15:17 +02:00
feat: custom branding (#112) * add first concept * remove setup status * split config page in multiple components * add custom branding docs * add test email button * fix invalid email from header * add migration * mount images to host * update docs * remove unused endpoint * run formatter 2023-03-04 23:29:00 +01:00			The website is now listening on `http://localhost:3000`, have fun with Pingvin Share 🐧!
initial commit 2022-04-25 15:15:17 +02:00
docs: add Pocket ID as a tip to the README 2024-09-06 16:35:56 +02:00			`> [!TIP]`
docs: improve Pocket ID text in README 2024-09-06 16:37:29 +02:00			`> Checkout [Pocket ID](https://github.com/stonith404/pocket-id), a user-friendly OIDC provider that lets you easily log in to services like Pingvin Share using Passkeys.`
docs: add Pocket ID as a tip to the README 2024-09-06 16:35:56 +02:00
docs: add docusaurus docs * Created website for the docs inside /docs * remove old docs and home page * fix wrong redirection path * remove most of the docs from the readme * fix docs path * undo package.json changes * remove unused images * rename "how to" route --------- Co-authored-by: Elias Schneider <login@eliasschneider.com> 2024-08-24 17:30:11 +02:00			`## 📚 Documentation`
chore: add sponsor to README 2024-08-03 00:31:46 +02:00
docs: add docusaurus docs * Created website for the docs inside /docs * remove old docs and home page * fix wrong redirection path * remove most of the docs from the readme * fix docs path * undo package.json changes * remove unused images * rename "how to" route --------- Co-authored-by: Elias Schneider <login@eliasschneider.com> 2024-08-24 17:30:11 +02:00			`For more installation options and advanced configurations, please refer to the [documentation](https://stonith404.github.io/pingvin-share).`
docs: add contribute and sponsers section to README 2024-09-12 20:32:02 +02:00
			`## 🖤 Contribute`

			`We would love it if you want to help make Pingvin Share better! You can either [help to translate](https://stonith404.github.io/pingvin-share/help-out/translate) Pingvin Share or [contribute to the codebase](https://stonith404.github.io/pingvin-share/help-out/contribute).`

			`## ❤️ Sponsors`

			`Thank you for supporting Pingvin Share 🙏`

			`- [@COMPLEXWASTAKEN](https://github.com/COMPLEXWASTAKEN)`