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

Add bullets

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

16
README.md
View File

@@ -31,17 +31,17 @@ 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
Example: Example: