2017-12-20 18:02:37 -05:00
# Nginx Proxy Manager
2020-03-05 20:04:42 -05:00
2018-05-08 19:52:43 -04:00
2020-03-09 19:59:34 -04:00
2020-02-18 23:55:06 -05:00
2018-01-04 01:18:48 -05:00
This project comes as a pre-built docker image that enables you to easily forward to your websites
2017-12-20 18:02:37 -05:00
running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
2019-11-28 18:30:34 -05:00
2019-01-03 06:05:00 -05:00
## 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.
2018-08-20 18:33:51 -04:00
2019-11-28 18:46:41 -05:00
< a href = "https://www.buymeacoffee.com/jc21" target = "_blank" > < img src = "http://public.jc21.com/github/by-me-a-coffee.png" alt = "Buy Me A Coffee" style = "height: 51px !important;width: 217px !important;" > < / a >
2019-11-28 18:30:34 -05:00
2018-08-20 18:33:51 -04:00
2017-12-20 18:02:37 -05:00
## Features
2018-07-31 20:21:49 -04:00
- Beautiful and Secure Admin Interface based on [Tabler ](https://tabler.github.io/ )
- Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx
2019-11-28 18:30:34 -05:00
- Free SSL using Let's Encrypt or provide your own custom SSL certificates
2018-07-31 20:21:49 -04:00
- Access Lists and basic HTTP Authentication for your hosts
2018-08-24 02:59:03 -04:00
- Advanced Nginx configuration available for super users
2018-07-31 23:45:09 -04:00
- User management, permissions and audit log
2017-12-20 18:02:37 -05:00
2018-07-31 20:21:49 -04:00
## Screenshots
2018-02-13 00:51:44 -05:00
2018-08-24 08:00:45 -04:00
[](https://public.jc21.com/nginx-proxy-manager/v2/large/login.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/dashboard.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/proxy-hosts.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/proxy-hosts-new1.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/proxy-hosts-new2.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/redirection-hosts.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/redirection-hosts-new1.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/streams.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/streams-new1.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/dead-hosts.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/dead-hosts-new1.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/certificates.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/certificates-new1.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/certificates-new2.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/access-lists.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/access-lists-new1.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/users.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/users-permissions.jpg)
[](https://public.jc21.com/nginx-proxy-manager/v2/large/audit-log.jpg)
2018-02-13 00:51:44 -05:00
2017-12-20 18:02:37 -05:00
## Getting started
2018-07-31 20:04:34 -04:00
Please consult the [installation instructions ](doc/INSTALL.md ) for a complete guide or
2019-11-28 18:30:34 -05:00
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`
2017-12-20 18:02:37 -05:00
## Administration
2018-07-31 20:04:34 -04:00
When your docker container is running, connect to it on port `81` for the admin interface.
2017-12-20 18:02:37 -05:00
[http://localhost:81 ](http://localhost:81 )
Note: Requesting SSL Certificates won't work until this project is accessible from the outside world, as explained below.
2018-07-24 18:40:21 -04:00
### Default Administrator User
```
Email: admin@example.com
Password: changeme
```
2018-07-31 20:04:34 -04:00
Immediately after logging in with this default user you will be asked to modify your details and change your password.
2017-12-20 18:02:37 -05:00
## 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
2020-02-18 23:55:06 -05:00
3. Configure your domain name details to point to your home, either with a static ip or a service like DuckDNS or [Amazon Route53 ](https://github.com/jc21/route53-ddns )
4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services
2017-12-20 18:02:37 -05:00
2019-11-28 18:30:34 -05:00
## 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:
- [HomeAssistant Hass.io plugin ](https://github.com/hassio-addons/addon-nginx-proxy-manager )
- [UnRaid / Synology ](https://github.com/jlesage/docker-nginx-proxy-manager )
