From bed7b567400b7abe8fd471312d55643272ded313 Mon Sep 17 00:00:00 2001 From: Owen Schwartz Date: Mon, 6 Jan 2025 22:22:32 -0500 Subject: [PATCH 1/2] Link to command note --- packages/docusaurus/docs/05-Gerbil/01-overview.md | 15 ++++++++++++++- packages/docusaurus/docs/06-Newt/01-overview.md | 6 ++++++ packages/docusaurus/docs/06-Newt/02-install.md | 8 ++++---- 3 files changed, 24 insertions(+), 5 deletions(-) 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 c1592ab..358628d 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 + +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 From 189b4fdfe0750b9d6d657f3c63ce14c7d4a6b380 Mon Sep 17 00:00:00 2001 From: Owen Schwartz Date: Mon, 6 Jan 2025 22:26:07 -0500 Subject: [PATCH 2/2] Add note --- packages/docusaurus/docs/06-Newt/01-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docusaurus/docs/06-Newt/01-overview.md b/packages/docusaurus/docs/06-Newt/01-overview.md index 358628d..1a562d7 100644 --- a/packages/docusaurus/docs/06-Newt/01-overview.md +++ b/packages/docusaurus/docs/06-Newt/01-overview.md @@ -55,7 +55,7 @@ services: :::note -Take a look at [this note](./02-install.md#unraid-portainer-and-other-uis) if your commands are not working. +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. :::