mirror of
https://github.com/stonith404/pingvin-share.git
synced 2024-11-15 11:50:34 +01:00
ac580b79b4
* 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>
37 lines
1.5 KiB
Markdown
37 lines
1.5 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 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
|
|
- 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 🐧!
|
|
|
|
## 📚 Documentation
|
|
|
|
For more installation options and advanced configurations, please refer to the [documentation](https://stonith404.github.io/pingvin-share).
|