This commit is contained in:
@@ -1,120 +1,122 @@
|
||||
<div align="center">
|
||||
<img src="https://github.com/user-attachments/assets/b5bc0c1e-5641-4106-b322-a1b0f5448b0f" width="60"/>
|
||||
|
||||
<h1>Pingvin Share X</h1>
|
||||
<img src="docs/logo.png" width="60"/>
|
||||
|
||||
<h1>VooShare</h1>
|
||||
|
||||
<p align="center">
|
||||
|
||||
 [](https://crowdin.com/project/pingvin-share-x)  [](https://github.com/sponsors/smp46)
|
||||
|
||||
<strong>A modern, self-hosted file sharing platform.</strong><br>
|
||||
Fast, secure, and easy to deploy.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
Pingvin Share X is a fork of [Pingvin Share](https://github.com/stonith404/pingvin-share), a self-hosted file sharing platform and an alternative for WeTransfer.
|
||||
VooShare is a modern self-hosted file sharing platform designed to make sharing files simple, secure, and reliable. Whether you're hosting it for personal use, your team, or your organization, VooShare gives you complete control over your data.
|
||||
|
||||
## 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
|
||||
* 📁 Share files using secure links
|
||||
* 🚀 Unlimited file size (limited only by available storage)
|
||||
* ⏳ Set expiration dates for shared files
|
||||
* 🔒 Password-protected shares
|
||||
* 👥 Visitor limits
|
||||
* 📧 Email recipients directly
|
||||
* 🔄 Reverse shares (request files from others)
|
||||
* 🔐 OIDC and LDAP authentication
|
||||
* 🛡️ ClamAV integration for malware scanning
|
||||
* 💾 Local storage and S3-compatible storage support
|
||||
|
||||
## Setup
|
||||
---
|
||||
|
||||
### Installation with Docker (recommended)
|
||||
# Installation
|
||||
|
||||
1. Download the `docker-compose.yml` file
|
||||
2. Run `docker compose up -d`
|
||||
## Docker (Recommended)
|
||||
|
||||
The website is now listening on `http://localhost:3000`.
|
||||
1. Download the `docker-compose.yml`.
|
||||
2. Start VooShare:
|
||||
|
||||
> [!TIP]
|
||||
> Checkout [stonith404/Pocket ID](https://github.com/stonith404/pocket-id), a user-friendly OIDC provider that lets you easily log in to services like Pingvin Share X using Passkeys. Made by the original creator of Pingvin Share.
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## Documentation
|
||||
Once running, open:
|
||||
|
||||
For more installation options and advanced configurations, please refer to the [documentation](https://smp46.github.io/pingvin-share-x/).
|
||||
```
|
||||
http://localhost:3000
|
||||
```
|
||||
|
||||
## Sponsors
|
||||
---
|
||||
|
||||
If you find Pingvin Share X useful and would like to support its ongoing development and maintenance please consider becoming a sponsor!
|
||||
# Documentation
|
||||
|
||||
I would like to host a demo instance online for people to try out Pingvin, your sponsorship would make this possible.
|
||||
Documentation covers installation, configuration, authentication providers, storage backends, reverse proxies, and advanced deployment options.
|
||||
|
||||
As a token of appreciation, sponsors can have their profile or company logo displayed right here in this section.
|
||||
Documentation is available in the `/docs` directory.
|
||||
|
||||
### Our Awesome Sponsors
|
||||
---
|
||||
|
||||
| <a href="https://github.com/sponsors/smp46"><img src="https://github.com/images/modules/logos_page/GitHub-Mark.png" width="60px;" alt=""/><br /><sub><b>Your Name Here</b></sub></a> |
|
||||
| :---: |
|
||||
# Why VooShare?
|
||||
|
||||
💖 Support the project via [GitHub Sponsors](https://github.com/sponsors/smp46)
|
||||
* Self-hosted
|
||||
* Privacy focused
|
||||
* Lightweight
|
||||
* Easy to deploy
|
||||
* Open source
|
||||
* Designed for individuals, teams, and organizations
|
||||
|
||||
## Contributing
|
||||
---
|
||||
|
||||
All contributions are welcome, including issues, feature suggestions, pull requests and *translations*.
|
||||
# Contributing
|
||||
|
||||
### Translations
|
||||
Contributions are always welcome.
|
||||
|
||||
This project supports 32 languages so far (to varying degrees), you can help complete
|
||||
those translations or add more at [CrowdIn](https://crowdin.com/project/pingvin-share-x).
|
||||
If you've found a bug, have an idea for a feature, or want to improve the project, feel free to open an issue or submit a pull request.
|
||||
|
||||
### AI Usage Policy
|
||||
## Pull Requests
|
||||
|
||||
Anyone submitting code to this repo needs to read and comply with the project's [AI Usage Policy](https://github.com/smp46/pingvin-share-x/blob/main/AI_USAGE_POLICY.md). Submissions that do not comply with be closed.
|
||||
Please ensure:
|
||||
|
||||
### Getting started
|
||||
* Clear and descriptive titles
|
||||
* Well documented changes
|
||||
* Code is formatted before submitting
|
||||
* New functionality includes appropriate tests where applicable
|
||||
|
||||
If you have found a bug, have suggestion or something else, please create an issue.
|
||||
---
|
||||
|
||||
### Submit a Pull Request
|
||||
# Development
|
||||
|
||||
Before you submit the pull request for review please ensure that
|
||||
## Backend
|
||||
|
||||
- The pull request naming follows the [Conventional Commits specification](https://www.conventionalcommits.org):
|
||||
```bash
|
||||
cd backend
|
||||
npm install
|
||||
npx prisma db push
|
||||
npx prisma db seed
|
||||
npm run dev
|
||||
```
|
||||
|
||||
`<type>[optional scope]: <description>`
|
||||
## Frontend
|
||||
|
||||
example:
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
```
|
||||
feat(share): add password protection
|
||||
```
|
||||
The frontend expects the backend to already be running.
|
||||
|
||||
When `TYPE` can be:
|
||||
- **feat** - is a new feature
|
||||
- **doc** - documentation only changes
|
||||
- **fix** - a bug fix
|
||||
- **refactor** - code change that neither fixes a bug nor adds a feature
|
||||
---
|
||||
|
||||
- Your pull request has a detailed description
|
||||
- You run `npm run format` to format the code
|
||||
# Testing
|
||||
|
||||
### Setup project
|
||||
Backend system tests:
|
||||
|
||||
#### Backend
|
||||
```bash
|
||||
npm run test:system
|
||||
```
|
||||
|
||||
1. Open the `backend` folder
|
||||
2. Install the dependencies with `npm install`
|
||||
3. Push the database schema to the database by running `npx prisma db push`
|
||||
4. Seed the database with `npx prisma db seed`
|
||||
5. Start the backend with `npm run dev`
|
||||
---
|
||||
|
||||
#### Frontend
|
||||
# License
|
||||
|
||||
1. Start the backend first
|
||||
2. Open the `frontend` folder
|
||||
3. Install the dependencies with `npm install`
|
||||
4. Start the frontend with `npm run dev`
|
||||
|
||||
You're all set!
|
||||
|
||||
#### Testing
|
||||
|
||||
At the moment we only have system tests for the backend. To run these tests, run `npm run test:system` in the backend folder.
|
||||
VooShare is released under the BSD 2-Clause License. See the `LICENSE` file for details.
|
||||
|
||||
Reference in New Issue
Block a user