Skip to content
This repository was archived by the owner on Oct 20, 2023. It is now read-only.

Commit 7a10d20

Browse files
authored
Update KNOWN_ISSUES.md
1 parent 528fd99 commit 7a10d20

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

docs/KNOWN_ISSUES.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,36 @@
11
## Known issues
22

3-
> My local machine network configuration has changed but extension does not pick up the changes.
3+
- 🚩 [#6 [mac osx] Do you want the application "gh net" to accept incoming network connections? come and go out quickly](https://github.com/github/gh-net/issues/6)
4+
5+
### 🚩 SSH stack trace
6+
7+
8+
### 🚩 I'm getting an `Permissions denied` error an a stack trace immediatelly after starting the extension
9+
10+
- Most likely you forgot to use `sudo` to run the extension. Sudo is required to bind to network sockets on the local machine. If you still seeing the error after running the same command with `sudo`, please create a [Bug report](https://github.com/github/gh-net/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
11+
12+
### 🚩 My local machine network configuration has changed but extension does not pick up the changes
413

514
- Please restart the extension by pressing `q` and connecting to the Codespace again. The extension currently does not watch for changes in network configuration and hence does not detect new network interfaces or changes in interfaces config. This will be fixed in the future.
615

7-
> I'm getting an error an a stack trace immediatelly after starting the extension.
16+
### 🚩 [Alpine Linux] DNS resolution inside an `Alpine Linux`-based Codespace sporadically fails
17+
18+
Apline Linux kernel queries a random known nameserver as oppose to doing queries in sequence as other Linux distros would do. This means that sometimes DNS requests go past extension-defined nameserver so DNS resolution will fail.
19+
20+
Known workarounds:
821

9-
- Most likely you forgot to use `sudo` to run the extension. If `sudo` was used, please create a [Bug report](https://github.com/github/gh-net/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
22+
- add explicit `ip-address hostname` mapping to `/etc/hosts` file inside a Codespace
23+
- modify the `/etc/resolv.conf` file to keep only the VPN Gateway-defined nameserver (one marked with `# Codespaces VPN Gateway` comment)
1024

11-
> Extension suddenly stops working after some time and I see some stack traces in the console.
25+
### 🚩 Extension suddenly stops working after some time and I see some stack traces in the console
1226

1327
Most likely `SSH` connection was dropped or there was an intermittent network issue on your machine. The extension does not currently reconnects to the Codespace automatically. This will be fixed in the future. If this happens too often, please create a [Bug report](https://github.com/github/gh-net/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
1428

15-
> I'm trying to send `Ethernet Datagrams`(L2 network layer) directly and expect those to be forwarded but they are not.
29+
### 🚩 I'm trying to send `Ethernet Datagrams`(L2 network layer) directly and expect those to be forwarded but they are not
1630

1731
The extension currently forwards `IP`(L3 network layer) traffic and above. If the datagrams contain `IP` packets that are addressed to a remote resource addressible from your local machine it should work. If it does not, please create a [Bug report](https://github.com/github/gh-net/issues/new?assignees=&labels=bug&template=bug_report.md&title=). If you want to send `Ethernet Datagrams` directly, please create a [Feature request](https://github.com/github/gh-net/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=), we would love to know about your use case!
1832

19-
> I'm using some transport protocol that does not work.
33+
### 🚩 I'm using some transport protocol that does not work
2034

2135
Currently `TCP`/`UDP` and `ICMP` are supported. Other protocols should work but were not tested extensivelly. Please create [Bug report](https://github.com/github/gh-net/issues/new?assignees=&labels=bug&template=bug_report.md&title=) so we can address the issue.
2236

0 commit comments

Comments
 (0)