kamp/pingvin-share
1
0
Fork 0
mirror of https://github.com/stonith404/pingvin-share.git synced 2024-11-04 23:10:13 +01:00
Code
A self-hosted file sharing platform that combines lightness and beauty, perfect for seamless and efficient file sharing.
142 Commits 6 Branches 82 Tags 35 MiB
TypeScript 99.8%
Dockerfile 0.1%
c52a4d5e3a
Go to file
Elias Schneider c52a4d5e3a feat(frontend): remove footer
2022-10-18 09:31:13 +02:00
.github/workflows chore: add release & tagging workflow 2022-10-17 23:05:39 +02:00
backend refactor: move jobs folder into src root 2022-10-16 00:25:32 +02:00
frontend feat(frontend): remove footer 2022-10-18 09:31:13 +02:00
.dockerignore fix: my shares doesn't make an api request 2022-10-14 11:29:54 +02:00
.env.example chore: update documentation 2022-10-12 09:14:13 +02:00
.gitignore chore: Fixed some missing dependencies in package.json 2022-10-12 16:03:50 -04:00
CHANGELOG.md chore: change changelog generator to conventionalcommits 2022-10-18 09:12:11 +02:00
CONTRIBUTING.md docs: add contribution guide 2022-10-16 22:54:39 +02:00
docker-compose.yml feat: put db and uploads in same folder 2022-10-12 00:38:38 +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: change changelog generator to conventionalcommits 2022-10-18 09:12:11 +02:00
README.md docs: minor improvements to feature section 2022-10-16 23:04:35 +02: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
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

Just update the docker container by running docker compose pull && docker compose up -d

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.