9dfb52a145
* add config file possibility * revert port in docker compose * Update docker-compose.yml Co-authored-by: Elias Schneider <login@eliasschneider.com> * Update docker-compose.yml Co-authored-by: Elias Schneider <login@eliasschneider.com> * add attribute description to config file * remove email message config * add package to resolve errors * remove email messages from config * move config initialization to config module * revert unnecessary change * add order * improve alert * run formatter * remove unnecessary packages * remove unnecessary types * use logger * don't save yaml config to db * allowEdit if no yaml config is set * improve docs * fix allow edit state * remove unnecessary check and refactor code * restore old config file * add script that generates `config.example.yaml` automatically * allow config variables to be changed if they are not set in the `config.yml` * add back init user * Revert "allow config variables to be changed if they are not set in the `config.yml`" This reverts commit 7dbdb6729034be5b083f126f854d5e1411735a54. * improve info box text --------- Co-authored-by: Elias Schneider <login@eliasschneider.com>
53 lines
2.2 KiB
Markdown
53 lines
2.2 KiB
Markdown
# <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://discord.gg/wHRQ9nFRcK) [](https://crowdin.com/project/pingvin-share) [](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
|
|
- Different file providers: local storage and S3
|
|
|
|
## 🐧 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)
|