Update Dev Server docs for Kcp Transport (#2470)

* Mention Custom UDP SG rule for Kcp Transport

Since Kcp Transport is now the default in Mirror, let's update the docs to reflect that the SG needs to have a UDP rule to allow network traffic to reach the server.

* Mention UDP Firewall rule for Kcp Transport

Since Kcp Transport is now the default in Mirror, let's update the docs to reflect that a UDP rule is necessary in order to allow network traffic to reach the server.
This commit is contained in:
Andrew Lott 2020-11-27 20:11:52 -08:00 committed by GitHub
parent 3d5c942d85
commit 4336666420
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions

View File

@ -79,6 +79,7 @@ Create a new security group and you can give it your own name and description. A
- RDP with source "Anywhere", Description can be whatever but put it as Remote Desktop Program.
- Custom TCP Rule with port 7777 and source "Anywhere", Description can be whatever but put it as Mirror.
- If you're using the default Kcp Transport in your Network Manager instead of the Telepathy Transport, create the above rule as a Custom UDP rule instead.
- SSH with source "Anywhere", Description can be whatever but put it as SSH.
SSH is not strictly necessary but can be used to remote connect to it through other means than the RDP.

View File

@ -89,9 +89,8 @@ This will allow other people to connect to your server using its IP and port
- Target tags: `mirror-demo`
- Source filter: IP ranges
- Source IP ranges: 0.0.0.0/0
- Protocols or ports: Select tcp, and then enter port 7777 into the field provided.
> note tcp and port 7777 is default settings for telepathy, if you are using a different transport you will need to find out what settings that uses.
- Protocols or ports: Select TCP, and then enter port 7777 into the field provided.
- If you're using the default Kcp Transport in your Network Manager instead of the Telepathy Transport, then you will need to use UDP instead. If you are using a different transport or have configured it to use a different port then you will need to use those settings.
![Create network rule](./07-create-network-rule.jpg)