Skip to content

Commit d1119ec

Browse files
committed
revert change
1 parent 4c90628 commit d1119ec

File tree

1 file changed

+1
-112
lines changed

1 file changed

+1
-112
lines changed

docs/guide/README.md

+1-112
Original file line numberDiff line numberDiff line change
@@ -1,112 +1 @@
1-
# Introducing
2-
<p align="center">
3-
<img src="https://nginxproxymanager.com/github.png">
4-
<br><br>
5-
<img src="https://img.shields.io/badge/version-2.10.4-green.svg?style=for-the-badge">
6-
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
7-
<img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
8-
</a>
9-
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
10-
<img src="https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge">
11-
</a>
12-
</p>
13-
14-
This project comes as a pre-built docker image that enables you to easily forward to your websites
15-
running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
16-
17-
- [Quick Setup](#quick-setup)
18-
- [Full Setup](https://nginxproxymanager.com/setup/)
19-
- [Screenshots](https://nginxproxymanager.com/screenshots/)
20-
21-
## Project Goal
22-
23-
I created this project to fill a personal need to provide users with a easy way to accomplish reverse
24-
proxying hosts with SSL termination and it had to be so easy that a monkey could do it. This goal hasn't changed.
25-
While there might be advanced options they are optional and the project should be as simple as possible
26-
so that the barrier for entry here is low.
27-
28-
<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>
29-
30-
31-
## Features
32-
33-
- Beautiful and Secure Admin Interface based on [Tabler](https://tabler.github.io/)
34-
- Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx
35-
- Free SSL using Let's Encrypt or provide your own custom SSL certificates
36-
- Access Lists and basic HTTP Authentication for your hosts
37-
- Advanced Nginx configuration available for super users
38-
- User management, permissions and audit log
39-
40-
41-
## Hosting your home network
42-
43-
I won't go in to too much detail here but here are the basics for someone new to this self-hosted world.
44-
45-
1. Your home router will have a Port Forwarding section somewhere. Log in and find it
46-
2. Add port forwarding for port 80 and 443 to the server hosting this project
47-
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)
48-
4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services
49-
50-
## Quick Setup
51-
52-
1. Install Docker and Docker-Compose
53-
54-
- [Docker Install documentation](https://docs.docker.com/install/)
55-
- [Docker-Compose Install documentation](https://docs.docker.com/compose/install/)
56-
57-
2. Create a docker-compose.yml file similar to this:
58-
59-
```yml
60-
version: '3.8'
61-
services:
62-
app:
63-
image: 'jc21/nginx-proxy-manager:latest'
64-
restart: unless-stopped
65-
ports:
66-
- '80:80'
67-
- '81:81'
68-
- '443:443'
69-
volumes:
70-
- ./data:/data
71-
- ./letsencrypt:/etc/letsencrypt
72-
```
73-
74-
This is the bare minimum configuration required. See the [documentation](https://nginxproxymanager.com/setup/) for more.
75-
76-
3. Bring up your stack by running
77-
78-
```bash
79-
docker-compose up -d
80-
81-
# If using docker-compose-plugin
82-
docker compose up -d
83-
84-
```
85-
86-
4. Log in to the Admin UI
87-
88-
When your docker container is running, connect to it on port `81` for the admin interface.
89-
Sometimes this can take a little bit because of the entropy of keys.
90-
91-
[http://127.0.0.1:81](http://127.0.0.1:81)
92-
93-
Default Admin User:
94-
```
95-
96-
Password: changeme
97-
```
98-
99-
Immediately after logging in with this default user you will be asked to modify your details and change your password.
100-
101-
102-
## Contributors
103-
104-
Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors).
105-
106-
107-
## Getting Support
108-
109-
1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues)
110-
2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions)
111-
3. [Development Gitter](https://gitter.im/nginx-proxy-manager/community)
112-
4. [Reddit](https://reddit.com/r/nginxproxymanager)
1+
../../README.md

0 commit comments

Comments
 (0)