mirror of
https://github.com/stonith404/pingvin-share.git
synced 2024-07-06 17:30:10 +02:00
70 lines
3.0 KiB
Markdown
70 lines
3.0 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>
|
|
|
|
Pingvin Share is a self-hosted file sharing platform made for the [Appwrite Hackathon](https://dev.to/devteam/announcing-the-appwrite-hackathon-on-dev-1oc0).
|
|
|
|
## 🎪 Showcase
|
|
|
|
Demo: https://pingvin-share.dev.eliasschneider.com
|
|
|
|
<img src="https://user-images.githubusercontent.com/58886915/167101708-b85032ad-f5b1-480a-b8d7-ec0096ea2a43.png" width="700"/>
|
|
|
|
## ✨ Features
|
|
|
|
- Create a simple share with a link
|
|
- Secure your share with a visitor limit and a password
|
|
- Share your files with specific emails and send an invitation email
|
|
- Dark mode
|
|
|
|
## ⌨️ Setup
|
|
|
|
At the moment, the setup is a bit time-consuming. I will improve the setup in the future.
|
|
|
|
### 1. Appwrite
|
|
|
|
Pingvin Share uses Appwrite as backend. You have to install and setup Appwrite first
|
|
|
|
1. [Install Appwrite](https://appwrite.io/docs/installation)
|
|
2. Create an Account on your Appwrite instance
|
|
3. Change the `_APP_STORAGE_LIMIT` variable in the `.env` file of Appwrite to your prefered max size limit per share
|
|
|
|
### 2. Frontend
|
|
|
|
First of all you have to start the Docker container.
|
|
|
|
1. Clone the `docker-compose.yml` file and the `.env.example` file from this repository
|
|
2. Rename the `.env.example` file to `.env`
|
|
3. Start the container with `docker-compose up -d`
|
|
|
|
The container is now running. Now you have to setup the Appwrite structure, but no worries there is a simple setup script.
|
|
|
|
To run the script run `docker-compose exec pingvin-share node scripts/setup.js`.
|
|
|
|
You're almost done, now you have to change your environment variables that they fit to your setup.
|
|
|
|
1. Go to your Appwrite console, visit "API Keys" and copy the "Functions API Key" secret to your clipboard.
|
|
2. Paste the key to the `APPWRITE_FUNCTION_API_KEY` variable in the `.env` file
|
|
3. Change `PUBLIC_APPWRITE_HOST` in the `.env` file to the host where your Appwrite instance runs
|
|
4. Change the rest of the environment variables in the `.env` that they fit to your preferences
|
|
5. To save the environment variables run `docker-compose up -d`
|
|
6. Well done! Get a coffee and enjoy Pingvin Share 🎉
|
|
|
|
## ⚙️ Additional configurations
|
|
|
|
### SMTP
|
|
|
|
1. Enable `PUBLIC_MAIL_SHARE_ENABLE` in the `.env` file.
|
|
2. Visit your Appwrite console, click on functions and select the `Create Share` function.
|
|
3. At the settings tab change the empty variables to your SMTP setup.
|
|
|
|
## 💁♂️ Known issues / Limitations
|
|
|
|
Pingvin Share is currently in beta and there are issues and limitations that should be fixed in the future.
|
|
|
|
- `DownloadAll` generates the zip file on the client side. This takes alot of time. Because of that I temporarily limited this function to maximal 150 MB.
|
|
- If a user knows the share id, he can list and download the files directly from the Appwrite API even if the share is secured by a password or a visitor limit.
|
|
|
|
## 🖤 Contribute
|
|
|
|
You're very welcome to contribute to Pingvin Share!
|
|
Contact me, create an issue or directly create a pull request.
|