This project comes as a pre-built docker image that enables you to easily forward to your websites running at home or otherwise, including free TLS, without having to know too much about Nginx or Letsencrypt.

• Quick Setup
• Screenshots

Project Goal

I created this project to fill a personal need to provide users with a easy way to accomplish reverse proxying hosts with TLS termination and it had to be so easy that a monkey could do it. This goal hasn't changed. While there might be advanced options they are optional and the project should be as simple as possible so that the barrier for entry here is low.

Sponsor the original creator (not us):

Features

• Beautiful and Secure Admin Interface based on Tabler
• Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx
• Free trusted TLS certificates using Certbot (Let's Encrypt) or provide your own custom TLS certificates
• Access Lists and basic HTTP Authentication for your hosts
• Advanced Nginx configuration available for super users
• User management, permissions and audit log

New Features

• HTTP/3 (QUIC) Support
• Fix Proxy Hosts, if origin only accepts TLSv1.3
• Only use TLSv1.2 and TLSv1.3
• Uses OCSP Stapling
  • Needs manual migration if you use custom certificates, just upload the CA/Intermediate Certificate (file name: chain.pem) in the /opt/npm/tls/custom/npm-[certificate-id] folder
• fixed dnspod plugin
  • Needs manual migration, please delete all dnspod certs and recreate them OR you manually change the credentialsfile (see here for the template)
• Smaller then the original
• Runs the admin interface on port 81 with https
• Default page runs also with https
• Uses fancyindex if you use the npm directly as webserver
• Expose INTERNAL backend api only to localhost
• Easy security headers, see here
• Access Log disabled
• Error Log written to console
• PHP optinal, you can add php extensions, see aviable packages here and here
• allows different acme servers
• up to 99 domains per cert allowed
• Brotli can be enabled
• HTTP/2 always enabled
• HTTP/2 upload fixed
• Infinite upload size allowed
• Auto database vacuum (only sqlite) (FULLCLEAN=true)
• Auto certbot old certs clean (FULLCLEAN=true)
• Passwort reset (only sqlite) (docker exec -it nginx-proxy-manager password-reset.js USER_EMAIL PASSWORD)
• TLS supported for MariaDB/MySQL, please set the DB_MYSQL_TLS env to true. If you use self signed certificates you can upload them for example to /data/etc/npm/ca.crt and set the DB_MYSQL_CA to /data/etc/npm/ca.crt (not tested)
• PUID/GGID support in network mode host (please add net.ipv4.ip_unprivileged_port_start=0 at the end of /etc/sysctl.conf)
• Option to set IP bindings (multiple instances) in network mode host
• Option to change backend port
• See composefile for all options

Soon

• dark mode
• more

migration

• NOTE: migrating back to the original is not possible, so make first a backup before migration, so you can use the backup to switch back
• if you use custom certificates, you need to upload the CA/Intermediate Certificate (file name: chain.pem) in the /opt/npm/tls/custom/npm-[certificate-id] folder
• some buttons have changed, check if they are still correct
• please delete all dnspod certs and recreate them OR you manually change the credentialsfile (see here for the template)

Use as webserver

1. Create a new Proxy Host
2. Set Scheme to https, Forward Hostname / IP to 0.0.0.0, Forward Port to 1 and enable Websockets Support (you can also use other values, since these get fully ignored)
3. Maybe set an Access List
4. Make your TLS Settings

a) Custom Nginx Configuration (advanced tab), which looks the following for file server:

• Note: the slash at the end of the file path is important

location / {
alias /var/www/<your-html-site-folder-name>/;
}

b) Custom Nginx Configuration (advanced tab), which looks the following for file server and php:

• Note: the slash at the end of the file path is important
• Note: first enable PHP81 and/or PHP82 inside your compose file
• Note: you can replace fastcgi_pass php82; with fastcgi_pass php81/php82 ;
• Note: to add more php extension use the packes from here and add them using the PHP_APKS env (see compose file)

location / {
alias /var/www/<your-php-site-folder-name>/;

location ~ [^/]\.php(/|$) {
fastcgi_pass php82;
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
if (!-f $document_root$fastcgi_script_name) {return 404;}
}}

custom acme server

