kamp/pingvin-share
1
0
Fork 0
mirror of https://github.com/stonith404/pingvin-share.git synced 2024-06-30 06:30:11 +02:00
Code
A self-hosted file sharing platform that combines lightness and beauty, perfect for seamless and efficient file sharing.
162 Commits 3 Branches 64 Tags 19 MiB
TypeScript 99.8%
Dockerfile 0.2%
e40cc0f48b
Go to file
Elias Schneider e40cc0f48b fix: only log jobs if they actually did something
2022-10-31 10:33:27 +01:00
.github/workflows chore: add release & tagging workflow 2022-10-17 23:05:39 +02:00
backend fix: only log jobs if they actually did something 2022-10-31 10:33:27 +01:00
frontend fix: share finishes before all files are uploaded 2022-10-31 10:28:29 +01:00
.dockerignore fix: my shares doesn't make an api request 2022-10-14 11:29:54 +02:00
.env.example docs: add ALLOW_UNAUTHENTICATED_SHARES to README 2022-10-24 09:12:12 +02:00
.gitignore chore: Fixed some missing dependencies in package.json 2022-10-12 16:03:50 -04:00
CHANGELOG.md release: 0.1.0 2022-10-29 23:12:32 +02:00
CONTRIBUTING.md docs: add contribution guide 2022-10-16 22:54:39 +02:00
docker-compose.yml fix: add ALLOW_UNAUTHENTICATED_SHARES to docker compose file 2022-10-30 00:25:49 +02:00
Dockerfile fix: opt out of static site generation to enable publicRuntimeConfig 2022-10-18 09:17:57 +02:00
LICENSE Create LICENSE 2022-04-26 08:15:49 +02:00
package.json chore: add dev deployment script 2022-10-31 10:28:46 +01:00
README.md docs: improve upgrade instruction 2022-10-30 13:24:50 +01:00

README.md


Pingvin Share

Pingvin Share is self-hosted file sharing platform and an alternative for WeTransfer.

🎪 Showcase

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

✨ Features

  • Create a share with files that you can access with a link
  • No file size limit, only your disk will be your limit
  • Set a share expiration
  • Optionally secure your share with a visitor limit and a password
  • Light & dark mode

⌨️ Setup

Pleas note that Pingvin Share is in early stage and could include some bugs

  1. Download the docker-compose.yml and .env.example file.
  2. Rename the .env.example file to .env and change the environment variables so that they fit to your environment. If you need help with the environment variables take a look here
  3. Run docker-compose up -d

The website is now listening available on http://localhost:3000, have fun with Pingvin Share 🐧!

Environment variables

Variable Description Possible values
APP_URL On which URL Pingvin Share is available. E.g http://localhost or https://pingvin-share.com. URL
SHOW_HOME_PAGE Whether the Pingvin Share home page should be shown. true/false
ALLOW_REGISTRATION Whether a new user can create a new account. true/false
ALLOW_UNAUTHENTICATED_SHARES Whether a user can create a share without being signed in. true/false
MAX_FILE_SIZE Maximum allowed size per file in bytes. Number
JWT_SECRET Long random string to sign the JWT's. Random string

Upgrade to a new version

  1. Check if your local docker-compose.yml and .env files are up to date with the files in the repository
  2. Run docker compose pull && docker compose up -d to update your docker container

Note: If you installed Pingvin Share before it used Sqlite, you unfortunately have to set up the project from scratch again, sorry for that.

🖤 Contribute

You're very welcome to contribute to Pingvin Share! Follow the contribution guide to get started.