Skip to content

Commit 0057c79

Browse files
author
Jamie Curnow
committed
Updated Readme
1 parent ea5bdab commit 0057c79

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,22 @@
99
This project comes as a pre-built docker image that enables you to easily forward to your websites
1010
running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
1111

12-
12+
1313
## Project Goal
1414

1515
I created this project to fill a personal need to provide users with a easy way to accomplish reverse
1616
proxying hosts with SSL termination and it had to be so easy that a monkey could do it. This goal hasn't changed.
1717
While there might be advanced options they are optional and the project should be as simple as possible
1818
so that the barrier for entry here is low.
1919

20+
<a href="https://www.buymeacoffee.com/jc21" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-red.png" alt="Buy Me A Coffee" style="height: 51px !important;width: 217px !important;" ></a>
21+
2022

2123
## Features
2224

2325
- Beautiful and Secure Admin Interface based on [Tabler](https://tabler.github.io/)
2426
- Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx
25-
- Free SSL using Let's Encrypt or provide your own custom SSL certificates
27+
- Free SSL using Let's Encrypt or provide your own custom SSL certificates
2628
- Access Lists and basic HTTP Authentication for your hosts
2729
- Advanced Nginx configuration available for super users
2830
- User management, permissions and audit log
@@ -54,7 +56,7 @@ so that the barrier for entry here is low.
5456
## Getting started
5557

5658
Please consult the [installation instructions](doc/INSTALL.md) for a complete guide or
57-
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`
59+
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`
5860

5961

6062
## Administration
@@ -85,3 +87,13 @@ I won't go in to too much detail here but here are the basics for someone new to
8587
3. Configure your domain name details to point to your home, either with a static ip or a service like DuckDNS
8688
4. Use the Nginx Proxy Manager here as your gateway to forward to your other web based services
8789

90+
91+
## Nginx Proxy Manager in the wild
92+
93+
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
94+
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.
95+
96+
Known integrations:
97+
98+
- [HomeAssistant Hass.io plugin](https://github.com/hassio-addons/addon-nginx-proxy-manager)
99+
- [UnRaid / Synology](https://github.com/jlesage/docker-nginx-proxy-manager)

0 commit comments

Comments
 (0)