-
Notifications
You must be signed in to change notification settings - Fork 399
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: WebCheck #1742
App Submission: WebCheck #1742
Conversation
App Submission: LinkStack - Self-hosted open-source Linktree alternative
The WebCheck app offers powerful website checks with a modern, user-friendly UI. Loading times, server responses and errors are displayed quickly and clearly. In my opinion this is perfect for integration in Umbrel. 😎 I tested everything so far in my Community Store: |
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.
Excellent submission @dennysubke! We'll do a once-over on the gallery assets before going live.
In the meantime, can you please take a look at these small changes:
webcheck/docker-compose.yml
Outdated
@@ -0,0 +1,13 @@ | |||
version: '3.9' |
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.
Let's change this to version 3.7 to ensure compatibility with past OS versions. It should be fine as-is, but I'd like to err on the side of caution.
FYI, this will change in our upcoming apps refactor, but for now let's always use 3.7/
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.
Understood! :) I will take this into account in the future.
webcheck/docker-compose.yml
Outdated
environment: | ||
APP_HOST: webcheck_server_1 | ||
APP_PORT: 3000 | ||
PROXY_AUTH_ADD: "false" |
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.
Shall we remove PROXY_AUTH_ADD: "false"
entirely so that this app gets umbrel's transparent auth proxy?
That way the WebCheck UI inherits the security properties of our umbrel auth:
-
By default, we only let requests through the proxy if the user already has a valid auth cookie from the Umbrel homescreen. So since the WebCheck dashboard has no auth of its own, it will still be protected by ours. This gives a good UX because there's zero friction for Umbrel users... they can just access the dashboard without re-entering any credentials if they are already logged in to their Umbrel.
-
It also has the benefit of inheriting other security properties of Umbrel auth, such as 2FA if they have it enabled on their Umbrel. They would then get 2FA security for all apps behind the auth proxy too.
What do you think?
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.
Yes, removing PROXY_AUTH_ADD: "false"
is a good idea if we want the WebCheck UI to inherit Umbrel’s transparent authentication proxy.
gallery: | ||
- 1.jpg | ||
- 2.jpg | ||
- 3.jpg |
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.
Since you have 4 lovely gallery images, you can add a 4.jpg here
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.
Thanks for the tip! :)
@nmfretz Short message: All changes have been made. Thank you for your valuable help, and let me know if there's anything else you'd like to comment on. 👍 |
Perfect, thanks for those final changes @dennysubke! Tested and going live. |
|
Severity | File | Description |
---|---|---|
ℹ️ | webcheck/docker-compose.yml |
Potentially using unsafe user in service "server": The default container user "root" can lead to security vulnerabilities. If you are using the root user, please try to specify a different user (e.g. "1000:1000") in the compose file or try to set the UID/PUID and GID/PGID environment variables to 1000. |
webcheck/umbrel-app.yml |
"icon" and "gallery" needs to be empty for new app submissions: The "icon" and "gallery" fields must be empty for new app submissions as it is being created by the Umbrel team. |
Legend
Symbol | Description |
---|---|
❌ | Error: This must be resolved before this PR can be merged. |
Warning: This is highly encouraged to be resolved, but is not strictly mandatory. | |
ℹ️ | Info: This is just for your information. |
App Submission
WebCheck
...
Icon
...
Gallery images
...
I have tested my app on: