Skip to content

Commit 043386f

Browse files
authored
Update README.md
1 parent 334fd4a commit 043386f

File tree

1 file changed

+3
-63
lines changed

1 file changed

+3
-63
lines changed

README.md

+3-63
Original file line numberDiff line numberDiff line change
@@ -3,48 +3,11 @@
33
<br><br>
44
<img src="https://img.shields.io/badge/version-2.12.3-green.svg?style=for-the-badge">
55
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
6-
<img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
7-
</a>
8-
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
9-
<img src="https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge">
10-
</a>
116
</p>
127

13-
This project comes as a pre-built docker image that enables you to easily forward to your websites
14-
running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
15-
16-
- [Quick Setup](#quick-setup)
17-
- [Full Setup](https://nginxproxymanager.com/setup/)
18-
- [Screenshots](https://nginxproxymanager.com/screenshots/)
19-
20-
## Project Goal
21-
22-
I created this project to fill a personal need to provide users with an easy way to accomplish reverse
23-
proxying hosts with SSL termination and it had to be so easy that a monkey could do it. This goal hasn't changed.
24-
While there might be advanced options they are optional and the project should be as simple as possible
25-
so that the barrier for entry here is low.
26-
27-
<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>
28-
29-
30-
## Features
31-
32-
- Beautiful and Secure Admin Interface based on [Tabler](https://tabler.github.io/)
33-
- Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx
34-
- Free SSL using Let's Encrypt or provide your own custom SSL certificates
35-
- Access Lists and basic HTTP Authentication for your hosts
36-
- Advanced Nginx configuration available for super users
37-
- User management, permissions and audit log
38-
39-
40-
## Hosting your home network
41-
42-
I won't go in to too much detail here but here are the basics for someone new to this self-hosted world.
8+
A fork of the official repo of Nginx Proxy Manager.
439

44-
1. Your home router will have a Port Forwarding section somewhere. Log in and find it
45-
2. Add port forwarding for port 80 and 443 to the server hosting this project
46-
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)
47-
4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services
10+
This build has the GeoIP and NTLM Module compiled and configured.
4811

4912
## Quick Setup
5013

@@ -58,7 +21,7 @@ I won't go in to too much detail here but here are the basics for someone new to
5821
```yml
5922
services:
6023
app:
61-
image: 'docker.io/jc21/nginx-proxy-manager:latest'
24+
image: 'docker.io/greetoz/npm-ntml:latest'
6225
restart: unless-stopped
6326
ports:
6427
- '80:80'
@@ -95,26 +58,3 @@ Password: changeme
9558
```
9659

9760
Immediately after logging in with this default user you will be asked to modify your details and change your password.
98-
99-
100-
## Contributing
101-
102-
All are welcome to create pull requests for this project, against the `develop` branch. Official releases are created from the `master` branch.
103-
104-
CI is used in this project. All PR's must pass before being considered. After passing,
105-
docker builds for PR's are available on dockerhub for manual verifications.
106-
107-
Documentation within the `develop` branch is available for preview at
108-
[https://develop.nginxproxymanager.com](https://develop.nginxproxymanager.com)
109-
110-
111-
### Contributors
112-
113-
Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors).
114-
115-
116-
## Getting Support
117-
118-
1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues)
119-
2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions)
120-
3. [Reddit](https://reddit.com/r/nginxproxymanager)

0 commit comments

Comments
 (0)