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

Commit 0f46763

Browse files
Merge pull request #1 from legomushroom/tanmayeekamath-patch-1
Update Readme
2 parents 38e6082 + 090a10a commit 0f46763

File tree

2 files changed

+7
-51
lines changed

2 files changed

+7
-51
lines changed

LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

README.md

Lines changed: 7 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
🧪 *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)!*
66

7-
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.
7+
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

9-
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!
9+
For instance, if you are using a `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 within a Codespace, so that you can develop fully inside a Codespace!
1010

1111
[About GitHub CLI](https://cli.github.com/).
1212

@@ -70,11 +70,11 @@ We bind to the `default gateway` network interface inside the codespace and forw
7070

7171
This ensures that we fallback to forwaring packets only if they were not handled by any other network interface inside a Codespace.
7272

73-
Once a packet reaches the local machine, we see if we can forward it to a meaningful distanation, for that we resolve network interface that can handle the packet destination. Such network interface must not be a default gateway interface given that the packet destination is not to the gateway subnet, otherwise the packet is addressed to internet which can be handled from whithin the codespace directly.
73+
Once a packet reaches the local machine, we see if we can forward it to a meaningful destination, for that we resolve network interface that can handle the packet destination. Such network interface must not be a default gateway interface given that the packet destination is not to the gateway subnet, otherwise the packet is addressed to the internet which can be handled from whithin the codespace directly.
7474

75-
If such network interface is found, we create a local `network socket` and a `NAT` record for the connection. The NAT reord is used to map remote packet source address to the local network socket address, so it appears to the remote resource as if traffic is comming from the local machine. When a reply packet is received, we perform reverse address translation and send the packet back to the codespace (so it appears if reply came directly from the Codespace default gateway interface).
75+
If such network interface is found, we create a local `network socket` and a `NAT` record for the connection. The NAT record is used to map the remote packet source address to the local network socket address, so it appears to the remote resource as if traffic is coming from the local machine. When a reply packet is received, we perform reverse address translation and send the packet back to the codespace (so it appears as if the reply came directly from the codespace default gateway interface).
7676

77-
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.
77+
For `DNS` packets, we register an address that is on the `default gateway` subnet which allows to catch all unresolved `DNS` queries. Once `DNS` packet is received, it is passed over to the `local machine` where the request to the local `DNS` resolver is made and a reply is sent back to the codespace.
7878

7979
The extension is written in `Rust` and provides high preformance, low memory footprint and memory safety, hence must cause low latency.
8080

@@ -114,7 +114,7 @@ The extension is written in `Rust` and provides high preformance, low memory foo
114114

115115
### Transport layer protocol support
116116

117-
Currently only `TCP`, `UDP` and `ICMP` protocols were tested extensivelly:
117+
Currently only `TCP`, `UDP` and `ICMP` protocols were tested extensively:
118118

119119
| Transport protocol | Status |
120120
|--------------------|--------|
@@ -128,7 +128,7 @@ Currently only `TCP`, `UDP` and `ICMP` protocols were tested extensivelly:
128128

129129
### Network layer protocol support
130130

131-
Currently only `IPv4` is supported and was tested extensivelly:
131+
Currently only `IPv4` is supported and was tested extensively:
132132

133133
| Network protocol | Status |
134134
|--------------------|--------|
@@ -174,31 +174,8 @@ Currently `TCP`/`UDP` and `ICMP` are supported. Other protocols should work but
174174
- [About GitHub CLI](https://cli.github.com/)
175175
- [GitHub CLI Docs](https://cli.github.com/manual/gh)
176176
- [About GitHub Codespaces](https://github.com/features/codespaces)
177-
178177
- [🔒 Source code](https://github.com/github/codespaces-vpn-gateway)
179178
- [🔒 Codespace Compose GitHub CLI extension](https://github.com/github/gh-codespace-compose)
180179

181-
## License
182-
183-
MIT License
184-
185-
Copyright (c) 2021 GitHub
186-
187-
Permission is hereby granted, free of charge, to any person obtaining a copy
188-
of this software and associated documentation files (the "Software"), to deal
189-
in the Software without restriction, including without limitation the rights
190-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
191-
copies of the Software, and to permit persons to whom the Software is
192-
furnished to do so, subject to the following conditions:
193-
194-
The above copyright notice and this permission notice shall be included in all
195-
copies or substantial portions of the Software.
196180

197-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
198-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
199-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
200-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
201-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
202-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
203-
SOFTWARE.
204181

0 commit comments

Comments
 (0)