bb0f4bfa62
* Fix wrapping when too many hosts are shown (#207) * Update npm packages, fixes CVE-2019-10757 * Revert some breaking packages * Major overhaul - Docker buildx support in CI - Cypress API Testing in CI - Restructured folder layout (insert clean face meme) - Added Swagger documentation and validate API against that (to be completed) - Use common base image for all supported archs, which includes updated nginx with ipv6 support - Updated certbot and changes required for it - Large amount of Hosts names will wrap in UI - Updated packages for frontend - Version bump 2.1.0 * Updated documentation * Fix JWT expire time going crazy. Now set to 1day * Backend JS formatting rules * Remove v1 importer, I doubt anyone is using v1 anymore * Added backend formatting rules and enforce them in Jenkins builds * Fix CI, doesn't need a tty * Thanks bcrypt. Why can't you just be normal. * Cleanup after syntax check Co-authored-by: Marcelo Castagna <margaale@users.noreply.github.com>
102 lines
7.0 KiB
Markdown
102 lines
7.0 KiB
Markdown
|
|
|
|
# Nginx Proxy Manager
|
|
|
|
|
|
|
|
|
|
|
|
[](https://ci.nginxproxymanager.jc21.com/job/nginx-proxy-manager/job/master/)
|
|
|
|
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.
|
|
|
|
<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>
|
|
|
|
|
|
## Features
|
|
|
|
- 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
|
|
- Advanced Nginx configuration available for super users
|
|
- User management, permissions and audit log
|
|
|
|
|
|
## Screenshots
|
|
|
|
[](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)
|
|
|
|
|
|
## Getting started
|
|
|
|
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`
|
|
|
|
|
|
## Administration
|
|
|
|
When your docker container is running, connect to it on port `81` for the admin interface.
|
|
|
|
[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.
|
|
|
|
|
|
### Default Administrator User
|
|
|
|
```
|
|
Email: admin@example.com
|
|
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 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
|
|
|
|
|
|
## 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)
|