2017-12-20 18:02:37 -05:00
|
|
|
|
|
|
|
|
|
|
|
|
|
# Nginx Proxy Manager
|
|
|
|
|
|
2018-06-19 18:49:11 -04:00
|
|
|
|
2018-05-08 19:52:43 -04:00
|
|
|
|
|
|
|
|
|
2017-12-20 18:02:37 -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.
|
|
|
|
|
|
2018-08-20 18:33:51 -04:00
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
**WARNING: Version 2 a complete rewrite!** If you are using the `latest` docker tag and update to version 2
|
|
|
|
|
without preparation, horrible things might happen. Refer to the [Migrating Documentation](doc/MIGRATING.md).
|
|
|
|
|
|
|
|
|
|
----------
|
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
|
|
|
|
|
- Free SSL using Let's Encrypt or provide your own custom SSL certificates
|
|
|
|
|
- Access Lists and basic HTTP Authentication for your hosts
|
2018-08-20 18:33:51 -04:00
|
|
|
- -Advanced Nginx configuration available for super users- TODO
|
2018-07-31 23:45:09 -04:00
|
|
|
- User management, permissions and audit log
|
2018-07-31 20:21:49 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[](https://public.jc21.com/nginx-proxy-manager/npm2-1.jpg)
|
|
|
|
|
[](https://public.jc21.com/nginx-proxy-manager/npm2-2.jpg)
|
|
|
|
|
[](https://public.jc21.com/nginx-proxy-manager/npm2-3.jpg)
|
|
|
|
|
[](https://public.jc21.com/nginx-proxy-manager/npm2-4.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
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
2018-07-31 20:21:49 -04:00
|
|
|
## Migrating from Version 1?
|
|
|
|
|
|
|
|
|
|
Here's a [guide for you to migrate your configuration](doc/MIGRATING.md).
|
|
|
|
|
|
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.
|
|
|
|
|
|
2018-07-24 18:40:21 -04:00
|
|
|
|
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
|
|
|
|
|
3. Configure your domain name details to point to your home, either with a static ip or a service like DuckDNS
|
2018-01-04 01:18:48 -05:00
|
|
|
4. Use the Nginx Proxy Manager here as your gateway to forward to your other web based services
|
2018-07-31 01:18:09 -04:00
|
|
|
|
