Jamie Curnow
04c1f5ae76
Security - Redact certbot output before it reaches the API: strip the certificate's DNS credential values, URL query strings and userinfo, secret-looking key=value pairs and Bearer/Basic tokens. DNS plugins can echo request URLs carrying API keys. The raw CommandError is no longer attached as `previous`, since the error handler returns `previous` to the client on certificate routes. - Rate limit login/2FA on the admin nginx's real TCP peer, passed as X-NPM-Peer-Addr ($realip_remote_addr), instead of X-Forwarded-For. nginx trusts X-Real-IP from private ranges, so a client on the LAN or Docker network could get a fresh bucket on every request. Behind another proxy, limits now apply per account through that proxy. - Bound rate limiter memory: hash keys over 128 chars and cap each store at 50k entries, removing expired entries first and then the oldest. Correctness - Proxy host modal: send location advanced configs unchanged for non-admins instead of looking them up by path, which dropped the config from a renamed location. - Location advanced config: locations that omit advanced_config now get a config only after explicit ones are matched, so a new location at an old path can't take the config from the renamed location. - Certificate upload: check that the certificate matches the private key (uploaded or stored) before writing, so a mismatched pair can't break nginx -t. - Certificate delete: keep the Let's Encrypt files when revoke fails and hosts still use the certificate, so their configs still load. Cleanup - Make the rate-limit certbot hint first in the list, as its comment says. - Proxy host getCount uses the permissions access has already loaded instead of querying user_permission again. - Rate limiter: register the success refund listener in one place and call it a fixed window, not a sliding one.
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 SSL, without having to know too much about Nginx or Letsencrypt.
Project Goal
I created this project to fill a personal need to provide users with an easy way to accomplish reverse proxying hosts with SSL 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 to entry here is low.
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
::: warning
armv7 is no longer supported in version 2.14+. This is due to Nodejs dropping support for armhf. Please
use the 2.13.7 image tag if this applies to you.
:::
Hosting your home network
I won't go into too much detail here, but here are the basics for someone new to this self-hosted world.
- Your home router will have a Port Forwarding section somewhere. Log in and find it
- Add port forwarding for ports 80 and 443 to the server hosting this project
- Configure your domain name details to point to your home, either with a static ip or a service like
- DuckDNS
- Amazon Route53
- Cloudflare
- Use the Nginx Proxy Manager as your gateway to forward to your other web-based services
Quick Setup
- Install Docker
- Create a docker-compose.yml file similar to this:
services:
app:
image: 'docker.io/jc21/nginx-proxy-manager:latest'
restart: unless-stopped
ports:
- '80:80'
- '81:81'
- '443:443'
volumes:
- ./data:/data
- ./letsencrypt:/etc/letsencrypt
This is the bare minimum configuration required. See the documentation for more.
- Bring up your stack by running
docker compose up -d
- 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.
Contributing
All are welcome to create pull requests for this project, against the develop branch. Official releases are created from the master branch.
CI is used in this project. All PR's must pass before being considered. After passing, docker builds for PR's are available on dockerhub for manual verifications.
Documentation within the develop branch is available for preview at
https://develop.nginxproxymanager.com
Contributors
Special thanks to all of our contributors.