Bez popisu

jc21 42a5bb6af3 Merge pull request #3988 from vggscqq/patch-1 před 1 rokem
.github 8646cb5a19 Allow stale action to run manually před 1 rokem
backend e0352ecc48 Merge pull request #4016 from NginxProxyManager/dependabot/npm_and_yarn/backend/body-parser-1.20.3 před 1 rokem
docker dfe2588523 Refactor API Schema and validation před 1 rokem
docs 4e035f285d Update deps in docs před 1 rokem
frontend b35aa50b88 Bump tar from 6.1.11 to 6.2.1 in /frontend před 1 rokem
global 42a5bb6af3 Merge pull request #3988 from vggscqq/patch-1 před 1 rokem
scripts a08d18bdb2 Remove broken script před 1 rokem
test c39d5433bc Fix CVE-2024-46256 and CVE-2024-46257 před 1 rokem
.gitignore 6ac9a82279 Major update to cypress před 1 rokem
.version b5a0d74654 Bump version před 1 rokem
Jenkinsfile d21403ca1e Move docker login in pipeline před 1 rokem
LICENSE dc830df253 Initial commit před 8 roky
README.md b5a0d74654 Bump version před 1 rokem

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 for 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

Hosting your home network

I won't go in to 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 port 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 or Amazon Route53
  4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services

Quick Setup

  1. Install Docker and Docker-Compose
  1. 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
    
    # If using docker-compose-plugin
    docker compose up -d
    
    
  2. 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

Default Admin User:

Email:    [email protected]
Password: changeme

Immediately after logging in with this default user you will be asked to modify your details and change your password.

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