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
{{ message }}
This repository was archived by the owner on Oct 20, 2023. It is now read-only.
🧪 *This extension is currently in Preview stage, so some hiccups are expected. Please help us to improve by submitting feedback!*
2
7
3
8
This [GitHub CLI](https://cli.github.com/) extension allows to bridge network between a Codespace and your local machine, so the `Codespace` can reach out to any remote resource that is reachable from your machine. In another words, it uses your local machine a network `gateway` to get to those resources.
4
9
5
10
For instance, if you are using `VPN` to connect to your enterprise network to access a database or any other remote resources on the private network, this extension allows you to get to those resources from whithin a Codespace also, so you can develop fully inside a Codespace!
To start network forwarding from whithin a Codespace to your local machine, run:
@@ -64,30 +77,28 @@ If such network interface is found, we create a local `network socket` and a `NA
64
77
65
78
For `DNS` packets, we register an address that is on `default gateway` subnet which allows to catch all unresolved `DNS` queries. Once `DNS` packet received, it is passed over to the `local machine` where request to local `DNS` resolver is made and reply sent back to the Codespace.
66
79
67
-
## Troubleshooting
68
-
69
-
Troubleshooting notes.
80
+
The extension is written in `Rust` and provides high preformance, low memory footprint and memory safety, hence must cause low latency.
✅ - currently supported 🏃 - support in progress 🙅 - not applicable
89
100
90
-
### DNS
101
+
### DNS Record Type Support
91
102
92
103
| DNS Record Type | Status |
93
104
|-----------------|--------|
@@ -102,12 +113,93 @@ Troubleshooting notes.
102
113
| MX | ✅ |
103
114
| ANY | ✅ |
104
115
105
-
## Other GitHub CLI extensions for Codespaces
116
+
### Transport layer protocol support
117
+
118
+
Currently only `TCP`, `UDP` and `ICMP` protocols were tested extensivelly:
119
+
120
+
| Transport protocol | Status |
121
+
|--------------------|--------|
122
+
| TCP | ✅ |
123
+
| UDP | ✅ |
124
+
| ICMP | ✅ |
125
+
| SCTP | ? |
126
+
| DCCP | ? |
127
+
| RSVP | ? |
128
+
| QUIC | ? |
129
+
130
+
### Network layer protocol support
131
+
132
+
Currently only `IPv4` is supported and was tested extensivelly:
133
+
134
+
| Network protocol | Status |
135
+
|--------------------|--------|
136
+
| IPv4 | ✅ |
137
+
| IPv6 | ? |
138
+
| ICMPv6 | ? |
139
+
| IGMP | ? |
140
+
| NDP | ? |
141
+
| ECN | ? |
142
+
| IPSec | ? |
143
+
144
+
## Troubleshooting
145
+
146
+
- Create a [Bug report](https://github.com/legomushroom/gh-net/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
147
+
- Create a [Feature request](https://github.com/legomushroom/gh-net/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=).
148
+
149
+
Please search for existing issues before creating a new one.
150
+
151
+
### Known issues
152
+
153
+
> My local machine network configuration has changed but extension does not pick up the changes.
154
+
155
+
- 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.
156
+
157
+
> I'm getting an error an a stack trace immediatelly after starting the extension.
158
+
159
+
- Most likely you forgot to use `sudo` to run the extension. If `sudo` was used, please create a [Bug report](https://github.com/legomushroom/gh-net/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
160
+
161
+
> Extension suddenly stops working after some time and I see some stack traces in the console.
162
+
163
+
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/legomushroom/gh-net/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
164
+
165
+
> I'm trying to send `Ethernet Datagrams`(L2 network layer) directly and expect those to be forwarded but they are not.
166
+
167
+
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/legomushroom/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/legomushroom/gh-net/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=), we would love to know about your use case!
168
+
169
+
> I'm using some transport protocol that does not work.
170
+
171
+
Currently `TCP`/`UDP` and `ICMP` are supported. Other protocols should work but were not tested extensivelly. Please create [Bug report](https://github.com/legomushroom/gh-net/issues/new?assignees=&labels=bug&template=bug_report.md&title=) so we can address the issue.
0 commit comments