Skip to content

Commit 012d015

Browse files
docs: prerequisites, fixes #1
1 parent 6f68eb4 commit 012d015

4 files changed

Lines changed: 36 additions & 8 deletions

File tree

doc/articles/gotchas.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

doc/articles/intro.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@ It uses the following protocols to create a public IP address
1717
- [RFC 6886 - NAT Port Mapping Protocol](https://tools.ietf.org/html/rfc6886)
1818

1919
> [!WARNING]
20-
> NAT Port Mapping Protocol is not fully implemented. See [issue #3](https://github.com/richardschneider/net-nat/issues/3).
20+
> NAT Port Mapping Protocol is not fully implemented. See [**issue #3**](https://github.com/richardschneider/net-nat/issues/3).
2121
22-
Use the [natcheck](natcheck.md) tool to examine your network environment. See the [gotchas]()
23-
for reasons why things fail.
22+
> [!NOTE]
23+
> Please read the [**Prerequisites**](prerequisite.md) article, before running the software.
24+
25+
## NAT checker
26+
27+
Use the [natcheck](natcheck.md) tool to examine your network environment.

doc/articles/prerequisite.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Prerequisites
2+
3+
The net-nat package requires other network components to be configured.
4+
5+
## Router
6+
7+
Your router must be configured to be a NAT that performs port forwarding to your computer.
8+
As each router has a different administration UI, you will have to read the guide on your
9+
router.
10+
11+
Here's a good article on [port forwarding](https://www.howtogeek.com/66214/how-to-forward-ports-on-your-router/).
12+
13+
## Firewall
14+
15+
If your computer has a firewall (for example Windows Defender), you must also
16+
configure the firewall to open your local port.
17+
18+
Here's a good article on configuring [Windows Defender](https://www.howtogeek.com/394735/how-do-i-open-a-port-on-windows-firewall/).
19+
20+
## HTTP
21+
22+
If you are forwarding HTTP requests, then on Windows, `HTTP.SYS` must be configured to allow incoming requests
23+
on port 80.
24+
25+
```console
26+
> netsh http add urlacl url="http://+:80/" user="Everyone"
27+
```

doc/articles/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
href: usage.md
66
- name: Server Example
77
href: server.md
8+
- name: Prerequisites
9+
href: prerequisite.md
810
- name: NAT Discovery
911
href: discovery.md
1012
- name: Public Address
1113
href: pubaddr.md
1214
- name: NAT Check
1315
href: natcheck.md
14-
- name: Gotchas
15-
href: gotchas.md
1616
- name: Class Reference
1717
href: ../api/Makaretu.Nat.yml
1818

0 commit comments

Comments
 (0)