3pp-mirror/neko
1
0
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2025-05-31 01:47:24 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs - fix typos

Browse source
This commit is contained in:
Bad 2023-03-02 20:35:51 +02:00 • committed by Miroslav Šedivý
parent d2ddae8f45
commit addb6b6d1b
5 changed files with 17 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/getting-started/troubleshooting.md
View file

@ -1,6 +1,6 @@
# Troubleshooting
Neko UI loads but you don't see the screen and it gives you `connection timeout` or `disconnected` error?
Neko UI loads, but you don't see the screen, and it gives you `connection timeout` or `disconnected` error?
## Test your client
@ -42,7 +42,7 @@ services:
Ensure, that your ports are reachable through your external IP.
To validate UDP connection the simpliest way, run this on your server:
To validate UDP connection the simplest way, run this on your server:
```shell
nc -ul 52101
@ -61,7 +61,7 @@ If it does not work for you, then most likely your port forwarding is not workin
### Check if your external IP was determined correctly
One of the first logs, when the server starts, writes down your external IP that will be sent to your clients to conenct to.
One of the first logs, when the server starts, writes down your external IP that will be sent to your clients to connect to.
```shell
docker-compose logs neko | grep nat_ips
@ -73,7 +73,7 @@ You should see this:
11:11AM INF webrtc starting ephemeral_port_range=52000-52100 ice_lite=true ice_servers="[{URLs:[stun:stun.l.google.com:19302] Username: Credential:<nil> CredentialType:password}]" module=webrtc nat_ips=<your-IP>
```
If your IP is not correct, you can specify own IP resover using `NEKO_IPFETCH`. It needs to return IP address that will be used.
If your IP is not correct, you can specify own IP resolver using `NEKO_IPFETCH`. It needs to return IP address that will be used.
```diff
version: "3.4"
@ -119,13 +119,13 @@ If you want to use n.eko only locally, you must put here your local IP address,
### Neko works externally, but not locally
You are probabbly missing NAT Loopback (NAT Hairpinning) setting on your router.
You are probably missing NAT Loopback (NAT Hairpinning) setting on your router.
Example for pfsense with truecharts docker container:
- First, port forward the relevant ports 8080 and 52000-52100/udp for the container.
- Then turn on `Pure NAT` pfsense (under system > advanced > firewall and nat).
- Make sure to check the two boxes so it works.
- Make sure `NEKO_NAT1TO1` is blank and `NEKO_IPFETCH` address is working correclty (if unset default value is chosen).
- Make sure `NEKO_NAT1TO1` is blank and `NEKO_IPFETCH` address is working correctly (if unset default value is chosen).
- Test externally to confirm it works.
- Internally you have to access it using `<your-public-ip>:port`
@ -201,7 +201,7 @@ Check if your TCP port is exposed correctly and your reverse proxy is correctly
Getting black screen with a cursor, but no browser.
```
Most likely you forgot to add `-cap-add=SYS_ADMIN` when using chromium-based brwosers.
Most likely you forgot to add `-cap-add=SYS_ADMIN` when using chromium-based browsers.
### Unrelated server errors