nginx-proxy-manager README

The project's README from github.com/NginxProxyManager/nginx-proxy-manager. As one markdown file: README.md.



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.

Buy Me A Coffee

Features

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

  1. Bring up your stack by running
docker compose up -d
  1. 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

nginx-proxy-manager (NginxProxyManager/nginx-proxy-manager)

reverse-proxy
Searching Database…

34.4K ·GitHub
Nginx-proxy-manager
What is this?Nginx Proxy Manager is a pre-built Docker container that gives you a web admin interface to manage Nginx reverse proxy hosts, including free SSL certificates, without needing to know Nginx configuration.
Is this a config file generator or does it run as a live server?It runs as a live Docker container with its own admin web UI (built on Tabler) that sits in front of your other services and proxies traffic to them in real time.
How do I get it running?Install Docker, create a docker-compose.yml with the minimum config, run docker compose up, then connect to the admin UI on port 81 to log in.
Do I need to open any router ports to use this at home?For self-hosting from home you need to forward ports 80 and 443 on your router to the server running the container, and point a domain name at your home IP (using a static IP or a dynamic DNS service).
Any gotchas with hardware support or first startup?armv7 support was dropped from version 2.14+ because Node.js dropped armhf support (use image tag 2.13.7 instead), and the admin UI can take a moment to come up the first time due to key generation entropy.
Who is this built for?It's aimed at self-hosters and homelab users who want to expose their home services to the internet securely without learning Nginx or Let's Encrypt in depth.
Does it support SSL automatically?Yes, it can automatically issue free SSL certificates via Let's Encrypt, or you can upload your own custom SSL certificates.
Can I restrict access to proxied hosts?Yes, it supports Access Lists and basic HTTP Authentication to restrict who can reach your hosted services.
Can multiple people manage the proxy?Yes, it has user management with permissions and an audit log, plus advanced Nginx config options for power users.
Why did the author build this instead of editing Nginx config files directly?The author wanted an interface simple enough for anyone to set up reverse proxying with SSL termination without prior Nginx or Letsencrypt knowledge.
What are similar projects?nginxconfig.io, claude-relay-service, azerioid-stack-manager, nyx, acme.sh, caprover, vodiwalker_panel, x_gift_bot
Which topics is it in?ssl-certificate, ssl, proxy-server, nginx, homelab, self-hosting, admin-dashboard, reverse-proxy, cloudflare, authentication, dashboard, web-app
Creator
NginxProxyManager
Size
23.1 MB
Stars
34.4K
Updated
CommitOct 13Releasev2.16.0Sep 24
Age
8y
Commits · 90 Days