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

Commit 0b3c6d3

Browse files
authored
Update README.md
1 parent 0f46763 commit 0b3c6d3

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Codespaces Network Bridge
1+
## Codespaces VPN Gateway
22

33
<img width="749" alt="image" src="https://user-images.githubusercontent.com/1478800/161617508-b65de564-60f3-46c8-8394-5b28c8ac477b.png">
44

5-
🧪 *The extension is currently in Preview stage, so some hiccups are expected. Please help us to improve [by submitting feedback](https://github.com/legomushroom/gh-net#troubleshooting)!*
5+
🧪 *The extension is currently in Preview stage, so some hiccups are expected. Please help us to improve [by submitting feedback](https://github.com/github/gh-net#troubleshooting)!*
66

77
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 as a network `gateway` to get to those resources.
88

@@ -13,7 +13,7 @@ For instance, if you are using a `VPN` to connect to your enterprise network to
1313
## Installation
1414

1515
```shell
16-
gh extension install legomushroom/gh-net
16+
gh extension install github/gh-net
1717
```
1818

1919
*This extension depends on the latest features of GitHub CLI, please make sure [to upgrade it](https://github.com/cli/cli#installation).*
@@ -29,7 +29,7 @@ gh extension install legomushroom/gh-net
2929
Picking up new extension version:
3030

3131
```shell
32-
gh extension upgrade legomushroom/gh-net
32+
gh extension upgrade github/gh-net
3333
```
3434

3535
## Usage
@@ -57,6 +57,13 @@ There are two pannels in the connected view of the extension:
5757

5858
Press `q` or `ctrl + c` to stop the extension.
5959

60+
### CLI Options
61+
62+
- `--gui`: Enanble/disable GUI mode. [`true` | `false`] [default: `true`]
63+
- `--trace`: Specify tracing verbosity. [`none` | `trace` | `debug` | `info` | `warn` | `error`] [default: `info`]
64+
65+
Run `gh net start -h` for details.
66+
6067
## How it works
6168

6269
General diagram is shown below:
@@ -86,13 +93,13 @@ The extension is written in `Rust` and provides high preformance, low memory foo
8693
| Mac OSx (Apple) | 🏃 | 🙅 |
8794
| Linux (Ubuntu) |||
8895
| Linux (Debian) |||
89-
| Linux (Fedora) | | |
90-
| Linux (Red Hat) | | |
91-
| Linux (Mint) | | |
92-
| Linux (OpenSUSE) | | |
93-
| Linux (Centos) | | |
94-
| Linux (Kali) | | |
95-
| Linux (Raspberry Pi OS) | | |
96+
| Linux (Fedora) | ? | ? |
97+
| Linux (Red Hat) | ? | ? |
98+
| Linux (Mint) | ? | ? |
99+
| Linux (OpenSUSE) | ? | ? |
100+
| Linux (Centos) | ? | ? |
101+
| Linux (Kali) | ? | ? |
102+
| Linux (Raspberry Pi OS) | ? | ? |
96103
| Windows 10 | 🏃 | 🙅 |
97104

98105
✅ - currently supported 🏃 - support in progress 🙅 - not applicable
@@ -134,16 +141,15 @@ Currently only `IPv4` is supported and was tested extensively:
134141
|--------------------|--------|
135142
| IPv4 ||
136143
| IPv6 | ? |
137-
| ICMPv6 | ? |
138144
| IGMP | ? |
139145
| NDP | ? |
140146
| ECN | ? |
141147
| IPSec | ? |
142148

143149
## Troubleshooting
144150

145-
- Create a [Bug report](https://github.com/legomushroom/gh-net/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
146-
- Create a [Feature request](https://github.com/legomushroom/gh-net/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=).
151+
- Create a [Bug report](https://github.com/github/gh-net/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
152+
- Create a [Feature request](https://github.com/github/gh-net/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=).
147153

148154
Please search for existing issues before creating a new one.
149155

@@ -155,19 +161,19 @@ Please search for existing issues before creating a new one.
155161

156162
> I'm getting an error an a stack trace immediatelly after starting the extension.
157163
158-
- 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=).
164+
- 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=).
159165

160166
> Extension suddenly stops working after some time and I see some stack traces in the console.
161167
162-
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=).
168+
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=).
163169

164170
> I'm trying to send `Ethernet Datagrams`(L2 network layer) directly and expect those to be forwarded but they are not.
165171
166-
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!
172+
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!
167173

168174
> I'm using some transport protocol that does not work.
169175
170-
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.
176+
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.
171177

172178
## Useful links
173179

0 commit comments

Comments
 (0)