MCPcopy
hub / github.com/NginxProxyManager/nginx-proxy-manager

github.com/NginxProxyManager/nginx-proxy-manager @v2.15.1 sqlite

repository ↗ · DeepWiki ↗ · release v2.15.1 ↗
685 symbols 1,644 edges 335 files 1 documented · 0%
README
<img src="https://nginxproxymanager.com/github.png">





<img src="https://img.shields.io/badge/version-2.15.1-green.svg?style=for-the-badge">
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
    <img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
</a>
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
    <img src="https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge">
</a>

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

  • 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
  4. DuckDNS
  5. Amazon Route53
  6. Cloudflare
  7. 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

Extension points exported contracts — how you extend this code

Props (Interface)
(no doc)
frontend/src/components/HasPermission.tsx
Props (Interface)
(no doc)
frontend/src/components/Button.tsx
Props (Interface)
(no doc)
frontend/src/components/LocalePicker.tsx
Props (Interface)
(no doc)
frontend/src/components/NavLink.tsx
Props (Interface)
(no doc)
frontend/src/components/SiteContainer.tsx

Core symbols most depended-on inside this repo

debug
called by 84
backend/logger.js
add
called by 44
frontend/src/modules/AuthStore.ts
showObjectSuccess
called by 23
frontend/src/notifications/helpers.tsx
apiValidator
called by 21
backend/lib/validator/api.js
getValidationSchema
called by 21
backend/schema/index.js
validateString
called by 19
frontend/src/modules/Validations.tsx
validator
called by 17
backend/lib/validator/index.js
castJsonIfNeed
called by 15
backend/lib/helpers.js

Shape

Function 441
Method 113
Interface 101
Class 30

Languages

TypeScript100%

Modules by API surface

frontend/src/api/backend/base.ts16 symbols
backend/lib/config.js15 symbols
frontend/src/api/backend/models.ts14 symbols
backend/models/stream.js13 symbols
backend/models/redirection_host.js13 symbols
backend/models/proxy_host.js13 symbols
backend/models/dead_host.js13 symbols
frontend/src/context/AuthContext.tsx12 symbols
backend/models/auth.js12 symbols
frontend/src/modules/AuthStore.ts11 symbols
backend/models/certificate.js11 symbols
backend/models/user.js10 symbols

Dependencies from manifests, versioned

@apidevtools/json-schema-ref-parser15.3.5 · 1×
@apidevtools/swagger-parser12.1.0 · 1×
@biomejs/biome2.4.15 · 1×
@cypress/grep6.0.0 · 1×
@formatjs/cli6.16.3 · 1×
@jc21/cypress-swagger-validation0.3.2 · 1×
@quobix/vacuum0.26.4 · 1×
@tabler/core1.4.0 · 1×
@tabler/icons-react3.44.0 · 1×
@tanstack/react-query5.100.14 · 1×
@tanstack/react-query-devtools5.100.14 · 1×
@tanstack/react-table8.21.3 · 1×

Datastores touched

(mysql)Database · 1 repos

For agents

$ claude mcp add nginx-proxy-manager \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact