From 55041d32604c1253e417f409c4898497dcd15873 Mon Sep 17 00:00:00 2001 From: Owen Schwartz Date: Fri, 3 Jan 2025 21:52:46 -0500 Subject: [PATCH] Add tips and bullets --- .../docusaurus/docs/05-Gerbil/overview.md | 28 ++++++++++++------- packages/docusaurus/docs/06-Newt/overview.md | 10 +++---- 2 files changed, 23 insertions(+), 15 deletions(-) diff --git a/packages/docusaurus/docs/05-Gerbil/overview.md b/packages/docusaurus/docs/05-Gerbil/overview.md index 38e12c8..6c30721 100644 --- a/packages/docusaurus/docs/05-Gerbil/overview.md +++ b/packages/docusaurus/docs/05-Gerbil/overview.md @@ -26,17 +26,21 @@ Bytes transmitted in and out of each peer is collected every 10 seconds and incr ## CLI Args -`reachableAt`: How should the remote server reach Gerbil's API? -`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` -`config` (optional): Local JSON file path to load config. Used if remote config is not supplied. See `example_config.json` +- `reachableAt`: How should the remote server reach Gerbil's API? +- `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` +- `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. +:::tip -`reportBandwidthTo` (optional): Remote HTTP endpoint to send peer bandwidth data -`interface` (optional): Name of the Wireguard interface created by Gerbil. Default: `wg0` -`listen` (optional): Port to listen on for HTTP server. Default: `3003` -`log-level` (optional): The log level to use. Default: INFO +You must use either `config` or `remoteConfig` to configure Wireguard. + +::: + +- `reportBandwidthTo` (optional): Remote HTTP endpoint to send peer bandwidth data +- `interface` (optional): Name of the Wireguard interface created by Gerbil. Default: `wg0` +- `listen` (optional): Port to listen on for HTTP server. Default: `3003` +- `log-level` (optional): The log level to use. Default: INFO Example: @@ -48,7 +52,11 @@ Example: --reportBandwidthTo=http://pangolin:3001/api/v1/gerbil/receive-bandwidth \ ``` -Note: CLI args can be passed as "command" fields when using the Docker container. +:::tip + +CLI args can be passed as "command" fields when using the Docker container. + +::: ## Build diff --git a/packages/docusaurus/docs/06-Newt/overview.md b/packages/docusaurus/docs/06-Newt/overview.md index 7bec336..f57664d 100644 --- a/packages/docusaurus/docs/06-Newt/overview.md +++ b/packages/docusaurus/docs/06-Newt/overview.md @@ -26,11 +26,11 @@ When Newt receives Wireguard control messages, it will use the information encod ## CLI Args -`endpoint`: The endpoint where both Gerbil and Pangolin reside in order to connect to the websocket. -`id`: Newt ID generated by Pangolin to identify the client. -`secret`: A unique secret (not shared and kept private) used to authenticate the client ID with the websocket in order to receive commands. -`dns`: DNS server to use to resolve the endpoint -`log-level` (optional): The log level to use. Default: INFO +- `endpoint`: The endpoint where both Gerbil and Pangolin reside in order to connect to the websocket. +- `id`: Newt ID generated by Pangolin to identify the client. +- `secret`: A unique secret (not shared and kept private) used to authenticate the client ID with the websocket in order to receive commands. +- `dns`: DNS server to use to resolve the endpoint +- `log-level` (optional): The log level to use. Default: INFO Example: