pangolin_mirror/gerbil
1
0
Fork 0
mirror of https://github.com/fosrl/gerbil.git synced 2026-03-07 03:06:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename WireGuard

Browse Source
This commit is contained in:
Owen Schwartz
2025-01-03 21:58:03 -05:00
parent 661aefb507
commit 0b33190380
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -1,6 +1,6 @@
# Gerbil # Gerbil
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.
### Installation and Documentation ### Installation and Documentation
@@ -17,13 +17,13 @@ _Sample output of a Gerbil container connected to Pangolin and terminating vario
## 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
@@ -32,14 +32,14 @@ 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`
Note: You must use either `config` or `remoteConfig` to configure Wireguard. Note: 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