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)

Searching Database…

34.4K ·GitHub
Nginx-proxy-manager
Что это такое?Nginx Proxy Manager — это готовый Docker-контейнер, который даёт веб-интерфейс администратора для управления хостами обратного прокси Nginx, включая бесплатные SSL-сертификаты, без необходимости знать конфигурацию Nginx.
Это генератор конфигурационных файлов или он работает как живой сервер?Он работает как запущенный Docker-контейнер со своим веб-интерфейсом администратора (построенным на Tabler), который стоит перед вашими другими сервисами и в реальном времени проксирует к ним трафик.
Как его запустить?Установите Docker, создайте docker-compose.yml с минимальной конфигурацией, выполните docker compose up, а затем подключитесь к админ-панели на порту 81 и войдите в систему.
Нужно ли открывать какие-либо порты на роутере, чтобы пользоваться этим дома?Для самостоятельного хостинга из дома нужно пробросить порты 80 и 443 на роутере на сервер, где запущен контейнер, и направить доменное имя на ваш домашний IP-адрес (с использованием статического IP-адреса или сервиса динамического DNS).
Есть ли подводные камни с поддержкой оборудования или при первом запуске?Поддержка armv7 была прекращена начиная с версии 2.14+, потому что Node.js прекратил поддержку armhf (вместо этого используйте тег образа 2.13.7), а админ-панели при первом запуске может потребоваться некоторое время, чтобы подняться, из-за сбора энтропии для генерации ключей.
Для кого это создано?Это ориентировано на тех, кто сам хостит свои сервисы, и на любителей домашних серверов, которые хотят безопасно открыть свои домашние сервисы в интернет, не углубляясь в Nginx и Let's Encrypt.
Поддерживает ли он SSL автоматически?Да, он может автоматически выпускать бесплатные SSL-сертификаты через Let's Encrypt, либо вы можете загрузить собственные SSL-сертификаты.
Можно ли ограничить доступ к проксируемым хостам?Да, поддерживаются Access Lists и базовая HTTP-аутентификация, чтобы ограничить, кто может обращаться к вашим сервисам.
Могут ли управлять прокси несколько человек?Да, есть управление пользователями с правами доступа и журнал аудита, а также расширенные параметры конфигурации Nginx для продвинутых пользователей.
Почему автор создал это вместо того, чтобы редактировать конфигурационные файлы Nginx напрямую?Автор хотел создать интерфейс, достаточно простой, чтобы любой мог настроить обратное проксирование с терминацией SSL без предварительных знаний Nginx или Letsencrypt.
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