README

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.

- Quick Setup
- Full Setup
- Screenshots

 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.

1. Your home router will have a Port Forwarding section somewhere. Log in and find it
2. Add port forwarding for ports 80 and 443 to the server hosting this project
3. Configure your domain name details to point to your home, either with a static ip or a service like
   - DuckDNS
   - Amazon Route53
   - Cloudflare
4. Use the Nginx Proxy Manager as your gateway to forward to your other web-based services

 Quick Setup

1. Install Docker
2. Create a docker-compose.yml file similar to this:

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

3. Bring up your stack by running

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

http://127.0.0.1:81


 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.


 Getting Support

1. Found a bug?
2. Discussions
3. Reddit

Top issues

Discussions

Latest release

[!WARNING]
 Certbot has been updated. Exercise caution with this upgrade as your DNS plugins may not work as expected and require tweaks to dependencies.  See the Certbot Doc for more info.


 New Features

- Add a Logs viewer to the UI (thanks @carlosalbertorg)
- Per-path access lists in Proxy Host modal (thanks @drakhaw)


 Changes

- Add reuseport to improve performance and reduce packet drops (thanks @7heMech)
- Update s6 overlay to support podman socket activation (thanks @fo5for)
- Changed order of escape to prevent RCE (thanks @Yasha-ops)
- Fix missing new on PermissionEr