Skip to content

Latest commit

 

History

History
99 lines (65 loc) · 6.74 KB

README.md

File metadata and controls

99 lines (65 loc) · 6.74 KB
Raw

Nginx Proxy Manager

Nginx Proxy Manager

Version Stars Pulls

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

Screenshots

Login Dashboard Proxy Hosts Proxy Host Settings Proxy Host SSL Redirection Hosts Redirection Host Settings Streams Stream Settings 404 Hosts 404 Host Settings Certificates Lets Encrypt Certificates Custom Certificates Access Lists Access List Users Users User Permissions Audit Log

Getting started

Please consult the installation instructions for a complete guide or if you just want to get up and running in the quickest time possible, grab all the files in the doc/example/ folder and run docker-compose up -d

Administration

When your docker container is running, connect to it on port 81 for the admin interface.

http://localhost:81

Note: Requesting SSL Certificates won't work until this project is accessible from the outside world, as explained below.

Default Administrator 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.

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
  4. Use the Nginx Proxy Manager here as your gateway to forward to your other web based services

Nginx Proxy Manager in the wild

As this software gains popularity it's common to see it integrated with other platforms. Please be aware that unless specifically mentioned in the documenation of those integrations, they are not supported by me and any donation links on the pages of those integrations will not come to me even though it looks like it.

Known integrations: