You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!-- WARNING: Any PR without a description will be closed. The title is not enough! -->
2
+
3
+
<!-- ANOTHER WARNING: Don't go creating a duplicate PR! Check that someone hasn't already created something that tackles your fix and if so, help them first -->
4
+
5
+
## Why
6
+
7
+
<!-- Provide a brief description of WHY you are making your changes -->
8
+
9
+
<!-- Consider if you are changing the API, then go in to detail why and/or if
10
+
you change will break API for existing users -->
11
+
12
+
## Type of Change
13
+
14
+
<!-- Mark the relevant options with an "x" -->
15
+
16
+
-[ ] Bug fix (non-breaking change that fixes an issue)
17
+
-[ ] New feature (non-breaking change that adds functionality)
18
+
-[ ] Breaking change (fix or feature that would cause existing functionality to change)
This project comes as a pre-built docker image that enables you to easily forward to your websites
13
+
This project comes as a pre-built Docker image that enables you to easily forward to your websites
14
14
running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
15
15
16
16
-[Quick Setup](#quick-setup)
@@ -20,21 +20,21 @@ running at home or otherwise, including free SSL, without having to know too muc
20
20
## Project Goal
21
21
22
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.
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 to entry here is low.
26
26
27
27
<ahref="https://www.buymeacoffee.com/jc21"target="_blank"><imgsrc="http://public.jc21.com/github/by-me-a-coffee.png"alt="Buy Me A Coffee"style="height: 51px!important;width: 217px!important;" ></a>
28
28
29
29
30
30
## Features
31
31
32
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
33
+
- Easily create forwarding domains, redirections, streams, and 404 hosts without knowing anything about Nginx
34
34
- Free SSL using Let's Encrypt or provide your own custom SSL certificates
35
35
- Access Lists and basic HTTP Authentication for your hosts
36
36
- Advanced Nginx configuration available for super users
37
-
- User management, permissions and audit log
37
+
- User management, permissions, and audit log
38
38
39
39
::: warning
40
40
`armv7` is no longer supported in version 2.14+. This is due to Nodejs dropping support for armhf. Please
@@ -43,15 +43,15 @@ use the `2.13.7` image tag if this applies to you.
43
43
44
44
## Hosting your home network
45
45
46
-
I won't go in to too much detail here but here are the basics for someone new to this self-hosted world.
46
+
I won't go into too much detail here, but here are the basics for someone new to this self-hosted world.
47
47
48
48
1. Your home router will have a Port Forwarding section somewhere. Log in and find it
49
-
2. Add port forwarding for port 80 and 443 to the server hosting this project
49
+
2. Add port forwarding for ports 80 and 443 to the server hosting this project
50
50
3. Configure your domain name details to point to your home, either with a static ip or a service like
0 commit comments