Rename WireGuard and add images

This commit is contained in:
Owen Schwartz 2025-01-03 21:57:49 -05:00
parent 55041d3260
commit b0c3fdbbbd
No known key found for this signature in database
GPG key ID: 8271FDFFD9E0CCBD
4 changed files with 13 additions and 13 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

View file

@ -1,24 +1,24 @@
# Overview # Overview
Gerbil is a simple WireGuard interface management server written in Go. Gerbil makes it easy to create Wireguard interfaces as well as add and remove peers with an HTTP. Gerbil is a simple WireGuard interface management server written in Go. Gerbil makes it easy to create WireGuard interfaces as well as add and remove peers with an HTTP.
Gerbil can be used stand alone with your own API, a static JSON file, or with Pangolin and Newt as part of the larger system. See documentation below: Gerbil can be used stand alone with your own API, a static JSON file, or with Pangolin and Newt as part of the larger system. See documentation below:
## Preview ## Preview
<img src="public/screenshots/preview.png" alt="Preview"/> <img src={require("./img/preview.png").default} alt="Preview"/>
_Sample output of a Gerbil container connected to Pangolin and terminating various peers._ _Sample output of a Gerbil container connected to Pangolin and terminating various peers._
## Key Functions ## Key Functions
### Setup Wireguard ### Setup WireGuard
A Wireguard interface will be created and configured on the local Linux machine or in the Docker container according to the values given in either a JSON config file or via the remote server. If the interface already exists it will be reconfigured. A WireGuard interface will be created and configured on the local Linux machine or in the Docker container according to the values given in either a JSON config file or via the remote server. If the interface already exists it will be reconfigured.
### Manage Peers ### Manage Peers
Gerbil will create the peers defined in the config on the Wireguard interface. The HTTP API can be used to remove, create, and update peers on the interface dynamically. Gerbil will create the peers defined in the config on the WireGuard interface. The HTTP API can be used to remove, create, and update peers on the interface dynamically.
### Report Bandwidth ### Report Bandwidth
@ -27,18 +27,18 @@ Bytes transmitted in and out of each peer is collected every 10 seconds and incr
## CLI Args ## CLI Args
- `reachableAt`: How should the remote server reach Gerbil's API? - `reachableAt`: How should the remote server reach Gerbil's API?
- `generateAndSaveKeyTo`: Where to save the generated Wireguard private key to persist across restarts. - `generateAndSaveKeyTo`: Where to save the generated WireGuard private key to persist across restarts.
- `remoteConfig` (optional): Remote config location to HTTP get the JSON based config from. See `example_config.json` - `remoteConfig` (optional): Remote config location to HTTP get the JSON based config from. See `example_config.json`
- `config` (optional): Local JSON file path to load config. Used if remote config is not supplied. See `example_config.json` - `config` (optional): Local JSON file path to load config. Used if remote config is not supplied. See `example_config.json`
:::tip :::tip
You must use either `config` or `remoteConfig` to configure Wireguard. You must use either `config` or `remoteConfig` to configure WireGuard.
::: :::
- `reportBandwidthTo` (optional): Remote HTTP endpoint to send peer bandwidth data - `reportBandwidthTo` (optional): Remote HTTP endpoint to send peer bandwidth data
- `interface` (optional): Name of the Wireguard interface created by Gerbil. Default: `wg0` - `interface` (optional): Name of the WireGuard interface created by Gerbil. Default: `wg0`
- `listen` (optional): Port to listen on for HTTP server. Default: `3003` - `listen` (optional): Port to listen on for HTTP server. Default: `3003`
- `log-level` (optional): The log level to use. Default: INFO - `log-level` (optional): The log level to use. Default: INFO

Binary file not shown.

After

Width:  |  Height:  |  Size: 774 KiB

View file

@ -1,12 +1,12 @@
# Overview # Overview
Newt is a fully user space [WireGuard](https://www.wireguard.com/) tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. By using Newt, you don't need to manage complex Wireguard tunnels and NATing to expose your resources. Newt is a fully user space [WireGuard](https://www.wireguard.com/) tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. By using Newt, you don't need to manage complex WireGuard tunnels and NATing to expose your resources.
Newt is used with Pangolin and Gerbil as part of the larger system. See documentation below: Newt is used with Pangolin and Gerbil as part of the larger system. See documentation below:
## Preview ## Preview
<img src="public/screenshots/preview.png" alt="Preview"/> <img src={require("./img/preview.png").default} alt="Preview"/>
_Sample output of a Newt container connected to Pangolin and hosting various resource target proxies._ _Sample output of a Newt container connected to Pangolin and hosting various resource target proxies._
@ -16,13 +16,13 @@ _Sample output of a Newt container connected to Pangolin and hosting various res
Using the Newt ID and a secret the client will make HTTP requests to Pangolin to receive a session token. Using that token it will connect to a websocket and maintain that connection. Control messages will be sent over the websocket. Using the Newt ID and a secret the client will make HTTP requests to Pangolin to receive a session token. Using that token it will connect to a websocket and maintain that connection. Control messages will be sent over the websocket.
### Receives Wireguard Control Messages ### Receives WireGuard Control Messages
When Newt receives Wireguard control messages, it will use the information encoded (endpoint, public key) to bring up a Wireguard tunnel using [netstack](https://github.com/WireGuard/wireguard-go/blob/master/tun/netstack/examples/http_server.go) fully in user space. It will ping over the tunnel to ensure the peer on the Gerbil side is brought up. When Newt receives WireGuard control messages, it will use the information encoded (endpoint, public key) to bring up a WireGuard tunnel using [netstack](https://github.com/WireGuard/wireguard-go/blob/master/tun/netstack/examples/http_server.go) fully in user space. It will ping over the tunnel to ensure the peer on the Gerbil side is brought up.
### Receives Proxy Control Messages ### Receives Proxy Control Messages
When Newt receives Wireguard control messages, it will use the information encoded to crate local low level TCP and UDP proxies attached to the virtual tunnel in order to relay traffic to programmed targets. When Newt receives WireGuard control messages, it will use the information encoded to crate local low level TCP and UDP proxies attached to the virtual tunnel in order to relay traffic to programmed targets.
## CLI Args ## CLI Args