Skip to content
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: NPM (Nginx Proxy Manager) #1296

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

sahilph
Copy link

@sahilph sahilph commented Aug 5, 2024

App Submission

App name

Nginx Proxy Manager

⚠️ Please take care while exposing apps to the internet.

⚠️ Note: This app listen on ports 40080 and 40443. In order to make the apps proxied by NPM accessible from internet, users need to port forward 80 to 40080 and 443 to 40443 on their router.⚠️

DETAILED GUIDE

256x256 SVG icon

https://nginxproxymanager.com/logo.svg

Gallery images

Image 1:

https://nginxproxymanager.com/screenshots/login.png

Image 2:
https://nginxproxymanager.com/screenshots/dashboard.png

Image 3:
https://nginxproxymanager.com/screenshots/proxy-hosts.png

Image 4:
https://nginxproxymanager.com/screenshots/proxy-hosts-add.png

Note: These screenshots are taken from NPM website.

I have tested my app on:

  • umbrelOS on a Raspberry Pi
  • umbrelOS on an Umbrel Home
  • umbrelOS on Linux VM

I do not have Umbrel Home or Raspberry Pi, hence couldn't test it on them. However I have tested it on my Linux Machine (Umbrel OS 1.2.2) and it works fine.


For those who want to try it now, Nginx Proxy Manager is also available on my personal app store

Copy link
Contributor

@nmfretz nmfretz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really great addition @sahilph, thanks for working on this!

This is almost ready to go, there are just a few items to address below. We'll start working on gallery assets.

nginx-proxy-manager/docker-compose.yml Outdated Show resolved Hide resolved
nginx-proxy-manager/docker-compose.yml Outdated Show resolved Hide resolved
nginx-proxy-manager/docker-compose.yml Show resolved Hide resolved
nginx-proxy-manager/umbrel-app.yml Outdated Show resolved Hide resolved
nginx-proxy-manager/umbrel-app.yml Outdated Show resolved Hide resolved
nginx-proxy-manager/umbrel-app.yml Outdated Show resolved Hide resolved
nginx-proxy-manager/umbrel-app.yml Outdated Show resolved Hide resolved
nginx-proxy-manager/umbrel-app.yml Outdated Show resolved Hide resolved
Copy link

⚠️   Linting finished with 1 warning   ⚠️

Thank you for your submission! This is an automated linter that checks for common issues in pull requests to the Umbrel App Store.

Please review the linting results below and make any necessary changes to your submission.

Linting Results

Severity File Description
ℹ️ nginx-proxy-manager/docker-compose.yml External port mapping "40080:80":
Port mappings may be unnecessary for the app to function correctly. Docker's internal DNS resolves container names to IP addresses within the same network. External access to the web interface is handled by the app_proxy container. Port mappings are only needed if external access is required to a port not proxied by the app_proxy, or if an app needs to expose multiple ports for its functionality (e.g., DHCP, DNS, P2P, etc.).
ℹ️ nginx-proxy-manager/docker-compose.yml External port mapping "40443:443":
Port mappings may be unnecessary for the app to function correctly. Docker's internal DNS resolves container names to IP addresses within the same network. External access to the web interface is handled by the app_proxy container. Port mappings are only needed if external access is required to a port not proxied by the app_proxy, or if an app needs to expose multiple ports for its functionality (e.g., DHCP, DNS, P2P, etc.).
⚠️ nginx-proxy-manager/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.

@sahilph
Copy link
Author

sahilph commented Sep 20, 2024

@nmfretz
I have made the requested changes. Please check.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants