kamp/pingvin-share
1
0
Fork 0
mirror of https://github.com/stonith404/pingvin-share.git synced 2024-11-18 21:30:12 +01:00
Code
d05bea4a7e
pingvin-share/README.md
Elias Schneider ded5ca4b51
Update README
2022-05-06 11:22:38 +02:00

2.9 KiB
Raw Blame History


Pingvin Share

Pingvin Share is a selfhosted file sharing plattform made for the Appwrite Hackathon.

🎪 Showcase

Demo: https://pingvin-share.dev.eliasschneider.com

✨ 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
  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 I made a 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 PUBLIC_MAX_FILE_SIZE in the .env file to the max file size limit you want

⚙️ 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.