This commit is contained in:
Milo Schwartz 2025-01-06 22:27:23 -05:00
commit 72aa6cb763
No known key found for this signature in database
4 changed files with 27 additions and 6 deletions

View file

@ -52,9 +52,22 @@ Example:
--reportBandwidthTo=http://pangolin:3001/api/v1/gerbil/receive-bandwidth --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 :::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.
::: :::

View file

@ -53,6 +53,12 @@ services:
- --endpoint https://example.com - --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 ## Build
### Container ### Container

View file

@ -69,6 +69,10 @@ services:
- --endpoint https://example.com - --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 :::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: 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 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! We intent to crate more extensive documentation on this in the future. If you would like to contribute, please do!

View file

@ -80,7 +80,7 @@ npm run db:push
npm run dev 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. 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 --reachableAt=http://localhost:3003
``` ```
:::
## Gerbil ## Gerbil
- Go v1.23.1 - Go v1.23.1