diff --git a/packages/docusaurus/docs/05-Gerbil/01-overview.md b/packages/docusaurus/docs/05-Gerbil/01-overview.md index 96381cc..b27f6b6 100644 --- a/packages/docusaurus/docs/05-Gerbil/01-overview.md +++ b/packages/docusaurus/docs/05-Gerbil/01-overview.md @@ -52,9 +52,22 @@ Example: --reportBandwidthTo=http://pangolin:3001/api/v1/gerbil/receive-bandwidth ``` +```yaml +services: + newt: + image: fosrl/gerbil + container_name: gerbil + restart: unless-stopped + command: + - --reachableAt=http://gerbil:3003 + - --generateAndSaveKeyTo=/var/config/key + - --remoteConfig=http://pangolin:3001/api/v1/gerbil/get-config + - --reportBandwidthTo=http://pangolin:3001/api/v1/gerbil/receive-bandwidth +``` + :::tip -CLI args can be passed as "command" fields when using the Docker container. +CLI args can be passed as "command" fields when using the Docker container. Take a look at [this note](../06-Newt/02-install.md#unraid-portainer-and-other-uis) if your commands are not working. ::: diff --git a/packages/docusaurus/docs/06-Newt/01-overview.md b/packages/docusaurus/docs/06-Newt/01-overview.md index 111407a..4f32487 100644 --- a/packages/docusaurus/docs/06-Newt/01-overview.md +++ b/packages/docusaurus/docs/06-Newt/01-overview.md @@ -53,6 +53,12 @@ services: - --endpoint https://example.com ``` +:::note + +CLI args can be passed as "command" fields when using the Docker container. Take a look at [this note](./02-install.md#unraid-portainer-and-other-uis) if your commands are not working. + +::: + ## Build ### Container diff --git a/packages/docusaurus/docs/06-Newt/02-install.md b/packages/docusaurus/docs/06-Newt/02-install.md index 653a02c..de309e4 100644 --- a/packages/docusaurus/docs/06-Newt/02-install.md +++ b/packages/docusaurus/docs/06-Newt/02-install.md @@ -69,6 +69,10 @@ services: - --endpoint https://example.com ``` +#### Unraid, Portainer, and other UIs + +These container management UIs typically allow for passing commands to the container similar to Docker compose. Look for a commands or arguments box and follow relevant guides. + :::note Depending on your docker deployment method (like Portainer or older versions of Docker Compose) be aware that the "command" section may need to be formatted differently. For example: @@ -94,8 +98,4 @@ And you could start it by simply running: docker compose up -d ``` -#### Unraid, Portainer, and other UIs - -These container management UIs typically allow for passing commands to the container similar to Docker compose. Look for a commands or arguments box and follow relevant guides. - We intent to crate more extensive documentation on this in the future. If you would like to contribute, please do! \ No newline at end of file diff --git a/packages/docusaurus/docs/08-development.md b/packages/docusaurus/docs/08-development.md index 733df86..9f19c40 100644 --- a/packages/docusaurus/docs/08-development.md +++ b/packages/docusaurus/docs/08-development.md @@ -80,7 +80,7 @@ npm run db:push npm run dev ``` -Note: +:::note When running Pangolin for the first time there will be no exit nodes. This means that there have been no Gerbil "exit nodes" registered in the database. When Gerbil first starts up and requests its config from Pangolin for the first time it gets registered as an exit node. @@ -94,6 +94,8 @@ The easiest way to resovle this is to run Gerbil and have it register in your de --reachableAt=http://localhost:3003 ``` +::: + ## Gerbil - Go v1.23.1