1. Open this file: nano /opt/npm/ssl/certbot/config.ini
2. uncomment the server line and change it to your acme server
3. maybe set eab keys
4. create your cert using the npm web ui

Quick Setup

1. Install Docker and Docker Compose (or portainer)

• Docker Install documentation
• Docker Compose Install documentation

2. Create a compose.yaml file similar to this (or use it as a portainer stack):

version: "3"
services:
    nginx-proxy-manager:
        container_name: nginx-proxy-manager
        image: zoeyvid/nginx-proxy-manager
        restart: always
        network_mode: host
        volumes:
        - "/opt/npm:/data"
#        - "/var/www:/var/www" # optional, if you want to use it as webserver for html/php
#        - "/opt/npm-letsencrypt:/etc/letsencrypt" # Only needed for first time migration from original nginx-proxy-manager to this fork
        environment:
        - "TZ=Europe/Berlin" # set timezone, default UTC
#        - "PUID=1000" # set group id, default 0 (root)
#        - "PGID=1000" # set user id, default 0 (root)
#        - "NIBEP=48693" # internal port, always bound to 127.0.0.1, default 48693, you need to change it, if you want to run multiple npm instances in network mode host
#        - "NPM_PORT=81" # Port the NPM backend should be bound to, default 81, you need to change it, if you want to run multiple npm instances in network mode host
#        - "IPV4_BINDING=127.0.0.1" # IPv4 address to bind, defaults to all
#        - "NPM_IPV4_BINDING=127.0.0.1" # IPv4 address to bind for the NPM backend, defaults to all
#        - "IPV6_BINDING=[::1]" # IPv6 address to bind, defaults to all
#        - "NPM_IPV6_BINDING=[::1]" # IPv6 address to bind for the NPM backend, defaults to all
#        - "DISABLE_IPV6=true" # disable IPv6, incompatible with IPV6_BINDING, default false
#        - "NPM_DISABLE_IPV6=true" # disable IPv6 for the NPM backend, incompatible with NPM_IPV6_BINDING, default false
#        - "NPM_LISTEN_LOCALHOST=true" # Bind the NPM Dashboard on Port 81 only to localhost, incompatible with NPM_IPV4_BINDING/NPM_IPV6_BINDING/NPM_DISABLE_IPV6, default false
#        - "NPM_CERT_ID=1" # ID of cert, which should be used instead of dummycerts, default unset/dummycerts
#        - "DISABLE_HTTP=true" # disables nginx to listen on port 80, default false
#        - "NGINX_LOG_NOT_FOUND=true" # Allow logging of 404 errors, default false
#        - "CLEAN=false" # Clean folders, default true
#        - "FULLCLEAN=true" # Clean unused config folders, default false
#        - "PHP81=true" # Activate PHP81, default false
#        - "PHP81_APKS=php81-curl php-81-curl" # Add php extensions, see aviable packages here: https://pkgs.alpinelinux.org/packages?branch=v3.17&repo=community&arch=x86_64&name=php81-*, default none
#        - "PHP82=true" # Activate PHP82, default false
#        - "PHP82_APKS=php82-curl php-82-curl" # Add php extensions, see aviable packages here: https://pkgs.alpinelinux.org/packages?branch=v3.17&repo=community&arch=x86_64&name=php82-*, default none

3. Bring up your stack by running (or deploy your portainer stack)

docker compose up -d

4. Log in to the Admin UI

When your docker container is running, connect to it on port 81 for the admin interface. Sometimes this can take a little bit because of the entropy of keys. You may need to open port 81 in your firewall. You may need to use another IP-Address.

https://127.0.0.1:81

Default Admin User:

Email:    admin@example.com
Password: iArhP1j7p1P6TA92FA2FMbbUGYqwcYzxC4AVEe12Wbi94FY9gNN62aKyF1shrvG4NycjjX9KfmDQiwkLZH1ZDR9xMjiG2QmoHXi

Immediately after logging in with this default user you will be asked to modify your details and change your password.

Contributors (original NPM)

Special thanks to all of our contributors.

Please report Bugs first to this fork before reporting them to the original Repository

Getting Support

1. Found a bug?
2. Discussions