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

Merged
merged 18 commits into from
Oct 3, 2024
Merged
Empty file.
Empty file.
29 changes: 29 additions & 0 deletions nginx-proxy-manager/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
version: "3.7"

Check notice on line 1 in nginx-proxy-manager/docker-compose.yml

View workflow job for this annotation

GitHub Actions / Lint apps

Potentially using unsafe user in service "docker-host"

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.

services:
app_proxy:
environment:
APP_HOST: nginx-proxy-manager_web_1
APP_PORT: 81

web:
image: jc21/nginx-proxy-manager:2.11.3@sha256:5bd2aae54ac0b6f4ef6777143ab736baf5366807894a4c7fca7bfa2fbaf1489c
hostname: nginx-proxy-manager_web_1
restart: on-failure
ports:

Check notice on line 13 in nginx-proxy-manager/docker-compose.yml

View workflow job for this annotation

GitHub Actions / Lint apps

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.).

Check notice on line 13 in nginx-proxy-manager/docker-compose.yml

View workflow job for this annotation

GitHub Actions / Lint apps

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.).
- 40080:80
- 40443:443
volumes:
- ${APP_DATA_DIR}/data/npm-data:/data
- ${APP_DATA_DIR}/data/letsencrypt:/etc/letsencrypt
environment:
PUID: 1000
PGID: 1000
sahilph marked this conversation as resolved.
Show resolved Hide resolved

docker-host:
image: qoomon/docker-host:3.3.1@sha256:ec9d214d7fa88932e9186ca2f4419d44661376929931248525b08e7fa9e270f7
hostname: $DEVICE_DOMAIN_NAME
cap_add:
- NET_ADMIN
- NET_RAW
restart: on-failure
42 changes: 42 additions & 0 deletions nginx-proxy-manager/umbrel-app.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
manifestVersion: 1
id: nginx-proxy-manager
name: Nginx Proxy Manager
tagline: Expose your services easily and securely
category: networking
version: "2.11.3"
port: 4498
description: >-
Expose your apps to the internet easily and securely.


⚠️ Be cautious when exposing apps to the public internet. Ensure they have proper security, such as login protection, and avoid exposing sensitive apps without adequate safeguards.


🔧 Nginx Proxy Manager uses port 40080 for HTTP (unsecured) traffic and port 40443 for HTTPS (secured) traffic.
To make your apps accessible from the public internet, you will need to set up port forwarding on your router.
Forward external port 80 (HTTP) to internal port 40080 and external port 443 (HTTPS) to internal port 40443.


🔍 Features:

- Beautiful and Secure Admin Interface based on Tabler
- Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx
- Free SSL using Let's Encrypt or provide your own custom SSL certificates
- Access Lists and basic HTTP Authentication for your hosts
- Advanced Nginx configuration available for super users
- User management, permissions and audit log
developer: Jamie Curnow
website: https://nginxproxymanager.com/
submitter: Sahil Phule
submission: https://github.com/getumbrel/umbrel-apps/pull/1296
repo: https://github.com/NginxProxyManager/nginx-proxy-manager
support: https://github.com/NginxProxyManager/nginx-proxy-manager/issues
gallery:

Check warning on line 34 in nginx-proxy-manager/umbrel-app.yml

View workflow job for this annotation

GitHub Actions / Lint apps

"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.
- 1.jpg
- 2.jpg
- 3.jpg
releaseNotes: ""
dependencies: []
path: ""
defaultUsername: "admin@example.com"
defaultPassword: "changeme"