fosrl/docs
1
0
Fork 0
mirror of https://github.com/fosrl/docs.git synced 2025-05-12 21:30:43 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add tips and bullets

Browse source
This commit is contained in:
Owen Schwartz 2025-01-03 21:52:46 -05:00
parent 88a9e9bebc
commit 55041d3260
No known key found for this signature in database
GPG key ID: 8271FDFFD9E0CCBD
2 changed files with 23 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
packages/docusaurus/docs/05-Gerbil/overview.md
View file

@ -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

10
packages/docusaurus/docs/06-Newt/overview.md
View file

@ -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: