-
Notifications
You must be signed in to change notification settings - Fork 396
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
App Submission: Pingvin Share #1229
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you so much @MalteKiefer for your awesome app submission! I have left some suggestions below.
pingvin-share/umbrel-app.yml
Outdated
permissions: | ||
- STORAGE_DOWNLOADS | ||
submitter: maltekiefer | ||
submission: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I myself also forget to add the submission URL all the time :D
submission: | |
submission: https://github.com/getumbrel/umbrel-apps/pull/1229 |
pingvin-share/umbrel-app.yml
Outdated
category: files | ||
name: Pingvin Share | ||
version: "0.27.0" | ||
tagline: Pingvin Share is self-hosted file sharing platform and an alternative for WeTransfer. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Taglines should not end with a .
.
tagline: Pingvin Share is self-hosted file sharing platform and an alternative for WeTransfer. | |
tagline: Pingvin Share is self-hosted file sharing platform and an alternative for WeTransfer |
pingvin-share/docker-compose.yml
Outdated
ports: | ||
- 6453:3000 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You don't need to expose this port when you are using the app_proxy. This way it is more secure :)
ports: | |
- 6453:3000 |
pingvin-share/docker-compose.yml
Outdated
app_proxy: | ||
environment: | ||
APP_HOST: pingvin-share_web_1 | ||
APP_PORT: 6453 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can change this port to the internal port of the container.
Note
This port does not need to match the port in the umbrel-app.yml
! The port there is the external port, this port is the port in this container network
APP_PORT: 6453 | |
APP_PORT: 3000 |
pingvin-share/docker-compose.yml
Outdated
|
||
clamav: | ||
restart: on-failure | ||
image: clamav/clamav |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here we have a very big problem: clamav/clamav
does not run on the arm64
architecture. All apps need to run on arm64 as well as amd64. Maybe you can find a replacement for this? Also please don't forget to add the digest (@sha256...
) for future images :)
pingvin-share/docker-compose.yml
Outdated
- "${APP_DATA_DIR}/data:/opt/app/backend/data" | ||
- "${APP_DATA_DIR}/data/images:/opt/app/frontend/public/img" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Due to privilege issues on older umbrelOS devices, we need to add those directories to the app. Please create the following files:
pingvin-share/data/images/.gitkeep
pingvin-share/data/backend/.gitkeep
The problem is that on older versions of umbrelOS (again backwards compatibility) the permissions of automatically created repositories are wrong. By supplying a .gitkeep file, those directories are getting created by installing the app automatically.
Also maybe it would be better to save the backend data separately to prevent the clashing of files:
- "${APP_DATA_DIR}/data:/opt/app/backend/data" | |
- "${APP_DATA_DIR}/data/images:/opt/app/frontend/public/img" | |
- "${APP_DATA_DIR}/data/backend:/opt/app/backend/data" | |
- "${APP_DATA_DIR}/data/images:/opt/app/frontend/public/img" |
@MalteKiefer friendly ping to see if you are still working on this. The main issue noted by @sharknoon is that the Edit: looks like the clamav container is optional: https://github.com/stonith404/pingvin-share/blob/main/docker-compose.yml Edit 2: @sharknoon came across this multi-arch |
Thinking about this more, it seems like Pingvin Share is really only useful when it is exposed to the internet. The easiest way to do this on umbrelOS right now is to:
This is certainly possible for technical users to do, but I think realistically what will happen is that an average user sees this cool looking file share app, installs it, and then becomes frustrated that it doesn't work out of the box. I propose we convert this to draft and then launch it once umbrelOS has a simple way for users to expose apps to the internet (on the horizon). That way when this hits the official app store, there will be the option for it to work out-of-the-box for users. In the meantime, technical users could still run Pingvin Share on their Umbrel by either:
|
@MalteKiefer
What do you mean by that, @nmfretz ? |
Great to know it's working well on your community app store @dennysubke! On revisiting this, I think we should send this to the app store with a note at the top of the app description saying that Pingvin Share needs to be exposed to the internet for full functionality. We do this for some other apps (e.g., Plausible), so it doesn't make sense to single out Pingvin Share for this. We will get gallery assets prepared and I will finalize this submission.
I can't give away too much at this point, but we have plans to allow users to easily expose apps to the internet. As noted above though, we shouldn't be waiting for this to bring this app to the app store. Thanks for your input @dennysubke! |
App Submission
App name
Pingvin Share
256x256 SVG icon
Sorry, no experience to create a SVG from an PNG
...
Gallery images
I have tested my app on: